HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Data Fields
hi::v1::scroll_aperture_widget Class Reference

#include <hikogui/widgets/scroll_aperture_widget.hpp>

Inheritance diagram for hi::v1::scroll_aperture_widget:
hi::v1::widget hi::v1::widget_intf

Public Types

using super = widget
 

Public Member Functions

 scroll_aperture_widget (widget *parent) noexcept
 
template<typename Widget , typename... Args>
Widgetmake_widget (Args &&...args) noexcept
 
bool x_axis_scrolls () const noexcept
 
bool y_axis_scrolls () const noexcept
 
- Public Member Functions inherited from hi::v1::widget
 widget (widget *parent) noexcept
 
 widget (const widget &)=delete
 
widgetoperator= (const widget &)=delete
 
 widget (widget &&)=delete
 
widgetoperator= (widget &&)=delete
 
generator< widget_intf & > children (bool include_invisible) noexcept override
 Get a list of child widgets.
 
hitbox hitbox_test (point2 position) const noexcept override
 Find the widget that is under the mouse cursor.
 
virtual hitbox hitbox_test_from_parent (point2 position) const noexcept
 Call hitbox_test from a parent widget.
 
virtual hitbox hitbox_test_from_parent (point2 position, hitbox sibling_hitbox) const noexcept
 Call hitbox_test from a parent widget.
 
bool accepts_keyboard_focus (keyboard_focus_group group) const noexcept override
 Check if the widget will accept keyboard focus.
 
box_constraints update_constraints () noexcept override
 Update the constraints of the widget.
 
void set_layout (widget_layout const &context) noexcept override
 Update the internal layout of the widget.
 
widget_layout constlayout () const noexcept override
 Get the current layout for this widget.
 
void draw (draw_context const &context) noexcept override
 Draw the widget.
 
bool process_event (gui_event const &event) const noexcept override
 Send a event to the window.
 
void request_redraw () const noexcept override
 Request the widget to be redrawn on the next frame.
 
bool handle_event (gui_event const &event) noexcept override
 Handle command.
 
bool handle_event_recursive (gui_event const &event, std::vector< widget_id > const &reject_list=std::vector< widget_id >{}) noexcept override
 Handle command recursive.
 
virtual widget_id find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept override
 Find the next widget that handles keyboard focus.
 
widget_id find_first_widget (keyboard_focus_group group) const noexcept override
 
widget_id find_last_widget (keyboard_focus_group group) const noexcept override
 
bool is_first (keyboard_focus_group group) const noexcept
 Is this widget the first widget in the parent container.
 
bool is_last (keyboard_focus_group group) const noexcept
 Is this widget the last widget in the parent container.
 
void scroll_to_show (hi::aarectangle rectangle) noexcept override
 Scroll to show the given rectangle on the window.
 
void set_window (gui_window *window) noexcept override
 Set the window for this tree of widgets.
 
gui_window * window () const noexcept override
 Get the window that the widget is owned by.
 
hi::theme consttheme () const noexcept
 
gfx_surface constsurface () const noexcept
 
virtual color background_color () const noexcept
 
virtual color foreground_color () const noexcept
 
virtual color focus_color () const noexcept
 
virtual color accent_color () const noexcept
 
virtual color label_color () const noexcept
 
virtual generator< widget_intf & > children (bool include_invisible) noexcept=0
 Get a list of child widgets.
 
virtual generator< widget_intf const & > children (bool include_invisible) const noexcept final
 Get a list of child widgets.
 
virtual void scroll_to_show (hi::aarectangle rectangle) noexcept=0
 Scroll to show the given rectangle on the window.
 
void scroll_to_show () noexcept
 Scroll to show the important part of the widget.
 
- Public Member Functions inherited from hi::v1::widget_intf
 widget_intf (widget_intf *parent) noexcept
 
std::vector< widget_id > parent_chain () const noexcept
 Get a list of parents of a given widget.
 
void scroll_to_show () noexcept
 Scroll to show the important part of the widget.
 

Data Fields

observer< floatcontent_width
 
observer< floatcontent_height
 
observer< floataperture_width
 
observer< floataperture_height
 
observer< floatoffset_x
 
observer< floatoffset_y
 
- Data Fields inherited from hi::v1::widget
observer< widget_modemode = widget_mode::enabled
 The widget mode.
 
observer< boolhover = false
 Mouse cursor is hovering over the widget.
 
observer< boolfocus = false
 The widget has keyboard focus.
 
int semantic_layer = 0
 The draw layer of the widget.
 
int logical_layer = 0
 The logical layer of the widget.
 
observer< extent2minimum = extent2{}
 The minimum size this widget is allowed to be.
 
observer< extent2maximum = extent2::large()
 The maximum size this widget is allowed to be.
 
- Data Fields inherited from hi::v1::widget_intf
widget_id id = {}
 The numeric identifier of a widget.
 
widget_intfparent = nullptr
 Pointer to the parent widget.
 

Detailed Description

A scroll aperture widget.

A widget that is used as a child of the scroll_widget which displays a partial rectangle (the aperture) of the content.


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