ox::Checkbox14 Class Reference

Inheritance diagram for ox::Checkbox14:

Classes
struct	Parameters

Public Member Functions
	Checkbox14 (State initial_state=State::Unchecked, bool locked=false)
	Checkbox14 (Parameters p)
Public Member Functions inherited from ox::Checkbox< Layout_t >
	Checkbox (State initial_state, Display display, bool locked)
	Construct a new Checkbox.
	Checkbox (Parameters p)
	Construct a new Checkbox.
void	check ()
	Set the state to be checked.
void	uncheck ()
	Set the state to be unchecked.
void	toggle ()
	Change state to be unchecked if currently checked, checked otherwise.
auto	get_state () const -> State
	Return the current state of the Checkbox as Checkbox::State enum value.
void	lock ()
	Lock the Checkbox, it can not be toggled when locked.
void	unlock ()
	Unlock the Checkbox, allowing it to be toggled.
auto	is_locked () const -> bool
	Return true if the Checkbox is locked.
void	set_display (Display d)
	Set the look of each Checkbox State.
auto	get_display () -> Display
	Return the look of each Checkbox State.
Public Member Functions inherited from ox::Label< Layout_t >
	Label (Glyph_string text=U"", Align alignment=Align::Left, int extra_left=0, int extra_right=0, Growth growth_strategy=Growth::Static)
	Create a new Label Widget. More...
	Label (Parameters p)
	Construct directly with Parameters object.
void	set_text (Glyph_string text)
	Set text contents of Label and update display.
auto	text () const noexcept -> Glyph_string const &
	Return the text given to set_text().
void	set_alignment (Align x)
	Set text alignment of Label and update display.
auto	alignment () const noexcept -> Align
	Return the Align given to set_alignment().
void	set_extra_left (int x)
	Inform Label about space to left of Label for centered text offset.
auto	extra_left () const noexcept -> int
	Return the amount given to set_extra_left().
void	set_extra_right (int x)
	Inform Label about space to right of Label for centered text offset.
auto	extra_right () const noexcept -> int
	Return the amount given to set_extra_right().
void	set_growth_strategy (Growth type)
	Enable/Disable Dynamic size, where the Label's size is the text length.
auto	growth_strategy () const noexcept -> Growth
	Return the value given to set_growth_strategy().
Public Member Functions inherited from ox::Widget
	Widget (std::string name="", Focus_policy focus_policy_=Focus_policy::None, Size_policy width_policy_=Size_policy{}, Size_policy height_policy_=Size_policy{}, Brush brush_=Brush{}, Glyph wallpaper=U' ', bool brush_paints_wallpaper=true, Cursor cursor=Cursor{})
	Create an empty Widget.
	Widget (Parameters p)
	Create an empty Widget.
	Widget (Widget const &)=delete
	Widget (Widget &&)=delete
Widget &	operator= (Widget const &)=delete
Widget &	operator= (Widget &&)=delete
void	set_name (std::string name)
	Set the identifying name of the Widget.
auto	name () const -> std::string const &
	Return the name of the Widget.
auto	unique_id () const -> std::uint16_t
	Return the ID number unique to this Widget.
void	set_wallpaper (Glyph g)
	Used to fill in empty space that is not filled in by paint_event().
auto	get_wallpaper () const -> Glyph
	Return the currently in use wallpaper or std::nullopt if none.
void	enable (bool enable=true)
	Enable this Widget and send an Enable_event to itself. More...
void	disable (bool disable=true)
	Disable this Widget and send a Disable_event to itself. More...
auto	is_enabled () const -> bool
	Check whether the Widget is enabled.
auto	parent () const -> Widget *
	Return the Widget's parent pointer. More...
auto	top_left () const -> Point
	Return the global top left corner of this widget.
auto	area () const -> Area
	Return the area the widget occupies.
virtual void	update ()
	Post a paint event to this Widget.
virtual auto	is_layout_type () const -> bool
void	install_event_filter (Widget &filter)
	Install another Widget as an Event filter. More...
void	remove_event_filter (Widget &filter)
	Remove a Widget from the Event filter list. More...
auto	get_event_filters () const -> std::set< Widget * > const &
	Return the list of Event filter Widgets.
void	enable_animation (std::chrono::milliseconds interval)
	Enable animation on this Widget. More...
void	enable_animation (FPS fps)
	Enable animation with a frames-per-second value.
void	disable_animation ()
	Turn off animation, no more Timer_events will be sent to this Widget. More...
auto	is_animated () const -> bool
	Return true if this Widget has animation enabled.
auto	get_children ()
	Get a range containing Widget& to each child.
auto	get_children () const
	Get a const range containing Widget& to each child.
auto	get_descendants () const -> std::vector< Widget * >
	Return container of all descendants of self_.
void	paint_wallpaper_with_brush (bool paints=true)
	Set if the brush is applied to the wallpaper Glyph.
auto	paints_wallpaper_with_brush () const -> bool
	If true, the brush will apply to the wallpaper Glyph.
auto	generate_wallpaper () const -> Glyph
	Return the wallpaper Glyph. More...
auto	get_child_offset () const -> std::size_t
	Return the index of the first child displayed by this Widget.
auto	child_count () const -> std::size_t
	Return the number of children held by this Widget.
virtual auto	enable_event () -> bool
	Handles Enable_event objects.
virtual auto	disable_event () -> bool
	Handles Disable_event objects.
virtual auto	child_added_event (Widget &child) -> bool
	Handles Child_added_event objects.
virtual auto	child_removed_event (Widget &child) -> bool
	Handles Child_removed_event objects.
virtual auto	child_polished_event (Widget &child) -> bool
	Handles Child_polished_event objects.
virtual auto	move_event (Point new_position, Point old_position) -> bool
	Handles Move_event objects.
virtual auto	mouse_release_event (Mouse const &m) -> bool
	Handles Mouse_release_event objects.
virtual auto	mouse_wheel_event (Mouse const &m) -> bool
	Handles Mouse_wheel_event objects.
virtual auto	mouse_move_event (Mouse const &m) -> bool
	Handles Mouse_move_event objects.
virtual auto	key_press_event (Key k) -> bool
	Handles Key_press_event objects.
virtual auto	key_release_event (Key k) -> bool
	Handles Key_release_event objects. More...
virtual auto	focus_in_event () -> bool
	Handles Focus_in_event objects.
virtual auto	focus_out_event () -> bool
	Handles Focus_out_event objects.
virtual auto	delete_event () -> bool
	Handles Delete_event objects.
virtual auto	timer_event () -> bool
	Handles Timer_event objects.
virtual auto	enable_event_filter (Widget &receiver) -> bool
	Handles Enable_event objects filtered from other Widgets.
virtual auto	disable_event_filter (Widget &receiver) -> bool
	Handles Disable_event objects filtered from other Widgets.
virtual auto	child_added_event_filter (Widget &receiver, Widget &child) -> bool
	Handles Child_added_event objects filtered from other Widgets.
virtual auto	child_removed_event_filter (Widget &receiver, Widget &child) -> bool
	Handles Child_removed_event objects filtered from other Widgets.
virtual auto	child_polished_event_filter (Widget &receiver, Widget &child) -> bool
	Handles Child_polished_event objects filtered from other Widgets.
virtual auto	move_event_filter (Widget &receiver, Point new_position, Point old_position) -> bool
	Handles Move_event objects filtered from other Widgets.
virtual auto	resize_event_filter (Widget &receiver, Area new_size, Area old_size) -> bool
	Handles Resize_event objects filtered from other Widgets.
virtual auto	mouse_press_event_filter (Widget &receiver, Mouse const &m) -> bool
	Handles Mouse_press_event objects filtered from other Widgets.
virtual auto	mouse_release_event_filter (Widget &receiver, Mouse const &m) -> bool
	Handles Mouse_release_event objects filtered from other Widgets.
virtual auto	mouse_wheel_event_filter (Widget &receiver, Mouse const &m) -> bool
	Handles Mouse_wheel_event objects filtered from other Widgets.
virtual auto	mouse_move_event_filter (Widget &receiver, Mouse const &m) -> bool
	Handles Mouse_move_event objects filtered from other Widgets.
virtual auto	key_press_event_filter (Widget &receiver, Key k) -> bool
	Handles Key_press_event objects filtered from other Widgets.
virtual auto	key_release_event_filter (Widget &receiver, Key k) -> bool
	Handles Key_release_event objects filtered from other Widgets.
virtual auto	focus_in_event_filter (Widget &receiver) -> bool
	Handles Focus_in_event objects filtered from other Widgets.
virtual auto	focus_out_event_filter (Widget &receiver) -> bool
	Handles Focus_out_event objects filtered from other Widgets.
virtual auto	delete_event_filter (Widget &receiver) -> bool
	Handles Delete_event objects filtered from other Widgets.
virtual auto	paint_event_filter (Widget &receiver, Painter &p) -> bool
	Handles Paint_event objects filtered from other Widgets.
virtual auto	timer_event_filter (Widget &receiver) -> bool
	Handles Timer_event objects filtered from other Widgets.
void	set_top_left (Point p)
	Should only be used by Move_event send() function.
void	set_area (Area a)
	Should only be used by Resize_event send() function.
void	set_parent (Widget *parent)
	Should only be used by Layout.

Additional Inherited Members
Public Types inherited from ox::Checkbox< Layout_t >
enum class	State : bool { Unchecked , Checked }
Public Attributes inherited from ox::Checkbox< Layout_t >
sl::Signal< void()>	checked
	Emitted when box becomes checked.
sl::Signal< void()>	unchecked
	Emitted when box becomes unchecked.
sl::Signal< void()>	toggled
	Emitted every time the box changes state.
Public Attributes inherited from ox::Widget
Signal< void()>	enabled
Signal< void()>	disabled
Signal< void(Widget &)>	child_added
Signal< void(Widget &)>	child_removed
Signal< void(Widget &)>	child_polished
Signal< void(Point, Point)>	moved
Signal< void(Area, Area)>	resized
Signal< void(Mouse const &)>	mouse_pressed
Signal< void(Mouse const &)>	mouse_released
Signal< void(Mouse const &)>	mouse_wheel_scrolled
Signal< void(Mouse const &)>	mouse_moved
Signal< void(Key)>	key_pressed
Signal< void(Key)>	key_released
Signal< void()>	focused_in
Signal< void()>	focused_out
Signal< void()>	deleted
Signal< void(Painter &)>	painted
Signal< void()>	timer
Signal< bool(Widget &)>	enabled_filter
Signal< bool(Widget &)>	disabled_filter
Signal< bool(Widget &, Widget &)>	child_added_filter
Signal< bool(Widget &, Widget &)>	child_removed_filter
Signal< bool(Widget &, Widget &)>	child_polished_filter
Signal< bool(Widget &, Point, Point)>	moved_filter
Signal< bool(Widget &, Area, Area)>	resized_filter
Signal< bool(Widget &, Mouse const &)>	mouse_pressed_filter
Signal< bool(Widget &, Mouse const &)>	mouse_released_filter
Signal< bool(Widget &, Mouse const &)>	mouse_wheel_scrolled_filter
Signal< bool(Widget &, Mouse const &)>	mouse_moved_filter
Signal< bool(Widget &, Key)>	key_pressed_filter
Signal< bool(Widget &, Key)>	key_released_filter
Signal< bool(Widget &)>	focused_in_filter
Signal< bool(Widget &)>	focused_out_filter
Signal< bool(Widget &)>	deleted_filter
Signal< bool(Widget &, Painter &)>	painted_filter
Signal< bool(Widget &)>	timer_filter
Focus_policy	focus_policy
	Describes how focus is given to this Widget.
Cursor	cursor
	Provides information on where the cursor is and if it is enabled.
Size_policy	width_policy
	Describes how the width of this Widget should be modified by a Layout.
Size_policy	height_policy
	Describes how the height of this Widget should be modified by a Layout.
Brush	brush
	A Brush that is applied to every Glyph painted by this Widget.
sl::Lifetime	lifetime
	Slots can track this object's lifetime to disable Slot invocations.
Protected Types inherited from ox::Widget
using	Children_t = std::vector< std::unique_ptr< Widget > >
Protected Member Functions inherited from ox::Checkbox< Layout_t >
auto	mouse_press_event (Mouse const &m) -> bool override
	Handles Mouse_press_event objects.
Protected Member Functions inherited from ox::Label< Layout_t >
auto	paint_event (Painter &p) -> bool override
	Handles Paint_event objects.
auto	resize_event (Area new_size, Area old_size) -> bool override
	Handles Resize_event objects.
Protected Attributes inherited from ox::Widget
Children_t	children_
std::size_t	child_offset_ = 0

---

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

• /github/workspace/include/termox/widget/widgets/checkbox.hpp