uicore::ScrollBaseView Class Reference

#include <scroll_view.h>

+ Inheritance diagram for uicore::ScrollBaseView:

Public Member Functions

 ScrollBaseView ()
 
 ~ScrollBaseView ()
 
Pointf content_offset () const
 
std::shared_ptr< Viewcontent_view () const
 
void layout_children (const CanvasPtr &canvas) override
 Sets the view geometry for all children of this view. More...
 
ContentOverflow overflow_x () const
 
ContentOverflow overflow_y () const
 
std::shared_ptr< ScrollBarBaseViewscrollbar_x_view () const
 
std::shared_ptr< ScrollBarBaseViewscrollbar_y_view () const
 
void set_content_offset (const Pointf &offset, bool animated=false)
 
void set_overflow (ContentOverflow value_x, ContentOverflow value_y)
 
void set_overflow_x (ContentOverflow value)
 
void set_overflow_y (ContentOverflow value)
 
- Public Member Functions inherited from uicore::View
 View ()
 
virtual ~View ()
 
const std::vector< std::shared_ptr< ViewAction > > & actions () const
 List of all action recognizers. More...
 
void activated (ActivationChangeEvent *e) override
 Handler for when the application is activated. More...
 
void add_action (const std::shared_ptr< ViewAction > &action)
 Add an action recognizer. More...
 
template<typename T , typename... Types>
std::shared_ptr< T > add_action (Types &&...args)
 
void add_child (const std::shared_ptr< View > &view)
 Add a child view. More...
 
template<typename T , typename... Types>
std::shared_ptr< T > add_child (Types &&...args)
 
std::shared_ptr< Viewadd_child ()
 
void animate (float from, float to, const std::function< void(float)> &setter, int duration_ms=400, const std::function< float(float)> &easing=Easing::linear, std::function< void()> animation_end=std::function< void()>())
 Continously call an animation function for the specified duration. More...
 
CanvasPtr canvas () const
 
const std::vector< std::shared_ptr< View > > & children () const
 List of all immediate child views. More...
 
void clear_exception_encountered ()
 
void close (CloseEvent *e) override
 Handler for close events. More...
 
bool content_clipped () const
 Content clipping flag. More...
 
void deactivated (ActivationChangeEvent *e) override
 Handler for when the application is deactivated. More...
 
void dispatch_event (EventUI *e, bool no_propagation=false)
 
void dispatch_event (EventUI *e, const View *until_parent_view)
 
std::shared_ptr< Viewfind_view_at (const Pointf &pos) const
 Find descendant view at the specified content relative position. More...
 
float first_baseline_offset (const CanvasPtr &canvas, float width)
 Calculates the offset to the first baseline. More...
 
void focus_gained (FocusChangeEvent *e) override
 Handler for focus gained events. More...
 
void focus_lost (FocusChangeEvent *e) override
 Handler for focus lost events. More...
 
FocusPolicy focus_policy () const
 Focus policy active for this view. More...
 
Viewfocus_view () const
 The view receiving keyboard events or nullptr if no view has the focus. More...
 
Pointf from_root_pos (const Pointf &pos)
 Map from root content to local content coordinates. More...
 
Pointf from_screen_pos (const Pointf &pos)
 Map from screen to local content coordinates. More...
 
const ViewGeometrygeometry () const
 Actual view position and size after layout. More...
 
bool has_focus () const
 Test if this view is receiving keyboard input. More...
 
bool hidden () const
 Test if view is set to hidden. More...
 
bool is_static_position_and_visible () const
 Test if view should participate in static layout calculations (layout_children) More...
 
void key_press (KeyEvent *e) override
 Handler for key press events. More...
 
void key_release (KeyEvent *e) override
 Handler for key release events. More...
 
float last_baseline_offset (const CanvasPtr &canvas, float width)
 Calculates the offset to the last baseline. More...
 
bool needs_layout () const
 Test if view geometry needs to be recalculated. More...
 
void next_focus ()
 Give focus to the next view in the keyboard tab index order. More...
 
Viewparent () const
 Parent view node or nullptr if the view is the current root node. More...
 
void pointer_double_click (PointerEvent *e) override
 Handler for pointer double click events. More...
 
void pointer_enter (PointerEvent *e) override
 Handler for pointer enter events. More...
 
void pointer_leave (PointerEvent *e) override
 Handler for pointer leave events. More...
 
void pointer_move (PointerEvent *e) override
 Handler for pointer movement events. More...
 
void pointer_press (PointerEvent *e) override
 Handler for pointer press events. More...
 
void pointer_proximity_change (PointerEvent *e) override
 Handler for pointer proximity change events. More...
 
void pointer_release (PointerEvent *e) override
 Handler for pointer release events. More...
 
float preferred_height (const CanvasPtr &canvas, float width)
 Calculates the preferred height of this view. More...
 
float preferred_width (const CanvasPtr &canvas)
 Calculates the preferred width of this view. More...
 
void prev_focus ()
 Give focus to the previous view in the keyboard tab index order. More...
 
void remove_focus ()
 Remove focus from this view. More...
 
void remove_from_parent ()
 Remove view from parent. More...
 
bool render_exception_encountered () const
 Test if this view generated an exception during rendering. More...
 
void set_content_clipped (bool clipped)
 Specifies if content should be clipped during rendering. More...
 
void set_cursor (const CursorDescription &cursor)
 Set the cursor icon used when cursor is above this view. More...
 
void set_cursor (StandardCursor type)
 
void set_focus ()
 Set this view as the focused view. More...
 
void set_focus_policy (FocusPolicy policy)
 Set if this view automatically can gain focus. More...
 
void set_geometry (const ViewGeometry &geometry)
 
void set_hidden (bool value=true)
 Hides a view from layout and rendering. More...
 
void set_inherit_cursor ()
 Specify that the cursor icon is inherited from the parent view. More...
 
void set_needs_layout ()
 Forces recalculation of view geometry before next rendering. More...
 
void set_needs_render ()
 Signals this view needs to be rendered again. More...
 
void set_state (const std::string &name, bool value)
 Set or clear style state. More...
 
void set_state_cascade (const std::string &name, bool value)
 Sets the state for this view and all siblings recursively, until a manually set state of the same name is found. More...
 
void set_tab_index (unsigned int index)
 Sets the tab index used for keyboard focus changes. More...
 
void set_view_transform (const Mat4f &transform)
 Specifies the view transform to be applied before its contents and children are rendered. More...
 
Signal< void(ActivationChangeEvent *)> & sig_activated ()
 
Signal< void(CloseEvent *)> & sig_close ()
 
Signal< void(ActivationChangeEvent *)> & sig_deactivated ()
 
Signal< void(FocusChangeEvent *)> & sig_focus_gained ()
 
Signal< void(FocusChangeEvent *)> & sig_focus_lost ()
 
Signal< void(KeyEvent *)> & sig_key_press ()
 
Signal< void(KeyEvent *)> & sig_key_release ()
 
Signal< void(PointerEvent *)> & sig_pointer_double_click ()
 
Signal< void(PointerEvent *)> & sig_pointer_enter ()
 
Signal< void(PointerEvent *)> & sig_pointer_leave ()
 
Signal< void(PointerEvent *)> & sig_pointer_move ()
 
Signal< void(PointerEvent *)> & sig_pointer_press ()
 
Signal< void(PointerEvent *)> & sig_pointer_proximity_change ()
 
Signal< void(PointerEvent *)> & sig_pointer_release ()
 
bool state (const std::string &name) const
 Test if a style state is currently set. More...
 
void stop_animations ()
 Stop all activate animation functions. More...
 
const std::shared_ptr< Style > & style (const std::string &state=std::string()) const
 Style properties for the specified state. More...
 
const StyleCascadestyle_cascade () const
 Style cascade currently active for this view. More...
 
unsigned int tab_index () const
 Tab index for keyboard focus changes. More...
 
Pointf to_root_pos (const Pointf &pos)
 Map from local content to root content coordinates. More...
 
Pointf to_screen_pos (const Pointf &pos)
 Map from local content to screen coordinates. More...
 
void update_cursor (const DisplayWindowPtr &window)
 Update window cursor to the cursor used by this view. More...
 
const Mat4fview_transform () const
 Current view transform. More...
 
const ViewTreeview_tree () const
 Tree in view hierachy. More...
 
ViewTreeview_tree ()
 

Protected Member Functions

float calculate_first_baseline_offset (const CanvasPtr &canvas, float width) override
 Calculates the offset to the first baseline. More...
 
float calculate_last_baseline_offset (const CanvasPtr &canvas, float width) override
 Calculates the offset to the last baseline. More...
 
float calculate_preferred_height (const CanvasPtr &canvas, float width) override
 Calculates the preferred height of this view. More...
 
float calculate_preferred_width (const CanvasPtr &canvas) override
 Calculates the preferred width of this view. More...
 
- Protected Member Functions inherited from uicore::View
virtual void child_added (const std::shared_ptr< View > &view)
 Child view was added to this view. More...
 
virtual void child_removed (const std::shared_ptr< View > &view)
 Child view was removed from this view. More...
 
virtual void render_content (const CanvasPtr &canvas)
 Renders the content of a view. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from uicore::View
static Viewcommon_parent (View *view1, View *view2)
 Find the common parent view for the specified views. More...
 
- Public Attributes inherited from uicore::View
SlotContainer slots
 Slot container helping with automatic disconnection of connected slots when the view is destroyed. More...
 

Constructor & Destructor Documentation

uicore::ScrollBaseView::ScrollBaseView ( )
uicore::ScrollBaseView::~ScrollBaseView ( )

Member Function Documentation

float uicore::ScrollBaseView::calculate_first_baseline_offset ( const CanvasPtr canvas,
float  width 
)
overrideprotectedvirtual

Calculates the offset to the first baseline.

Reimplemented from uicore::View.

float uicore::ScrollBaseView::calculate_last_baseline_offset ( const CanvasPtr canvas,
float  width 
)
overrideprotectedvirtual

Calculates the offset to the last baseline.

Reimplemented from uicore::View.

float uicore::ScrollBaseView::calculate_preferred_height ( const CanvasPtr canvas,
float  width 
)
overrideprotectedvirtual

Calculates the preferred height of this view.

Reimplemented from uicore::View.

float uicore::ScrollBaseView::calculate_preferred_width ( const CanvasPtr canvas)
overrideprotectedvirtual

Calculates the preferred width of this view.

Reimplemented from uicore::View.

Pointf uicore::ScrollBaseView::content_offset ( ) const
std::shared_ptr<View> uicore::ScrollBaseView::content_view ( ) const
void uicore::ScrollBaseView::layout_children ( const CanvasPtr canvas)
overridevirtual

Sets the view geometry for all children of this view.

Reimplemented from uicore::View.

ContentOverflow uicore::ScrollBaseView::overflow_x ( ) const
ContentOverflow uicore::ScrollBaseView::overflow_y ( ) const
std::shared_ptr<ScrollBarBaseView> uicore::ScrollBaseView::scrollbar_x_view ( ) const
std::shared_ptr<ScrollBarBaseView> uicore::ScrollBaseView::scrollbar_y_view ( ) const
void uicore::ScrollBaseView::set_content_offset ( const Pointf offset,
bool  animated = false 
)
void uicore::ScrollBaseView::set_overflow ( ContentOverflow  value_x,
ContentOverflow  value_y 
)
void uicore::ScrollBaseView::set_overflow_x ( ContentOverflow  value)
void uicore::ScrollBaseView::set_overflow_y ( ContentOverflow  value)

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