Inheritance diagram for Panel:

[legend]

Public Member Functions
	Panel (const Panel &)=delete

	Panel (const UI::Template &temp)

	Panel (Registry::TemplateType type=Registry::Panel_Regular)

virtual bool	Activate () override
	Activates the widget. More...

virtual bool	CharacterEvent (Char) override
	This function should be called whenever a character is received from operating system. More...

void	DisableSmoothScroll ()
	Disables smooth scrolling of the panel. More...

void	EnableScroll (bool vertical, bool horizontal)
	Controls whether scrolling will be enabled vertically or horizontally. More...

bool	EnsureVisible (const UI::Widget &widget) override
	Ensures the widget is visible. More...

virtual Geometry::Size	GetInteriorSize () const override
	Should return the interior (usable) size of the container. More...

int	GetOverscroll () const
	Returns the amount of extra scrolling distance after the bottom-most widget is completely visible in pixels. More...

Geometry::Point	GetScrollDistance () const
	Returns the scroll distance per click. More...

int	GetSmoothScrollSpeed () const
	Returns the smooth scrolling speed of the panel. More...

virtual bool	IsEnabled () const override
	Returns whether the widget is enabled. More...

bool	IsHorizontalScrollEnabled () const
	Whether horizontal scrolling is enabled. More...

bool	IsSmoothScrollEnabled () const
	Returns if the smooth scroll is enabled. More...

bool	IsVerticalScrollEnabled () const
	Whether vertical scrolling is enabled. More...

virtual bool	IsVisible () const override
	Should return whether the container is visible. More...

virtual bool	KeyEvent (Input::Key, float) override
	This function should be called whenever a key is pressed or released. More...

Geometry::Point	MaxScrollOffset () const
	Returns the current maximum scroll offset. More...

virtual void	Move (const Geometry::Point &location) override
	Moves this widget to the given position. More...

virtual UI::ExtenderRequestResponse	RequestExtender (const Gorgon::Layer &self) override
	This function will return a container that will act as an extender. More...

virtual void	Resize (const Geometry::Size &size) override
	Changes the size of the widget. More...

virtual bool	ResizeInterior (Geometry::Size size) override
	Should resize the interior (usable) size of the container. More...

void	ScrollBy (int x, int y, bool clip=true)
	Scrolls the contents an additional amount. More...

void	ScrollBy (int y, bool clip=true)
	Scrolls the contents an additional amount. More...

Geometry::Point	ScrollOffset () const
	Returns the current scroll offset. More...

void	ScrollTo (Geometry::Point location, bool clip=false)
	Scrolls the contents of the panel so that the given location will be at the top left. More...

void	ScrollTo (int x, int y, bool clip=true)
	Scrolls the contents of the panel so that the given location will be at the top left. More...

void	ScrollTo (int y, bool clip=true)
	Scrolls the contents of the panel so that the given location will be at the top. More...

virtual void	SetEnabled (bool value) override
	Sets the enabled state of the widget. More...

void	SetOverscroll (int value)
	Sets the amount of extra scrolling distance after the bottom-most widget is completely visible in pixels. More...

void	SetScrollDistance (Geometry::Point dist)
	Sets the scroll distance per click in pixels. More...

void	SetScrollDistance (int hor, int vert)
	Sets the scroll distance per click in pixels. More...

void	SetScrollDistance (int vert)
	Sets the horizontal scroll distance per click in pixels. More...

void	SetSmoothScrollSpeed (int value)
	Adjusts the smooth scrolling speed of the panel. More...

Public Member Functions inherited from ComponentStackWidget
	ComponentStackWidget (ComponentStackWidget &&)=default

	ComponentStackWidget (const Template &temp, std::map< ComponentTemplate::Tag, std::function< Widget *(const Template &)>> generators={})

virtual	~ComponentStackWidget ()

virtual Geometry::Point	GetLocation () const override
	Returns the location of the widget. More...

virtual Geometry::Size	GetSize () const override
	Returns the size of the widget. More...

virtual void	Move (const Geometry::Point &location)=0
	Moves this widget to the given position. More...

void	Move (int x, int y)
	Moves this widget to the given position. More...

virtual void	Resize (const Geometry::Size &size)=0
	Changes the size of the widget. More...

virtual void	Resize (int w, int h)
	Changes the size of the widget. More...

Public Member Functions inherited from Widget
	Widget ()

	Widget (Widget &&)=default

virtual	~Widget ()

bool	AllowFocus () const
	If this widget can be focused currently. More...

bool	Defocus ()
	Removes the focus from this widget if this widget is focused. More...

void	Disable ()
	Disables the widget so that the user cannot interact with it. More...

virtual bool	Done ()
	For widgets that supports it, this will trigger finalization the user interaction. More...

void	Enable ()
	Enables the widget so that the user can interact with it. More...

bool	EnsureVisible () const
	Ensures this widget is visible in its container by scrolling it into view. More...

bool	Focus ()
	Transfers the focus to this widget. More...

Geometry::Bounds	GetBounds () const
	Returns the bounds of the widget. More...

int	GetHeight () const
	Returns the height of the widget. More...

WidgetContainer &	GetParent () const
	Returns the parent of this widget, throws if it does not have a parent. More...

int	GetWidth () const
	Returns the width of the widget. More...

bool	HasParent () const
	Returns if this widget has a parent. More...

void	Hide ()
	Hides this widget, when hidden, widgets cannot gain focus. More...

bool	IsFloating () const
	Returns floating status of this widget. More...

bool	IsFocused () const
	Returns if this widget is focused. More...

bool	IsVisible () const
	Returns if the widget is visible. More...

void	Move (int x, int y)
	Moves this widget to the given position. More...

bool	Remove ()
	Removes the widget from its parent. More...

virtual void	Resize (int w, int h)
	Changes the size of the widget. More...

void	SetHeight (int height)
	Sets the height of the widget. More...

virtual void	SetIsFloating (bool value)
	Sets floating status of this widget. More...

void	setname (std::string value)
	This is a debug feature. More...

void	SetVisible (bool value)
	Changes the visibility of the widget. More...

void	SetWidth (int width)
	Sets the width of the widget. More...

void	Show ()
	Shows this widget, widgets are visible by default. More...

void	ToggleEnabled ()
	Toggles enabled state of the widget. More...

void	ToggleVisible ()
	Toggles the visibility state of the widget. More...

Public Member Functions inherited from WidgetContainer
	WidgetContainer ()=default

	WidgetContainer (WidgetContainer &&)=default

virtual	~WidgetContainer ()
	Virtual destructor. More...

bool	Add (Widget &widget)
	Adds the given widget to this container. More...

void	AttachOrganizer (Organizers::Base &organizer)
	Attaches an organizer to this container. More...

auto	begin ()
	Returns the begin iterator for the contained widgets. More...

auto	begin () const
	Returns the begin iterator for the contained widgets. More...

void	ChangeFocusOrder (Widget &widget, int order)
	Changes the focus order of the given widget. More...

void	ChangeZorder (Widget &widget, int order)
	Changes the z-order of the widget. More...

template<class O_ , class ... Args_>
O_ &	CreateOrganizer (Args_ &&... args)
	Creates a new organizer that lives with this container. More...

FocusStrategy	CurrentFocusStrategy () const
	Returns the active focus strategy. This function will not return Inherit. More...

void	Disable ()
	Disables the container, disallowing interactions of all widgets in it. More...

void	DisableTabSwitch ()
	Disable tab switching. More...

void	Displaced ()
	Call this function if the container or widgets in it is moved without move function is called. More...

void	Enable ()
	Enables the container, allowing interaction with the widgets in it. More...

void	EnableTabSwitch ()
	Enable tab switching. More...

auto	end ()
	Returns the end iterator for the contained widgets. More...

auto	end () const
	Returns the end iterator for the contained widgets. More...

bool	FocusFirst ()
	Focuses the first widget that accepts focus. More...

bool	FocusLast ()
	Focuses the last widget in the container. More...

bool	FocusNext ()
	Focuses the next widget that accepts focus. More...

bool	FocusNext (const Widget &widget)
	Focuses the next widget that accepts focus starting from the given focus index. More...

bool	FocusNext (int after)
	Focuses the next widget that accepts focus starting from the given focus index. More...

bool	FocusPrevious ()
	Focuses the previous widget that accepts focus. More...

bool	FocusPrevious (const Widget &widget)
	Focuses the previous widget that accepts focus. More...

bool	FocusPrevious (int before)
	Focuses the previous widget that accepts focus. More...

void	ForceRemove (Widget &widget)
	Forcefully removes the given widget from this container. More...

void	ForceRemoveFocus ()
	Forcefully removes the focus from the focused widget. More...

virtual Widget &	GetCancel () const
	Returns the cancel element of the container which is called when the use presses escape key. More...

int	GetCount () const
	Returns the number of widgets in this container. More...

virtual Widget &	GetDefault () const
	Returns the default element of the container. More...

Widget &	GetFocus () const
	Returns the focused widget. More...

int	GetFocusOrder (const Widget &widget) const

FocusStrategy	GetFocusStrategy () const
	Returns the focus strategy set to this container. More...

Organizers::Base &	GetOrganizer () const
	Returns the organizer controlling this container. More...

virtual bool	HasCancel () const
	Returns if this container has a cancel widget. More...

virtual bool	HasDefault () const
	Returns if this container has a default object. More...

bool	HasFocusedWidget () const
	Returns if this container has a focused widget. More...

bool	HasOrganizer () const
	Returns if this container has an organizer. More...

bool	Insert (Widget &widget, int index)
	Add the given widget to this container. More...

virtual bool	IsTabSwitchEnabled () const
	Check if tab switch is enabled. More...

WidgetContainer &	operator= (WidgetContainer &&)=default

Widget &	operator[] (int ind)
	Returns the widget at the given index. More...

const Widget &	operator[] (int ind) const
	Returns the widget at the given index. More...

bool	Remove (Widget &widget)
	Removes the given widget from this container. More...

virtual void	RemoveCancel ()
	Removes the cancel widget of this container. More...

virtual void	RemoveDefault ()
	Removes the default widget of this container. More...

bool	RemoveFocus ()
	Removes the focus from the focused widget. More...

void	RemoveOrganizer ()
	Removes the organizer from this container. More...

virtual void	SetCancel (Widget &widget)
	Sets the cancel widget of the container. More...

virtual void	SetDefault (Widget &widget)
	Sets the default object of the container. More...

void	SetFocusStrategy (FocusStrategy value)
	Sets the focus strategy, see FocusStrategy. More...

bool	SetFocusTo (Widget &widget)
	Sets the focus to the given widget. More...

virtual void	SetTabSwitchEnabledState (bool state)
	Sets the state of tab switching. More...

void	ToggleEnabled ()
	Toggles the enabled state of this container. More...

void	ToggleTabSwitchEnabledState ()
	Toggles the state of tab switching. More...

Protected Member Functions
virtual bool	allowfocus () const override
	Should return true if the widget can be focused. More...

virtual void	childboundschanged (Widget *source) override

virtual UI::Widget *	createhscroll (const UI::Template &temp)

virtual UI::Widget *	createvscroll (const UI::Template &temp)

void	focuschanged () override
	This function is called when the focus is changed. More...

virtual void	focused () override
	This is called after the focus is transferred to this widget. More...

virtual void	focuslost () override
	This is called after the focus is lost. More...

virtual Layer &	getlayer () override
	Returns the layer that will be used to place the contained widgets. More...

FocusStrategy	getparentfocusstrategy () const override
	If this widget is not top level, return the current strategy used by the parent. More...

virtual void	parentenabledchanged (bool state) override
	This function is called when the parent's enabled state changes. More...

void	scrolltox (int x)

void	scrolltoy (int y)

void	updatebars ()

void	updatecontent ()

void	updatescroll ()

Protected Member Functions inherited from ComponentStackWidget
virtual void	addto (Layer &layer) override
	When called, widget should locate itself on to this layer. More...

virtual void	removed () override
	Called after this widget is removed from its parent. More...

virtual void	removefrom (Layer &layer) override
	When called, widget should remove itself from the given layer. More...

virtual void	setlayerorder (Layer &, int order) override
	When called, widget should reorder itself in layer hierarchy. More...

Protected Member Functions inherited from Widget
virtual void	addedto (WidgetContainer &container)
	Called when this widget added to the given container. More...

virtual bool	addingto (WidgetContainer &)
	Called when it is about to be added to the given container. More...

virtual void	boundschanged ()
	Call this function when the widget bounds is changed. More...

virtual bool	canloosefocus () const
	Should return true if the widget can loose the focus right now. More...

virtual void	displaced ()
	Call this function when the widget container causes it to be displaced. More...

virtual bool	removingfrom ()
	Called before this widget is removed from its parent. More...

Protected Member Functions inherited from WidgetContainer
virtual bool	addingwidget (Widget &)
	This function can return false to prevent the given widget from getting added to the container. More...

virtual void	childboundschanged (Widget *source)
	The boundary of any of the children is changed. Source could be nullptr. More...

bool	distributecharevent (Char c)
	Distributes a pressed character to the focused widget. More...

bool	distributekeyevent (Input::Key key, float state, bool handlestandard)
	Distributes the pressed key to the focused widget. More...

void	distributeparentenabled (bool state)
	Distributes a enabled state to children. More...

bool	handlestandardkey (Input::Key key)
	Performs the standard operations (tab/enter/escape) More...

virtual bool	removingwidget (Widget &)
	This function is called before removing a widget. More...

virtual void	widgetadded (Widget &)
	This function is called after a widget is added. More...

virtual void	widgetremoved (Widget &)
	This function is called after a widget is removed. More...

Protected Attributes
bool	hscroll

bool	isscrolling

int	overscroll

Input::KeyRepeater	repeater

bool	scrollclipped

Geometry::Point	scrolldist

float	scrollleftover

Geometry::Point	scrolloffset

int	scrollspeed

Geometry::Point	target

bool	updaterequired

bool	vscroll

Protected Attributes inherited from ComponentStackWidget
bool	enabled

bool	parentenabled

ComponentStack &	stack

Protected Attributes inherited from WidgetContainer
Containers::Collection< Widget >	widgets
	This container is sorted by the focus order. More...

Additional Inherited Members
Public Types inherited from WidgetContainer
enum	FocusStrategy { Inherit, AllowAll, Selective, Strict, Deny }
	Defines focus strategy for the container. Default is Inherit. More...

Public Attributes inherited from Widget
Event< Widget >	BoundsChangedEvent
	This event will be fired when the area that the widget occupies on its container is changed. More...

std::string	dbgname

Event< Widget >	FocusEvent
	This event will be fired when the widget receives or looses focus. More...

Geometry::PointProperty< Widget, &Widget::getlocation, &Widget::move >	Location

Geometry::SizeProperty< Widget, &Widget::getsize, &Widget::resize >	Size

Constructor & Destructor Documentation

◆ Panel() [1/3]

Panel ( const Panel & )

delete

◆ Panel() [2/3]

Panel ( const UI::Template & temp )

explicit

References Panel::createhscroll(), Panel::createvscroll(), ComponentTemplate::HScrollTag, and ComponentTemplate::VScrollTag.

◆ Panel() [3/3]

Panel ( Registry::TemplateType type = Registry::Panel_Regular )

explicit

Member Function Documentation

◆ Activate()

bool Activate ( )

overridevirtual

Activates the widget.

This might perform the action if the widget is a button, forward the focus if it is a label or focus if it is an input field.

Implements Widget.

References Widget::Focus(), and WidgetContainer::FocusFirst().

◆ allowfocus()

bool allowfocus ( ) const

overrideprotectedvirtual

Should return true if the widget can be focused.

Reimplemented from Widget.

References WidgetContainer::CurrentFocusStrategy(), WidgetContainer::Deny, and WidgetContainer::widgets.

◆ CharacterEvent()

bool CharacterEvent ( Char c )

overridevirtual

This function should be called whenever a character is received from operating system.

Reimplemented from WidgetContainer.

References WidgetContainer::CharacterEvent().

◆ childboundschanged()

void childboundschanged ( Widget * source )

overrideprotectedvirtual

References Panel::updatebars(), Panel::updatecontent(), and Panel::updaterequired.

◆ createhscroll()

UI::Widget * createhscroll ( const UI::Template & temp )

protectedvirtual

References ComponentTemplate::ContentsTag.

◆ createvscroll()

UI::Widget * createvscroll ( const UI::Template & temp )

protectedvirtual

References ComponentTemplate::ContentsTag.

◆ DisableSmoothScroll()

void DisableSmoothScroll ( )

Disables smooth scrolling of the panel.

References Panel::SetSmoothScrollSpeed().

◆ EnableScroll()

void EnableScroll	(	bool	vertical,
		bool	horizontal
	)

Controls whether scrolling will be enabled vertically or horizontally.

It is possible to use ScrollTo function without enabling scrolling but the user will not be able to scroll in this case. Enabling scrolling will also display a scrollbar. Depending on the theme it might not be visible until there is something to scroll. Disabling scrolling will not take the scroll position to top.

References Gorgon::UI::HScroll, Gorgon::UI::HVScroll, and Gorgon::UI::VScroll.

◆ EnsureVisible()

bool EnsureVisible ( const UI::Widget & widget )

overridevirtual

Ensures the widget is visible.

Returns true if the container can be scroll to make sure the given widget is visible. This function cannot be expected to take outside factors into account, such as occlusion. This function does not change the visibility of the widget and will return false if the widget is not visible.

Implements WidgetContainer.

References basic_Bounds< T_ >::Bottom, Widget::GetBounds(), Widget::IsVisible(), basic_Bounds< T_ >::Left, basic_Bounds< T_ >::Right, and basic_Bounds< T_ >::Top.

◆ focuschanged()

void focuschanged ( )

overrideprotectedvirtual

This function is called when the focus is changed.

Reimplemented from WidgetContainer.

References Widget::Focus(), WidgetContainer::HasFocusedWidget(), Widget::IsFocused(), and WidgetContainer::RemoveFocus().

◆ focused()

void focused ( )

overrideprotectedvirtual

This is called after the focus is transferred to this widget.

Reimplemented from ComponentStackWidget.

References WidgetContainer::FocusFirst(), and WidgetContainer::HasFocusedWidget().

◆ focuslost()

void focuslost ( )

overrideprotectedvirtual

This is called after the focus is lost.

This is called even if focus removal is forced.

Reimplemented from ComponentStackWidget.

References WidgetContainer::RemoveFocus().

◆ GetInteriorSize()

Geometry::Size GetInteriorSize ( ) const

overridevirtual

Should return the interior (usable) size of the container.

Implements WidgetContainer.

References basic_Bounds< T_ >::GetSize(), Layer::GetSize(), ComponentStackWidget::stack, ComponentStack::TagBounds(), and ComponentTemplate::ViewPortTag.

◆ getlayer()

Gorgon::Layer & getlayer ( )

overrideprotectedvirtual

Returns the layer that will be used to place the contained widgets.

Implements WidgetContainer.

References ComponentTemplate::ContentsTag, ComponentStack::GetLayerOf(), ComponentStack::IndexOfTag(), and ComponentStackWidget::stack.

◆ GetOverscroll()

int GetOverscroll ( ) const

Returns the amount of extra scrolling distance after the bottom-most widget is completely visible in pixels.

References Panel::overscroll.

◆ getparentfocusstrategy()

FocusStrategy getparentfocusstrategy ( ) const

overrideprotectedvirtual

If this widget is not top level, return the current strategy used by the parent.

Never return Inherit from this function.

Reimplemented from WidgetContainer.

References WidgetContainer::AllowAll, WidgetContainer::CurrentFocusStrategy(), Widget::GetParent(), and Widget::HasParent().

◆ GetScrollDistance()

Geometry::Point GetScrollDistance ( ) const

Returns the scroll distance per click.

References Panel::scrolldist.

◆ GetSmoothScrollSpeed()

int GetSmoothScrollSpeed ( ) const

Returns the smooth scrolling speed of the panel.

If smooth scroll is disabled, this value will be 0.

References Panel::scrollspeed.

◆ IsEnabled()

virtual bool IsEnabled ( ) const

overridevirtual

Returns whether the widget is enabled.

Reimplemented from ComponentStackWidget.

◆ IsHorizontalScrollEnabled()

bool IsHorizontalScrollEnabled ( ) const

Whether horizontal scrolling is enabled.

References Panel::hscroll.

◆ IsSmoothScrollEnabled()

bool IsSmoothScrollEnabled ( ) const

Returns if the smooth scroll is enabled.

References Panel::scrollspeed.

◆ IsVerticalScrollEnabled()

bool IsVerticalScrollEnabled ( ) const

Whether vertical scrolling is enabled.

References Panel::vscroll.

◆ IsVisible()

bool IsVisible ( ) const

overridevirtual

Should return whether the container is visible.

Due to different container designs and capabilities, setting visibility depends on the particular container

Implements WidgetContainer.

References Layer::IsVisible(), and ComponentStackWidget::stack.

◆ KeyEvent()

bool KeyEvent	(	Input::Key	key,
		float	state
	)

overridevirtual

This function should be called whenever a key is pressed or released.

Reimplemented from WidgetContainer.

References Gorgon::Input::Keyboard::Keycodes::Down, WidgetContainer::KeyEvent(), KeyRepeater::KeyEvent(), Panel::MaxScrollOffset(), Gorgon::Input::Keyboard::Keycodes::PageDown, Gorgon::Input::Keyboard::Keycodes::PageUp, Panel::repeater, Panel::ScrollOffset(), Gorgon::Input::Keyboard::Keycodes::Up, and Gorgon::Input::Keyboard::Keycodes::Y.

◆ MaxScrollOffset()

Geometry::Point MaxScrollOffset ( ) const

Returns the current maximum scroll offset.

References ComponentTemplate::ContentsTag, Panel::GetInteriorSize(), Panel::overscroll, ComponentStackWidget::stack, and ComponentStack::TagBounds().

◆ Move()

void Move ( const Geometry::Point & location )

overridevirtual

Moves this widget to the given position.

Reimplemented from ComponentStackWidget.

References WidgetContainer::Displaced(), and Gorgon::Input::Mouse::Move.

◆ parentenabledchanged()

virtual void parentenabledchanged ( bool state )

overrideprotectedvirtual

This function is called when the parent's enabled state changes.

Reimplemented from ComponentStackWidget.

References WidgetContainer::distributeparentenabled(), and Panel::IsEnabled().

◆ RequestExtender()

UI::ExtenderRequestResponse RequestExtender ( const Gorgon::Layer & self )

overridevirtual

This function will return a container that will act as an extender.

Implements WidgetContainer.

References ComponentTemplate::ContentsTag.

◆ Resize()

void Resize ( const Geometry::Size & size )

overridevirtual

Changes the size of the widget.

Reimplemented from ComponentStackWidget.

References Panel::childboundschanged(), WidgetContainer::GetOrganizer(), WidgetContainer::HasOrganizer(), Base::Reorganize(), and Gorgon::GL::Resize().

◆ ResizeInterior()

bool ResizeInterior ( Geometry::Size size )

overridevirtual

Should resize the interior (usable) size of the container.

If resize operation cannot set the size exactly to the requested size, this function returns false.

Implements WidgetContainer.

References ComponentTemplate::ContentsTag, basic_Bounds< T_ >::GetSize(), ComponentStackWidget::GetSize(), ComponentStackWidget::Resize(), ComponentStackWidget::stack, ComponentStack::TagBounds(), and ComponentTemplate::ViewPortTag.

◆ ScrollBy() [1/2]

void ScrollBy	(	int	x,
		int	y,
		bool	clip = `true`
	)

Scrolls the contents an additional amount.

References Panel::ScrollOffset(), Panel::ScrollTo(), Gorgon::Input::Keyboard::Keycodes::X, and Gorgon::Input::Keyboard::Keycodes::Y.

◆ ScrollBy() [2/2]

void ScrollBy	(	int	y,
		bool	clip = `true`
	)

Scrolls the contents an additional amount.

References Panel::ScrollOffset(), Panel::ScrollTo(), Gorgon::Input::Keyboard::Keycodes::X, and Gorgon::Input::Keyboard::Keycodes::Y.

◆ ScrollOffset()

Geometry::Point ScrollOffset ( ) const

Returns the current scroll offset.

References Panel::scrolloffset.

◆ ScrollTo() [1/3]

void ScrollTo	(	Geometry::Point	location,
		bool	clip = `false`
	)

Scrolls the contents of the panel so that the given location will be at the top left.

If clip is set, the scroll amount cannot go out of the scrolling region.

References basic_Point< T_ >::X, and basic_Point< T_ >::Y.

◆ ScrollTo() [2/3]

void ScrollTo	(	int	x,
		int	y,
		bool	clip = `true`
	)

Scrolls the contents of the panel so that the given location will be at the top left.

If clip is set, the scroll amount cannot go out of the scrolling region.

References ComponentTemplate::ContentsTag, Panel::isscrolling, Panel::MaxScrollOffset(), Panel::scrollclipped, Panel::scrolloffset, Panel::scrollspeed, ComponentStack::SetFrameEvent(), ComponentStack::SetTagLocation(), ComponentStack::SetValue(), ComponentStackWidget::stack, ComponentStack::TagBounds(), Panel::target, Panel::updatebars(), Panel::updatescroll(), basic_Point< T_ >::X, and basic_Point< T_ >::Y.

◆ ScrollTo() [3/3]

void ScrollTo	(	int	y,
		bool	clip = `true`
	)

Scrolls the contents of the panel so that the given location will be at the top.

References Panel::ScrollOffset(), Panel::ScrollTo(), and Gorgon::Input::Keyboard::Keycodes::X.

◆ scrolltox()

void scrolltox ( int x )

protected

References Panel::ScrollOffset(), Panel::ScrollTo(), and Gorgon::Input::Keyboard::Keycodes::Y.

◆ scrolltoy()

void scrolltoy ( int y )

protected

References Panel::ScrollTo().

◆ SetEnabled()

virtual void SetEnabled ( bool value )

overridevirtual

Sets the enabled state of the widget.

Reimplemented from ComponentStackWidget.

References WidgetContainer::distributeparentenabled(), and Panel::IsEnabled().

◆ SetOverscroll()

void SetOverscroll ( int value )

Sets the amount of extra scrolling distance after the bottom-most widget is completely visible in pixels.

Default is 0. Does not apply if everything is visible.

References Panel::overscroll, Panel::scrollclipped, Panel::ScrollOffset(), and Panel::ScrollTo().

◆ SetScrollDistance() [1/3]

void SetScrollDistance ( Geometry::Point dist )

Sets the scroll distance per click in pixels.

Default depends on the default size of the panel.

References Panel::scrolldist.

◆ SetScrollDistance() [2/3]

void SetScrollDistance	(	int	hor,
		int	vert
	)

Sets the scroll distance per click in pixels.

Default depends on the default size of the panel.

References Panel::SetScrollDistance().

◆ SetScrollDistance() [3/3]

void SetScrollDistance ( int vert )

Sets the horizontal scroll distance per click in pixels.

Default depends on the default size of the panel.

References Panel::scrolldist, and basic_Point< T_ >::Y.

◆ SetSmoothScrollSpeed()

void SetSmoothScrollSpeed ( int value )

Adjusts the smooth scrolling speed of the panel.

Given value is in pixels per second, default value is 250.

References ComponentTemplate::ContentsTag, basic_Bounds< T_ >::GetSize(), ComponentStack::GetWidget(), ComponentTemplate::HScrollTag, Panel::isscrolling, ComponentStack::RemoveFrameEvent(), Panel::scrollleftover, Panel::scrollspeed, Scrollbar< T_, DIV_, VAL_, P_, defaultregistry >::SetSmoothChangeSpeed(), ComponentStack::SetTagLocation(), ComponentStack::SetValueTransitionSpeed(), ComponentStackWidget::stack, ComponentStack::TagBounds(), Panel::target, and ComponentTemplate::VScrollTag.

◆ updatebars()

void updatebars ( )

protected

References ComponentTemplate::ContentsTag, Panel::GetInteriorSize(), ComponentStack::GetWidget(), basic_Size< T_ >::Height, ComponentTemplate::HScrollTag, Scrollbar< T_, DIV_, VAL_, P_, defaultregistry >::Maximum, ComponentStackWidget::stack, ComponentStack::TagBounds(), Panel::target, ComponentTemplate::VScrollTag, basic_Size< T_ >::Width, basic_Point< T_ >::X, and basic_Point< T_ >::Y.

◆ updatecontent()

void updatecontent ( )

protected

References Gorgon::Clamp(), ComponentTemplate::ContentsTag, Panel::GetInteriorSize(), ComponentStack::GetValue(), Panel::scrollclipped, Panel::ScrollOffset(), Panel::scrollspeed, Panel::ScrollTo(), Panel::SetSmoothScrollSpeed(), ComponentStack::SetTagSize(), ComponentStack::SetValue(), ComponentStackWidget::stack, Panel::updaterequired, and WidgetContainer::widgets.

◆ updatescroll()

void updatescroll ( )

protected

References Gorgon::Utils::ASSERT_FALSE(), ComponentTemplate::ContentsTag, Gorgon::Time::DeltaTime(), WidgetContainer::Displaced(), Panel::isscrolling, ComponentStack::RemoveFrameEvent(), Panel::scrollleftover, Panel::scrolloffset, Panel::scrollspeed, ComponentStack::SetTagLocation(), ComponentStackWidget::stack, ComponentStack::TagBounds(), Panel::target, basic_Bounds< T_ >::TopLeft(), Panel::updatebars(), basic_Point< T_ >::X, and basic_Point< T_ >::Y.

Member Data Documentation

◆ hscroll

bool hscroll

protected

◆ isscrolling

bool isscrolling

protected

◆ overscroll

int overscroll

protected

◆ repeater

Input::KeyRepeater repeater

protected

◆ scrollclipped

bool scrollclipped

protected

◆ scrolldist

Geometry::Point scrolldist

protected

◆ scrollleftover

float scrollleftover

protected

◆ scrolloffset

Geometry::Point scrolloffset

protected

◆ scrollspeed

int scrollspeed

protected

◆ target

Geometry::Point target

protected

◆ updaterequired

bool updaterequired

protected

◆ vscroll

bool vscroll

protected

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

Gorgon/Widgets/Panel.h
Gorgon/Widgets/Panel.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Panel() [1/3]

◆ Panel() [2/3]

◆ Panel() [3/3]

Member Function Documentation

◆ Activate()

◆ allowfocus()

◆ CharacterEvent()

◆ childboundschanged()

◆ createhscroll()

◆ createvscroll()

◆ DisableSmoothScroll()

◆ EnableScroll()

◆ EnsureVisible()

◆ focuschanged()

◆ focused()

◆ focuslost()

◆ GetInteriorSize()

◆ getlayer()

◆ GetOverscroll()

◆ getparentfocusstrategy()

◆ GetScrollDistance()

◆ GetSmoothScrollSpeed()

◆ IsEnabled()

◆ IsHorizontalScrollEnabled()

◆ IsSmoothScrollEnabled()

◆ IsVerticalScrollEnabled()

◆ IsVisible()

◆ KeyEvent()

◆ MaxScrollOffset()

◆ Move()

◆ parentenabledchanged()

◆ RequestExtender()

◆ Resize()

◆ ResizeInterior()

◆ ScrollBy() [1/2]

◆ ScrollBy() [2/2]

◆ ScrollOffset()

◆ ScrollTo() [1/3]

◆ ScrollTo() [2/3]

◆ ScrollTo() [3/3]

◆ scrolltox()

◆ scrolltoy()

◆ SetEnabled()

◆ SetOverscroll()

◆ SetScrollDistance() [1/3]

◆ SetScrollDistance() [2/3]

◆ SetScrollDistance() [3/3]

◆ SetSmoothScrollSpeed()

◆ updatebars()

◆ updatecontent()

◆ updatescroll()

Member Data Documentation

◆ hscroll

◆ isscrolling

◆ overscroll

◆ repeater

◆ scrollclipped

◆ scrolldist

◆ scrollleftover

◆ scrolloffset

◆ scrollspeed

◆ target

◆ updaterequired

◆ vscroll