Support Forum       G3D Web Page     
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
G3D::GuiScrollPane Class Reference


A conventional pane with scroll bars that allow the user to determine which part of the pane to view. More...

Inherits G3D::GuiContainer.

Public Types

enum  { CONTROL_HEIGHT = 25 }
 
enum  { CONTROL_WIDTH = 215 }
 
enum  { BUTTON_WIDTH = 80 }
 
enum  { TOOL_BUTTON_WIDTH = 50 }
 
enum  { CONTROL_PADDING = 4 }
 

Public Member Functions

 GuiScrollPane (GuiContainer *parent, bool verticalScroll, bool horizontalScroll, GuiTheme::ScrollPaneStyle style)
 
const GuiTextcaption () const
 
float captionHeight () const
 For controls that have a caption outside the bounds of the control on the top or bottom, this is the size reserved for the caption. More...
 
float captionWidth () const
 For controls that have a caption outside the bounds of the control on the left, this is the size reserved for the caption. More...
 
const Rect2DclickRect () const
 Used by GuiContainers. More...
 
const Rect2DclientRect () const
 Client rect bounds, relative to the parent (or window if there is no parent). More...
 
virtual float defaultCaptionHeight () const
 Default caption size for this control. More...
 
virtual float defaultCaptionWidth () const
 
bool enabled () const
 
virtual void findControlUnderMouse (Vector2 mouse, GuiControl *&control) override
 Return the enabled, visible control containing the mouse. More...
 
bool focused () const
 
Vector2 fromOSWindowCoords (const Vector2 &v) const
 Transforms v from OS window coordinates to this control's coordinates. More...
 
float horizontalOffset () const
 
virtual void increaseBounds (const Vector2 &extent)
 Updates this container to ensure that its client rect is least as wide and high as the specified extent, then recursively calls increaseBounds on its parent. More...
 
bool mouseOver () const
 
void moveBy (const Vector2 &delta)
 
void moveBy (float dx, float dy)
 
void moveRightOf (const GuiControl *control, const Vector2 &offset)
 If these two controls have the same parent, move this one immediately to the right of the argument. More...
 
void moveRightOf (const GuiControl *control, float offsetX=0.0f)
 
virtual bool onChildControlEvent (const GEvent &event)
 Invoked immediately (i.e., outside of the queue sequence) when a child fires an event through Widget::fireEvent. More...
 
virtual void pack ()
 
Vector2 paneOffset () const
 
const Rect2Drect () const
 
virtual void render (RenderDevice *rd, const shared_ptr< GuiTheme > &theme, bool ancestorsEnabled) const override
 
Only methods on theme may be called from this method by default. More...
 
virtual void setCaption (const GuiText &caption)
 
virtual void setCaptionHeight (float c)
 
virtual void setCaptionWidth (float c)
 
virtual void setEnabled (bool e)
 
void setEventSource (GuiControl *c)
 
void setFocused (bool b)
 Grab or release keyboard focus. More...
 
void setHeight (float h)
 
void setPosition (const Vector2 &v)
 
void setPosition (float x, float y)
 
virtual void setRect (const Rect2D &rect) override
 If you explicitly change the rectangle of a control, the containing pane may clip its borders. More...
 
void setSize (const Vector2 &v)
 
void setSize (float x, float y)
 
void setVisible (bool b)
 
void setWidth (float w)
 
shared_ptr< GuiThemetheme () const
 
virtual bool toolStyle () const
 Return true if this is in tool button style. More...
 
Vector2 toOSWindowCoords (const Vector2 &v) const
 Returns the coordinates of v, which is in the coordinate system of this object, relative to the OSWindow on which it will be rendered. More...
 
Rect2D toOSWindowCoords (const Rect2D &r) const
 
float verticalOffset () const
 
GuiPaneviewPane () const
 
bool visible () const
 
GuiWindowwindow () const
 Get the window containing this control. More...
 

Protected Types

enum  {
  LEFT_CAPTION_WIDTH = 80,
  TOP_CAPTION_HEIGHT = 20
}
 

Protected Member Functions

float borderDimensionsBump () const
 
float borderStartBump () const
 
void fireEvent (GEventType type)
 Fires an event. More...
 
virtual bool onEvent (const GEvent &event) override
 Events are only delivered (by GuiWindow) to a GuiControl when the control has the key focus. More...
 
float scrollBarDimesionsBump () const
 
float scrollBarStartBump () const
 

Protected Attributes

bool horizontalEnabled
 
GuiText m_caption
 
float m_captionHeight
 
float m_captionWidth
 
Rect2D m_clickRect
 Rect bounds used for mouse actions. More...
 
Rect2D m_clientRect
 Position to which all child controls are relative. More...
 
bool m_enabled
 
GuiControlm_eventSource
 Sent events should appear to be from this object, which is usually "this". More...
 
GuiWindowm_gui
 The window that ultimately contains this control. More...
 
float m_horizontalOffset
 
GuiScrollBarm_horizontalScrollBar
 
GuiContainerm_parent
 Parent pane. More...
 
Rect2D m_rect
 Rect bounds used for rendering and layout. More...
 
GuiTheme::ScrollPaneStyle m_style
 
float m_verticalOffset
 
GuiScrollBarm_verticalScrollBar
 
GuiPanem_viewPane
 
bool m_visible
 
bool verticalEnabled
 

Detailed Description


A conventional pane with scroll bars that allow the user to determine which part of the pane to view.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
CONTROL_HEIGHT 

◆ anonymous enum

anonymous enum
inherited
Enumerator
CONTROL_WIDTH 

◆ anonymous enum

anonymous enum
inherited
Enumerator
BUTTON_WIDTH 

◆ anonymous enum

anonymous enum
inherited
Enumerator
TOOL_BUTTON_WIDTH 

◆ anonymous enum

anonymous enum
inherited
Enumerator
CONTROL_PADDING 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
LEFT_CAPTION_WIDTH 
TOP_CAPTION_HEIGHT 

Constructor & Destructor Documentation

◆ GuiScrollPane()

G3D::GuiScrollPane::GuiScrollPane ( GuiContainer parent,
bool  verticalScroll,
bool  horizontalScroll,
GuiTheme::ScrollPaneStyle  style 
)

Member Function Documentation

◆ borderDimensionsBump()

float G3D::GuiScrollPane::borderDimensionsBump ( ) const
inlineprotected

◆ borderStartBump()

float G3D::GuiScrollPane::borderStartBump ( ) const
inlineprotected

◆ caption()

const GuiText& G3D::GuiControl::caption ( ) const
inherited

◆ captionHeight()

float G3D::GuiControl::captionHeight ( ) const
inherited

For controls that have a caption outside the bounds of the control on the top or bottom, this is the size reserved for the caption.

◆ captionWidth()

float G3D::GuiControl::captionWidth ( ) const
inherited

For controls that have a caption outside the bounds of the control on the left, this is the size reserved for the caption.

◆ clickRect()

const Rect2D& G3D::GuiControl::clickRect ( ) const
inlineinherited

Used by GuiContainers.

◆ clientRect()

const Rect2D& G3D::GuiContainer::clientRect ( ) const
inlineinherited

Client rect bounds, relative to the parent (or window if there is no parent).

◆ defaultCaptionHeight()

virtual float G3D::GuiControl::defaultCaptionHeight ( ) const
inlinevirtualinherited

Default caption size for this control.

Reimplemented in G3D::GuiFunctionBox.

◆ defaultCaptionWidth()

virtual float G3D::GuiControl::defaultCaptionWidth ( ) const
inlinevirtualinherited

◆ enabled()

bool G3D::GuiControl::enabled ( ) const
inherited

◆ findControlUnderMouse()

virtual void G3D::GuiScrollPane::findControlUnderMouse ( Vector2  mouse,
GuiControl *&  control 
)
overridevirtual

Return the enabled, visible control containing the mouse.

The default implementation returns itself if the mouse is within its bounds. GuiContainers should override this to iterate through children. Since only one (non-overlapping) child will write to control, it is sufficient to call this on all children without testing to see if one already wrote to control.

Reimplemented from G3D::GuiControl.

◆ fireEvent()

void G3D::GuiControl::fireEvent ( GEventType  type)
protectedinherited

Fires an event.

◆ focused()

bool G3D::GuiControl::focused ( ) const
inherited

◆ fromOSWindowCoords()

Vector2 G3D::GuiControl::fromOSWindowCoords ( const Vector2 v) const
inherited

Transforms v from OS window coordinates to this control's coordinates.

◆ horizontalOffset()

float G3D::GuiScrollPane::horizontalOffset ( ) const
inline

◆ increaseBounds()

virtual void G3D::GuiContainer::increaseBounds ( const Vector2 extent)
virtualinherited

Updates this container to ensure that its client rect is least as wide and high as the specified extent, then recursively calls increaseBounds on its parent.

Used during automatic layout sizing.

◆ mouseOver()

bool G3D::GuiControl::mouseOver ( ) const
inherited

◆ moveBy() [1/2]

void G3D::GuiControl::moveBy ( const Vector2 delta)
inherited

◆ moveBy() [2/2]

void G3D::GuiControl::moveBy ( float  dx,
float  dy 
)
inherited

◆ moveRightOf() [1/2]

void G3D::GuiControl::moveRightOf ( const GuiControl control,
const Vector2 offset 
)
inherited

If these two controls have the same parent, move this one immediately to the right of the argument.

Parameters
offsetMay be negative

Referenced by G3D::GuiControl::moveRightOf().

◆ moveRightOf() [2/2]

void G3D::GuiControl::moveRightOf ( const GuiControl control,
float  offsetX = 0.0f 
)
inlineinherited

◆ onChildControlEvent()

virtual bool G3D::GuiContainer::onChildControlEvent ( const GEvent event)
virtualinherited

Invoked immediately (i.e., outside of the queue sequence) when a child fires an event through Widget::fireEvent.

If this method returns true, the event is never submitted to the event queue. The default implementation passes the event to the GUI parent of this GuiContainer.

This enables creation of new custom controls by embedding other controls inside a GuiContainer; the container can suppress or watch the child control events in order to present its own behavior to its parent and the GuiWindow.

◆ onEvent()

virtual bool G3D::GuiScrollPane::onEvent ( const GEvent event)
inlineoverrideprotectedvirtual

Events are only delivered (by GuiWindow) to a GuiControl when the control has the key focus.

If the control does not consume the event, the event is delivered to each of its GUI parents in order, back to the window's root pane.

Key focus is transferred during a mouse down event.

Reimplemented from G3D::GuiControl.

◆ pack()

virtual void G3D::GuiScrollPane::pack ( )
virtual

◆ paneOffset()

Vector2 G3D::GuiScrollPane::paneOffset ( ) const
inline

◆ rect()

const Rect2D& G3D::GuiControl::rect ( ) const
inherited

◆ render()

virtual void G3D::GuiScrollPane::render ( RenderDevice rd,
const shared_ptr< GuiTheme > &  theme,
bool  ancestorsEnabled 
) const
overridevirtual


Only methods on theme may be called from this method by default.

To make arbitrary RenderDevice calls, wrap them in GuiTheme::pauseRendering ... GuiTheme::resumeRendering.

Parameters
ancestorsEnabledDraw as disabled if this is false or if enabled() is false.

Implements G3D::GuiControl.

◆ scrollBarDimesionsBump()

float G3D::GuiScrollPane::scrollBarDimesionsBump ( ) const
inlineprotected

◆ scrollBarStartBump()

float G3D::GuiScrollPane::scrollBarStartBump ( ) const
inlineprotected

◆ setCaption()

virtual void G3D::GuiControl::setCaption ( const GuiText caption)
virtualinherited

◆ setCaptionHeight()

virtual void G3D::GuiControl::setCaptionHeight ( float  c)
virtualinherited

◆ setCaptionWidth()

virtual void G3D::GuiControl::setCaptionWidth ( float  c)
virtualinherited

◆ setEnabled()

virtual void G3D::GuiControl::setEnabled ( bool  e)
virtualinherited

◆ setEventSource()

void G3D::GuiControl::setEventSource ( GuiControl c)
inlineinherited

◆ setFocused()

void G3D::GuiControl::setFocused ( bool  b)
inherited

Grab or release keyboard focus.

◆ setHeight()

void G3D::GuiControl::setHeight ( float  h)
inherited

◆ setPosition() [1/2]

void G3D::GuiControl::setPosition ( const Vector2 v)
inherited

◆ setPosition() [2/2]

void G3D::GuiControl::setPosition ( float  x,
float  y 
)
inherited

◆ setRect()

virtual void G3D::GuiScrollPane::setRect ( const Rect2D rect)
overridevirtual

If you explicitly change the rectangle of a control, the containing pane may clip its borders.

Call pack() on the containing pane (or window) to resize that container appropriately.

Reimplemented from G3D::GuiContainer.

◆ setSize() [1/2]

void G3D::GuiControl::setSize ( const Vector2 v)
inherited

◆ setSize() [2/2]

void G3D::GuiControl::setSize ( float  x,
float  y 
)
inherited

◆ setVisible()

void G3D::GuiControl::setVisible ( bool  b)
inherited

◆ setWidth()

void G3D::GuiControl::setWidth ( float  w)
inherited

◆ theme()

shared_ptr<GuiTheme> G3D::GuiControl::theme ( ) const
inherited

◆ toolStyle()

virtual bool G3D::GuiControl::toolStyle ( ) const
inlinevirtualinherited

Return true if this is in tool button style.

Reimplemented in G3D::GuiRadioButton, G3D::GuiButton, and G3D::GuiCheckBox.

◆ toOSWindowCoords() [1/2]

Vector2 G3D::GuiControl::toOSWindowCoords ( const Vector2 v) const
inherited

Returns the coordinates of v, which is in the coordinate system of this object, relative to the OSWindow on which it will be rendered.

Referenced by G3D::GuiControl::toOSWindowCoords().

◆ toOSWindowCoords() [2/2]

Rect2D G3D::GuiControl::toOSWindowCoords ( const Rect2D r) const
inlineinherited

◆ verticalOffset()

float G3D::GuiScrollPane::verticalOffset ( ) const
inline

◆ viewPane()

GuiPane* G3D::GuiScrollPane::viewPane ( ) const
inline

◆ visible()

bool G3D::GuiControl::visible ( ) const
inherited

◆ window()

GuiWindow* G3D::GuiControl::window ( ) const
inherited

Get the window containing this control.

Member Data Documentation

◆ horizontalEnabled

bool G3D::GuiScrollPane::horizontalEnabled
protected

◆ m_caption

GuiText G3D::GuiControl::m_caption
protectedinherited

◆ m_captionHeight

float G3D::GuiControl::m_captionHeight
protectedinherited

◆ m_captionWidth

float G3D::GuiControl::m_captionWidth
protectedinherited

◆ m_clickRect

Rect2D G3D::GuiControl::m_clickRect
protectedinherited

Rect bounds used for mouse actions.

Updated by setRect.

Referenced by G3D::GuiControl::clickRect().

◆ m_clientRect

Rect2D G3D::GuiContainer::m_clientRect
protectedinherited

Position to which all child controls are relative.

Referenced by G3D::GuiContainer::clientRect(), G3D::GuiNumberBox< int >::findControlUnderMouse(), and G3D::GuiNumberBox< int >::render().

◆ m_enabled

bool G3D::GuiControl::m_enabled
protectedinherited

◆ m_eventSource

GuiControl* G3D::GuiControl::m_eventSource
protectedinherited

Sent events should appear to be from this object, which is usually "this".

Other controls can set the event source to create compound controls that seem atomic from the outside.

Referenced by G3D::GuiSlider< int >::GuiSlider(), G3D::GuiNumberBox< Value >::MyTextBox::MyTextBox(), and G3D::GuiControl::setEventSource().

◆ m_gui

GuiWindow* G3D::GuiControl::m_gui
protectedinherited

The window that ultimately contains this control.

◆ m_horizontalOffset

float G3D::GuiScrollPane::m_horizontalOffset
protected

Referenced by horizontalOffset(), and paneOffset().

◆ m_horizontalScrollBar

GuiScrollBar* G3D::GuiScrollPane::m_horizontalScrollBar
protected

◆ m_parent

GuiContainer* G3D::GuiControl::m_parent
protectedinherited

Parent pane.

◆ m_rect

Rect2D G3D::GuiControl::m_rect
protectedinherited

Rect bounds used for rendering and layout.

Relative to the enclosing pane's clientRect.

Referenced by G3D::GuiControl::findControlUnderMouse(), G3D::GuiNumberBox< int >::render(), G3D::GuiNumberBox< int >::setCaption(), and G3D::GuiNumberBox< int >::setRect().

◆ m_style

GuiTheme::ScrollPaneStyle G3D::GuiScrollPane::m_style
protected

◆ m_verticalOffset

float G3D::GuiScrollPane::m_verticalOffset
protected

Referenced by paneOffset(), and verticalOffset().

◆ m_verticalScrollBar

GuiScrollBar* G3D::GuiScrollPane::m_verticalScrollBar
protected

◆ m_viewPane

GuiPane* G3D::GuiScrollPane::m_viewPane
protected

Referenced by viewPane().

◆ m_visible

bool G3D::GuiControl::m_visible
protectedinherited

◆ verticalEnabled

bool G3D::GuiScrollPane::verticalEnabled
protected

documentation generated on Wed Nov 24 2021 08:01:56 using doxygen 1.8.15