1.1-rc1
Public Member Functions | Protected Member Functions | List of all members
BoxSizer Class Reference

Positions and sizes widgets by Orientation. More...

Inheritance diagram for BoxSizer:
Inheritance graph
[legend]

Public Member Functions

 BoxSizer (Orientation orient=Orientation::horizontal, Justification justify=Justification::middle)
 
 BoxSizer (Frame &parent, Orientation orient=Orientation::horizontal, Justification justify=Justification::middle)
 
void deserialize (const std::string &name, const std::string &value, const Serializer::Attributes &attrs) override
 Deserialize widget properties. More...
 
EGT_NODISCARD Justification justify () const
 Get the justify. More...
 
void justify (Justification justify)
 Set the justify. More...
 
void layout () override
 
EGT_NODISCARD Orientation orient () const
 Get the Orientation. More...
 
void orient (Orientation orient)
 Set the Orientation. More...
 
void serialize (Serializer &serializer) const override
 Serialize the widget to the specified serializer. More...
 
- Public Member Functions inherited from Frame
 Frame (const Rect &rect={}, const Flags &flags={}) noexcept
 
 Frame (Frame &parent, const Rect &rect, const Flags &flags={}) noexcept
 
 Frame (const Frame &)=delete
 
 Frame (Frame &&) noexcept=default
 
 ~Frame () noexcept override
 
virtual void add (const std::shared_ptr< Widget > &widget)
 Add a child widget. More...
 
template<class T >
void add (const std::shared_ptr< T > &widget)
 Utility wrapper around add() More...
 
void add (Widget &widget)
 Add a child widget. More...
 
void add_damage (const Rect &rect)
 Add damage to the damage array. More...
 
virtual void begin_draw ()
 Cause the frame to draw itself and all of its children. More...
 
EGT_NODISCARD std::shared_ptr< Widgetchild_at (size_t index) const
 Get a child widget at a specific index. More...
 
EGT_NODISCARD size_t count_children () const
 Get the number of children widgets. More...
 
void damage () override
 Damage the rectangle of the entire Frame. More...
 
void damage (const Rect &rect) override
 This will merge the damaged area with any already existing damaged area that it overlaps with into a super rectangle. More...
 
virtual void damage_from_child (const Rect &rect)
 Special variation of damage() that is to be called explicitly by child widgets. More...
 
void draw (Painter &painter, const Rect &rect) override
 Draw the widget. More...
 
template<class T >
std::shared_ptr< T > find_child (const std::string &name)
 Find a child Widget in the entire tree by name. More...
 
Framefind_screen ()
 Starting from this Frame, find the Frame that has a Screen. More...
 
EGT_NODISCARD const Framefind_screen () const
 Starting from this Frame, find the Frame that has a Screen. More...
 
void handle (Event &event) override
 Handle an event. More...
 
virtual EGT_NODISCARD bool has_screen () const
 Does this Frame have a screen? More...
 
Widgethit_test (const DisplayPoint &point)
 Get the widget under the given DisplayPoint. More...
 
bool is_child (Widget *widget) const
 Returns true if the child exists. More...
 
Frameoperator= (const Frame &)=delete
 
Frameoperator= (Frame &&) noexcept=default
 
void paint_children_to_file ()
 Paint individual children to file. More...
 
void paint_to_file (const std::string &filename={}) override
 Save the entire frame surface to a file. More...
 
virtual void remove (Widget *widget)
 Remove a child widget. More...
 
void remove_all ()
 Remove all child widgets. More...
 
void resize (const Size &size) override
 Resize the widget. More...
 
void show () override
 Show the Widget. More...
 
template<typename T , typename... Args>
std::shared_ptr< T > spawn (Args &&... args)
 Create a child widget of the specified type. More...
 
void special_child_draw (Painter &painter, Widget *widget)
 Special draw function that can be invoked when drawing each child. More...
 
EGT_NODISCARD ChildDrawCallback special_child_draw_callback () const
 Get the special child draw callback. More...
 
void special_child_draw_callback (ChildDrawCallback func)
 Set the special child draw callback. More...
 
virtual EGT_NODISCARD Point to_child (const Point &p) const
 Convert a point with an origin of the current frame to child origin. More...
 
EGT_NODISCARD Rect to_child (Rect rect) const
 
virtual Point to_panel (const Point &p)
 Convert a local point to the coordinate system of the current panel. More...
 
EGT_NODISCARD bool top_level () const override
 Return true if this is a top level frame, with no parent. More...
 
void walk (const WalkCallback &callback, int level=0) override
 Walk the Widget tree and call callback with each Widget. More...
 
size_t zorder (const Widget *widget) const
 Get the zorder of the widget. More...
 
void zorder_bottom (const Widget *widget)
 Move the specified widget zorder to the bottom of the current list of widgets with the same parent. More...
 
void zorder_down (const Widget *widget)
 Move the specified widget zorder down relative to other widgets with the same parent. More...
 
void zorder_top (const Widget *widget)
 Move the specified widget zorder to the top of the current list of widgets with the same parent. More...
 
void zorder_up (const Widget *widget)
 Move the specified widget zorder up relative to other widgets with the same parent. More...
 
- Public Member Functions inherited from Widget
 Widget (const Rect &rect={}, const Widget::Flags &flags={}) noexcept
 
 Widget (Frame &parent, const Rect &rect={}, const Widget::Flags &flags={}) noexcept
 
 Widget (const Widget &)=delete
 
 Widget (Widget &&) noexcept=default
 
 ~Widget () noexcept override
 
EGT_NODISCARD bool active () const
 Get the active state. More...
 
void active (bool value)
 Set the active state. More...
 
void align (const AlignFlags &a)
 Align the widget. More...
 
EGT_NODISCARD const AlignFlagsalign () const
 Get the alignment. More...
 
AlignFlagsalign ()
 Get the alignment. More...
 
EGT_NODISCARD float alpha () const
 Get the alpha property. More...
 
void alpha (float alpha)
 Set the alpha property. More...
 
void autoresize (bool value)
 Set the autoresize state. More...
 
EGT_NODISCARD bool autoresize () const
 Return the autoresize state of the widget. More...
 
void border (DefaultDim border)
 Set the border width. More...
 
EGT_NODISCARD DefaultDim border () const
 Get the border width. More...
 
void border_flags (const Theme::BorderFlags &flags)
 Set the border flags. More...
 
EGT_NODISCARD Theme::BorderFlags border_flags () const
 Get the border flags. More...
 
void border_radius (float radius)
 Set the border radius. More...
 
EGT_NODISCARD float border_radius () const
 Get the border radius. More...
 
EGT_NODISCARD const Rectbox () const
 Bounding box for the Widget. More...
 
void box (const Rect &rect)
 Change the bounding box of the widget. More...
 
bool can_handle_event () const
 Returns true if the widget is capable of handling an event. More...
 
EGT_NODISCARD Point center () const
 Get the center point of the widget's box(). More...
 
EGT_NODISCARD bool checked () const
 Get the boolean checked state of the a widget. More...
 
virtual void checked (bool value)
 Set the checked state of the widget. More...
 
EGT_NODISCARD bool clip () const
 Return the clip state of the widget. More...
 
EGT_NODISCARD const Patterncolor (Palette::ColorId id) const
 Get a Widget color. More...
 
EGT_NODISCARD const Patterncolor (Palette::ColorId id, Palette::GroupId group) const
 Get a Widget color. More...
 
void color (Palette::ColorId id, const Pattern &color, Palette::GroupId group=Palette::GroupId::normal)
 Add a color to the widget's instance palette. More...
 
virtual EGT_NODISCARD Rect content_area () const
 Return the area that content is allowed to be positioned into. More...
 
void detach ()
 Detach this widget from its parent. More...
 
void disable ()
 Set the disabled state to true. More...
 
void disable_toggle ()
 Toggle the disabled state. More...
 
EGT_NODISCARD bool disabled () const
 Return the disabled state of the widget. More...
 
void disabled (bool value)
 Set the disabled state. More...
 
DisplayPoint display_origin ()
 Get the display origin of the Widget. More...
 
virtual Point display_to_local (const DisplayPoint &p)
 Convert a display point to a local point. More...
 
void draw_box (Painter &painter, Palette::ColorId bg, Palette::ColorId border) const
 Helper function to draw this widget's box using the appropriate theme. More...
 
void draw_circle (Painter &painter, Palette::ColorId bg, Palette::ColorId border) const
 Helper function to draw this widget's circle using the appropriate theme. More...
 
void enable ()
 Set the disabled state to false. More...
 
void fill_flags (const Theme::FillFlags &flags)
 Set the fill flags. More...
 
EGT_NODISCARD const Theme::FillFlagsfill_flags () const
 Get the fill flags. More...
 
Theme::FillFlagsfill_flags ()
 Get a modifiable fill flags reference. More...
 
EGT_NODISCARD bool focus () const
 Get the current focus state. More...
 
EGT_NODISCARD const Fontfont () const
 Get the widget Font. More...
 
void font (const Font &font)
 Set the widget Font. More...
 
EGT_NODISCARD bool frame () const
 Return the frame state of the widget. More...
 
void grab_mouse (bool value)
 Set the grab_mouse state. More...
 
EGT_NODISCARD bool grab_mouse () const
 Return the grab_mouse state of the widget. More...
 
void height (DefaultDim h)
 Change the height. More...
 
EGT_NODISCARD DefaultDim height () const
 Height of the widget's box(). More...
 
virtual void hide ()
 Hide the Widget. More...
 
void horizontal_ratio (DefaultDim horizontal)
 Set the horizontal ratio relative to parent. More...
 
EGT_NODISCARD DefaultDim horizontal_ratio () const
 Get the horizontal ratio relative to parent. More...
 
EGT_NODISCARD bool in_layout () const
 Indicate if the Widget is computing the layout or not. More...
 
DisplayPoint local_to_display (const Point &p)
 Convert a local point to a display point. More...
 
void margin (DefaultDim margin)
 Set the margin width. More...
 
EGT_NODISCARD DefaultDim margin () const
 Get the margin width. More...
 
virtual EGT_NODISCARD Size min_size_hint () const
 Get a minimum size hint for the Widget. More...
 
void min_size_hint (const Size &size)
 Set the minimum size hint for the Widget. More...
 
EGT_NODISCARD size_t moat () const
 Get the sum of the margin(), padding(), and border() around the content of the widget. More...
 
virtual void move (const Point &point)
 Move the Widget to a new position. More...
 
void move_to_center (const Point &point)
 Move the widget to the specified center point. More...
 
void move_to_center ()
 Move the widget to the center of its parent. More...
 
void no_layout (bool value)
 Set the no_layout state. More...
 
EGT_NODISCARD bool no_layout () const
 Return the no_layout state of the widget. More...
 
Widgetoperator= (const Widget &)=delete
 
Widgetoperator= (Widget &&) noexcept=default
 
void padding (DefaultDim padding)
 Set the padding width. More...
 
EGT_NODISCARD DefaultDim padding () const
 Return the padding width. More...
 
virtual void paint (Painter &painter)
 Paint the Widget using a Painter. More...
 
void palette (const Palette &palette)
 Set the widget instance Palette. More...
 
Frameparent ()
 Get a pointer to the parent Frame, or nullptr if none exists. More...
 
EGT_NODISCARD const Frameparent () const
 Get a pointer to the parent Frame, or nullptr if none exists. More...
 
EGT_NODISCARD bool plane_window () const
 Return the plane_window state of the widget. More...
 
EGT_NODISCARD const Pointpoint () const
 Get the origin of the widget's box(). More...
 
void ratio (DefaultDim ratio)
 Set the size ratio relative to parent. More...
 
void ratio (DefaultDim horizontal, DefaultDim vertical)
 Set the size ratio relative to parent. More...
 
EGT_NODISCARD bool readonly () const
 Get the readonly state of the widget. More...
 
void readonly (bool value)
 Set the readonly state of the widget. More...
 
void readonly_toggle ()
 Toggle the readonly state. More...
 
void reset_palette ()
 Clear the widget instance palette. More...
 
void reset_theme ()
 Reset the Widget's Theme to the default Theme. More...
 
void resize_by_ratio (DefaultDim hratio, DefaultDim vratio)
 Scale the current size of the Widget given the ratio. More...
 
void resize_by_ratio (DefaultDim ratio)
 Scale the current size of the Widget given the ratio. More...
 
virtual void scale (float hscale, float vscale)
 Set the scale of the widget. More...
 
void scale (float scale)
 Set the scale of the widget. More...
 
virtual EGT_NODISCARD Screenscreen () const
 Get a pointer to the Screen instance, using using a parent as necessary. More...
 
EGT_NODISCARD const Sizesize () const
 Get the size of the widget's box(). More...
 
EGT_NODISCARD const Themetheme () const
 Get the Widget Theme. More...
 
void theme (const Theme &theme)
 Set the Widget's theme to a new theme. More...
 
EGT_NODISCARD Point to_parent (const Point &r) const
 Convert a point with a local origin to a parent origin. More...
 
EGT_NODISCARD Rect to_parent (const Rect &r) const
 Convert a point in a rect a local origin to a parent origin. More...
 
virtual EGT_NODISCARD std::string type () const
 Returns a string representation of the type of this widget. More...
 
EGT_NODISCARD const Rectuser_requested_box () const
 Get the box corresponding to the user requested one, not the actual one. More...
 
void vertical_ratio (DefaultDim vertical)
 Set the vertical ratio relative to parent. More...
 
EGT_NODISCARD DefaultDim vertical_ratio () const
 Get the vertical ratio relative to parent. More...
 
EGT_NODISCARD bool visible () const
 Get the visible state of the widget. More...
 
void visible (bool value)
 Set the visible state. More...
 
void visible_toggle ()
 Toggle the visibility state. More...
 
EGT_NODISCARD WidgetId widgetid () const
 Get the unique id of the widget. More...
 
void width (DefaultDim w)
 Change the width. More...
 
EGT_NODISCARD DefaultDim width () const
 Width of the widget's box(). More...
 
void x (DefaultDim x)
 Set the X coordinate of the box. More...
 
EGT_NODISCARD DefaultDim x () const
 X coordinate of the widget's box(). More...
 
void xratio (DefaultDim xratio)
 Set the X position ratio relative to parent. More...
 
EGT_NODISCARD DefaultDim xratio () const
 Get the X position ratio relative to parent. More...
 
void y (DefaultDim y)
 Set the Y coordinate of the box. More...
 
EGT_NODISCARD DefaultDim y () const
 Y coordinate of the widget's box(). More...
 
void yratio (DefaultDim yratio)
 Set the Y position ratio relative to parent. More...
 
EGT_NODISCARD DefaultDim yratio () const
 Get the Y position ratio relative to parent. More...
 
virtual EGT_NODISCARD size_t zorder () const
 Get the zorder of the widget. More...
 
virtual void zorder_bottom ()
 Move the widget to the bottom. More...
 
virtual void zorder_down ()
 Move this widgets zorder down relative to other widgets with the same parent. More...
 
virtual void zorder_top ()
 Move the widget to the top. More...
 
virtual void zorder_up ()
 Move this widgets zorder up relative to other widgets with the same parent. More...
 
- Public Member Functions inherited from Object
 Object () noexcept=default
 
 Object (const Object &)=delete
 
 Object (Object &&)=default
 
virtual ~Object () noexcept=default
 
void clear_handlers ()
 Clear all registered event handlers. More...
 
void invoke_handlers (Event &event)
 Invoke all handlers with the specified event. More...
 
void invoke_handlers (EventId event)
 Invoke all handlers with the specified EventId. More...
 
EGT_NODISCARD const std::string & name () const
 Get the name of the Object. More...
 
void name (const std::string &name)
 Set the name of the Object. More...
 
RegisterHandle on_event (const EventCallback &handler, const FilterFlags &mask={})
 Add an event handler to be called when the widget generates an event. More...
 
Objectoperator= (const Object &)=delete
 
Objectoperator= (Object &&)=default
 
void remove_handler (RegisterHandle handle)
 Remove an event handler. More...
 

Protected Member Functions

EGT_NODISCARD Size super_rect () const
 Calculate the super rectangle of all the children. More...
 
- Protected Member Functions inherited from Widget
EGT_NODISCARD const Palettedefault_palette () const
 Get a reference to the default palette. More...
 
EGT_NODISCARD const Widget::Flagsflags () const
 Get a const ref of the flags. More...
 
Widget::Flagsflags ()
 Get a modifiable ref of the flags. More...
 
EGT_NODISCARD Rect local_box () const
 Get the local box which is the same size as box(), but with the origin zeroed. More...
 
EGT_NODISCARD bool parent_in_layout ()
 Indicate if our parent is computing the layout. More...
 
void parent_layout ()
 Call our parent to do a layout. More...
 
virtual void set_parent (Frame *parent)
 Set this widget's parent. More...
 

Additional Inherited Members

- Public Types inherited from Frame
using ChildDrawCallback = std::function< void(Painter &painter, Widget *widget)>
 Helper type that defines the special draw child callback. More...
 
- Public Types inherited from Widget
enum  Flag : uint32_t {
  plane_window = detail::bit(0), window = detail::bit(1), frame = detail::bit(2), disabled = detail::bit(3),
  readonly = detail::bit(4), active = detail::bit(5), invisible = detail::bit(6), grab_mouse = detail::bit(7),
  no_clip = detail::bit(8), no_layout = detail::bit(9), no_autoresize = detail::bit(10), checked = detail::bit(11)
}
 Common flags used for various widget properties. More...
 
using Flags = egt::Flags< Widget::Flag >
 Widget flags. More...
 
using WalkCallback = std::function< bool(Widget *widget, int level)>
 Callback definition used by walk(). More...
 
using WidgetId = uint64_t
 Type used to identify a unique Widget ID. More...
 
- Public Types inherited from Object
using EventCallback = std::function< void(Event &event)>
 Event handler callback function. More...
 
using FilterFlags = FlagsBase< EventId >
 Event handler EventId filter. More...
 
using RegisterHandle = uint64_t
 Handle type. More...
 
- Public Attributes inherited from Widget
Signal on_checked_changed
 Event signal. More...
 
Signal on_gain_focus
 Invoked when the widget gains focus. More...
 
Signal on_lost_focus
 Invoked when the widget loses focus. More...
 
Signal on_show
 Invoked when a widget is shown. More...
 
Signal on_hide
 Invoked when a widget is hidden. More...
 
- Protected Types inherited from Frame
using ChildrenArray = std::vector< std::shared_ptr< Widget > >
 Helper type for an array of children. More...
 
- Protected Types inherited from Object
using CallbackArray = std::vector< CallbackMeta >
 Helper type for an array of callbacks. More...
 
- Protected Attributes inherited from Frame
ChildrenArray m_children
 Array of child widgets in the order they were added. More...
 
Screen::DamageArray m_damage
 The damage array for this frame. More...
 
bool m_in_draw {false}
 Status for whether this frame is currently drawing. More...
 
ChildDrawCallback m_special_child_draw_callback
 Used internally for calling the special child draw function. More...
 
- Protected Attributes inherited from Widget
Rect m_box
 Bounding box. More...
 
bool m_in_layout {false}
 Status for whether this widget is currently performing layout. More...
 
Size m_min_size
 Minimum size of the widget when not an empty value. More...
 
Framem_parent {nullptr}
 Pointer to this widget's parent. More...
 
Rect m_user_requested_box
 Keep track of the box requested by the user. More...
 
WidgetId m_widgetid {0}
 Unique ID of this widget. More...
 
- Protected Attributes inherited from Object
detail::CopyOnWriteAllocate< CallbackArraym_callbacks
 Array of callbacks. More...
 
RegisterHandle m_handle_counter {0}
 Counter used to generate unique handles for each callback registration. More...
 
std::string m_name
 A user defined name for the Object. More...
 

Detailed Description

Positions and sizes widgets by Orientation.

BoxSizer will position widgets added to it in a horizontal or vertical Orientation. The BoxSizer can be homogeneous, which means all widgets will be given equal space, or not. Also, space can be specified that should be between each widget.

An added Widget's minimum_size_hint() will be used.

Constructor & Destructor Documentation

◆ BoxSizer() [1/2]

BoxSizer ( Orientation  orient = Orientation::horizontal,
Justification  justify = Justification::middle 
)
inlineexplicit
Parameters
[in]orientVertical or horizontal Orientation.
[in]justifyJustification of child widgets.

◆ BoxSizer() [2/2]

BoxSizer ( Frame parent,
Orientation  orient = Orientation::horizontal,
Justification  justify = Justification::middle 
)
inlineexplicit
Parameters
[in]parentThe parent Frame.
[in]orientVertical or horizontal Orientation.
[in]justifyJustification of child widgets.

Member Function Documentation

◆ deserialize()

void deserialize ( const std::string &  name,
const std::string &  value,
const Serializer::Attributes attrs 
)
overridevirtual

Deserialize widget properties.

Reimplemented from Frame.

◆ justify() [1/2]

EGT_NODISCARD Justification justify ( ) const
inline

Get the justify.

◆ justify() [2/2]

void justify ( Justification  justify)
inline

Set the justify.

◆ layout()

void layout ( )
overridevirtual
Note
Remember that when overriding this function as a Frame, you must call layout on each child Frame to propagate the layout.

Reimplemented from Frame.

◆ orient() [1/2]

EGT_NODISCARD Orientation orient ( ) const
inline

Get the Orientation.

◆ orient() [2/2]

void orient ( Orientation  orient)
inline

Set the Orientation.

◆ serialize()

void serialize ( Serializer serializer) const
overridevirtual

Serialize the widget to the specified serializer.

Reimplemented from Frame.

◆ super_rect()

EGT_NODISCARD Size super_rect ( ) const
inlineprotected

Calculate the super rectangle of all the children.