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

Public Types

using super = widget
 

Public Member Functions

 scroll_aperture_widget (gui_window &window, widget *parent) noexcept
 
template<typename Widget , typename... Args>
Widget & make_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 (gui_window &window, widget *parent) noexcept
 
 widget (const widget &)=delete
 
widgetoperator= (const widget &)=delete
 
 widget (widget &&)=delete
 
widgetoperator= (widget &&)=delete
 
bool is_gui_thread () const noexcept
 
hi::theme const & theme () const noexcept
 Get the theme.
 
hi::font_book & font_book () const noexcept
 Get the font book.
 
virtual hitbox hitbox_test_from_parent (point3 position) const noexcept
 Call hitbox_test from a parent widget.
 
virtual hitbox hitbox_test_from_parent (point3 position, hitbox sibling_hitbox) const noexcept
 Call hitbox_test from a parent widget.
 
virtual bool accepts_keyboard_focus (keyboard_focus_group group) const noexcept
 Check if the widget will accept keyboard focus.
 
widget_constraints const & constraints () const noexcept
 
widget_layout const & layout () const noexcept
 Get the current layout for this widget.
 
virtual void request_redraw () const noexcept
 Request the widget to be redrawn on the next frame.
 
void request_relayout () const noexcept
 Request the window to be relayout on the next frame.
 
template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
void request_reconstrain (Args &&...args) const noexcept
 Request the window to be reconstrain on the next frame.
 
template<fixed_string SourceFile, int SourceLine, fixed_string Fmt, typename... Args>
void request_resize (Args &&...args) const noexcept
 Request the window to be resize based on the preferred size of the widgets.
 
virtual bool handle_event_recursive (gui_event const &event, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
 Handle command recursive.
 
virtual widget const * find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
 Find the next widget that handles keyboard focus.
 
widget const * find_first_widget (keyboard_focus_group group) const noexcept
 
widget const * find_last_widget (keyboard_focus_group group) const noexcept
 
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 () noexcept
 Scroll to show the important part of the widget.
 
std::vector< widget const * > parent_chain () const noexcept
 Get a list of parents of a given widget.
 
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
 

Data Fields

observer< float > content_width
 
observer< float > content_height
 
observer< float > aperture_width
 
observer< float > aperture_height
 
observer< float > offset_x
 
observer< float > offset_y
 
- Data Fields inherited from hi::v1::widget
gui_window & window
 Convenient reference to the Window.
 
widget *const parent
 Pointer to the parent widget.
 
std::string id
 A name of widget, should be unique between siblings.
 
observer< widget_modemode = widget_mode::enabled
 The widget mode.
 
observer< bool > hover = false
 Mouse cursor is hovering over the widget.
 
observer< bool > focus = false
 The widget has keyboard focus.
 
int semantic_layer
 The draw layer of the widget.
 
int logical_layer
 The logical layer of the 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: