Sparkle 0.0.1
Loading...
Searching...
No Matches
spk::MessageBox Class Reference

Interface window that displays a message with buttons. More...

#include <spk_message_box.hpp>

Inheritance diagram for spk::MessageBox:
Inheritance graph
Collaboration diagram for spk::MessageBox:
Collaboration graph

Public Member Functions

 MessageBox (const std::wstring &p_name, Widget *p_parent)
 Builds a message box widget.
void setMinimalWidth (size_t p_width)
 Sets a minimal width for the message box.
void setGeometry (const Extend2D &p_geometry) override
 Sets geometry and updates size hints.
TextAreatextArea ()
 Returns the text area used for message content.
PushButtonaddButton (const std::wstring &p_name, const std::wstring &p_text)
 Adds a button to the message box.
PushButtonbutton (const std::wstring &p_name)
 Finds a button by name.
void setMessage (const std::wstring &p_message)
 Sets the displayed message text.
Public Member Functions inherited from spk::InterfaceWindow< PromptPanel >
 InterfaceWindow (const std::wstring &p_name, spk::Widget *p_parent)
 Builds an interface window widget.
void setTitle (const std::wstring &p_title)
 Sets the title bar text.
void setTitleBarHeight (size_t p_height)
 Sets the title bar height.
void setMaximizedSize (const spk::Extend2D &p_maximizedGeometry)
 Sets the maximized window geometry.
void maximize ()
 Maximizes the window if not already maximized.
void minimize ()
 Minimizes the window content.
void restore ()
 Restores the window content and geometry.
PromptPanelcontent ()
 Returns the content widget.
Public Member Functions inherited from spk::ScalableWidget
 ScalableWidget (const std::wstring &p_name, Widget *p_parent)
 Builds a scalable widget.
void setGeometry (const spk::Extend2D &p_extend2D) override
 Sets the widget geometry and updates resize handles.
Public Member Functions inherited from spk::Widget
void takeFocus (FocusType p_focusType)
 Grants this widget ownership of the requested focus type.
void releaseFocus (FocusType p_focusType)
 Releases a previously acquired focus type.
bool hasFocus (FocusType p_focusType) const
 Checks if this widget currently owns a focus type.
void takeAllFocus ()
 Acquires both keyboard and mouse focus.
void releaseAllFocus ()
 Releases both keyboard and mouse focus types.
 Widget (const std::wstring &p_name, Widget *p_parent)
 Builds a widget optionally attached to a parent.
void addChild (Widget *p_child) override
 Adds a child widget and sorts the hierarchy by layer.
const float & layer () const
 Current rendering layer of the widget.
void setLayer (const float &p_newLayer)
 Updates the widget layer and propagates relative offsets to children.
const std::wstring & name () const
 Retrieves the widget name.
void setName (const std::wstring &p_name)
 Sets the widget name.
void setGeometry (const spk::Extend2D &p_geometry) override
 Requests a specific viewport and scissor region for the widget.
const spk::Extend2Dgeometry () const
 Returns the current widget geometry.
const spk::OpenGL::ViewRegionviewRegion () const
 Accesses the computed view region.
const spk::OpenGL::FrameBufferObjectframeBufferObject () const
 Returns the frame buffer object used for widget rendering.
const spk::OpenGL::FrameBufferObjectfbo () const
 Alias for frameBufferObject().
void requireGeometryChange ()
 Marks the widget view region as needing recomputation.
Public Member Functions inherited from spk::InherenceObject< Widget >
virtual void removeChild (Widget *p_child)
 Removes a child from this node.
Widgetparent () const
 Returns the parent pointer.
virtual std::vector< Widget * > & children ()
 Returns the children vector.
void clearChildren ()
 Clears the children list and resets each child's parent pointer.
Public Member Functions inherited from spk::ActivableObject
 ActivableObject ()
 Builds a deactivated object.
 ActivableObject (ActivationStatus p_initial)
 Builds with a custom initial activation state.
void activate ()
 Sets the state to Activated.
void deactivate ()
 Sets the state to Deactivated.
void toggle ()
 Toggles between activated and deactivated states.
bool isActive () const
 Checks whether the object is currently activated.
Contract addActivationCallback (const Job &p_callback)
 Registers a callback executed when the object activates.
Contract addDeactivationCallback (const Job &p_callback)
 Registers a callback executed when the object deactivates.
Public Member Functions inherited from spk::StatefulObject< ActivationStatus >
 StatefulObject (const ActivationStatus &p_initialState)
 Builds with an initial state.
StatefulObjectoperator= (const StatefulObject &p_other)=delete
void setState (const ActivationStatus &p_newState)
 Sets a new state and triggers callbacks registered for it.
ActivationStatus state () const
 Returns the current state.
Contract addCallback (const ActivationStatus &p_state, const Job &p_callback)
 Subscribes a callback for a specific state.
Public Member Functions inherited from spk::ResizableElement
SizeHintsizeHint ()
 Returns mutable size hint data.
const SizeHintsizeHint () const
 Returns const size hint data.

Additional Inherited Members

Public Types inherited from spk::Widget
enum class  FocusType { Keyboard = 0 , Mouse = 1 }
 Types of focus a widget can own.
Public Types inherited from spk::ActivableObject
using Contract = StatefulObject<ActivationStatus>::Contract
 Subscription handle controlling callback lifetime.
using Job = StatefulObject<ActivationStatus>::Job
 Callback signature executed on activation state changes.
Public Types inherited from spk::StatefulObject< ActivationStatus >
using Contract
 Handle allowing subscribers to manage callback lifetimes.
using Job
 Callable invoked when the object transitions to a state.
Static Public Member Functions inherited from spk::Widget
static WidgetfocusedWidget (FocusType p_focusType)
 Retrieves the widget currently owning a focus type.
Static Public Attributes inherited from spk::Widget
static const size_t NbFocusType = 2
 Number of focus slots tracked at runtime.
Protected Member Functions inherited from spk::Widget
virtual void _onPaintEvent (spk::PaintEvent &p_event)
 Paint event hook for derived widgets.
virtual void _onKeyPressEvent (spk::KeyPressEvent &p_event)
 Keyboard press handler for derived widgets.
virtual void _onKeyReleaseEvent (spk::KeyReleaseEvent &p_event)
 Keyboard release handler for derived widgets.
virtual void _onGlyphEvent (spk::GlyphEvent &p_event)
 Text glyph input handler for derived widgets.
virtual void _onMousePressEvent (spk::MousePressEvent &p_event)
 Mouse button press handler for derived widgets.
virtual void _onMouseReleaseEvent (spk::MouseReleaseEvent &p_event)
 Mouse button release handler for derived widgets.
virtual void _onMouseDoubleClickEvent (spk::MouseDoubleClickEvent &p_event)
 Mouse double click handler for derived widgets.
virtual void _onMouseMotionEvent (spk::MouseMotionEvent &p_event)
 Mouse motion handler for derived widgets.
virtual void _onMouseWheelEvent (spk::MouseWheelEvent &p_event)
 Mouse wheel handler for derived widgets.
virtual void _onEnterResizeModeEvent (spk::EnterResizeModeEvent &p_event)
 Callback for entering resize mode.
virtual void _onResizeEvent (spk::ResizeEvent &p_event)
 Resize handling hook.
virtual void _onExitResizeModeEvent (spk::ExitResizeModeEvent &p_event)
 Callback invoked when leaving resize mode.
virtual void _onQuitEvent (spk::QuitEvent &p_event)
 Quit event handler hook.
virtual void _onMoveEvent (spk::MoveEvent &p_event)
 Window move handler hook.
virtual void _onFullScreenModeEvent (spk::FullScreenModeEvent &p_event)
 Full screen toggle handler hook.
virtual void _onMaximizedModeEvent (spk::MaximizedModeEvent &p_event)
 Maximized mode change handler.
virtual void _onFocusEvent (spk::FocusEvent &p_event)
 Focus change handler hook.
virtual void _onUpdateEvent (spk::UpdateEvent &p_event)
 Frame update handler hook.

Detailed Description

Interface window that displays a message with buttons.

See also
PromptPanel
spk::MessageBox box(L"Message", parent);
box.setMessage(L"Hello");
Widget * parent() const
Definition spk_inherence_object.hpp:85
Interface window that displays a message with buttons.
Definition spk_message_box.hpp:27

Constructor & Destructor Documentation

◆ MessageBox()

spk::MessageBox::MessageBox ( const std::wstring & p_name,
Widget * p_parent )
explicit

Builds a message box widget.

Parameters
p_nameWidget name.
p_parentParent widget.
Here is the call graph for this function:

Member Function Documentation

◆ addButton()

PushButton & spk::MessageBox::addButton ( const std::wstring & p_name,
const std::wstring & p_text )

Adds a button to the message box.

Parameters
p_nameButton name.
p_textButton text.
Returns
Reference to the created button.
Here is the call graph for this function:

◆ button()

PushButton * spk::MessageBox::button ( const std::wstring & p_name)

Finds a button by name.

Parameters
p_nameButton name.
Returns
Pointer to the button or nullptr.
Here is the call graph for this function:

◆ setGeometry()

void spk::MessageBox::setGeometry ( const Extend2D & p_geometry)
overridevirtual

Sets geometry and updates size hints.

Parameters
p_geometryNew geometry.

Reimplemented from spk::InterfaceWindow< PromptPanel >.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setMessage()

void spk::MessageBox::setMessage ( const std::wstring & p_message)

Sets the displayed message text.

Parameters
p_messageMessage text.
Here is the call graph for this function:

◆ setMinimalWidth()

void spk::MessageBox::setMinimalWidth ( size_t p_width)

Sets a minimal width for the message box.

Parameters
p_widthMinimum width in pixels.
Here is the call graph for this function:

◆ textArea()

TextArea & spk::MessageBox::textArea ( )

Returns the text area used for message content.

Returns
Text area reference.
Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following files: