Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | List of all members
SGUIScrollBarStyle Struct Reference

The GUI Scroll-bar style. More...

#include <IGUIScrollBar.h>

Collaboration diagram for SGUIScrollBarStyle:
Collaboration graph
[legend]

Public Member Functions

 NONCOPYABLE (SGUIScrollBarStyle)
 
 MOVABLE (SGUIScrollBarStyle)
 
 SGUIScrollBarStyle ()=default
 

Public Attributes

General Settings
float m_Width
 Width of bar, also both sides of the edge buttons. More...
 
bool m_ScrollWheel
 Scrollable with the wheel. More...
 
float m_ScrollSpeed
 How much (in percent, 0.1f = 10%) to scroll each time the wheel is admitted, or the buttons are pressed. More...
 
bool m_ScrollButtons
 Whether or not the edge buttons should appear or not. More...
 
float m_MinimumBarSize
 Sometimes there is a lot to scroll, but to prevent the scroll "bar" from being almost invisible (or ugly), you can set a minimum in pixel size. More...
 
float m_MaximumBarSize
 Sometimes you would like your scroll bar to have a fixed maximum size so that the texture does not get too stretched, you can set a maximum in pixels. More...
 
bool m_UseEdgeButtons
 True if you want edge buttons, i.e. More...
 
Vertical Sprites
CGUISpriteInstance m_SpriteButtonTop
 
CGUISpriteInstance m_SpriteButtonTopPressed
 
CGUISpriteInstance m_SpriteButtonTopDisabled
 
CGUISpriteInstance m_SpriteButtonTopOver
 
CGUISpriteInstance m_SpriteButtonBottom
 
CGUISpriteInstance m_SpriteButtonBottomPressed
 
CGUISpriteInstance m_SpriteButtonBottomDisabled
 
CGUISpriteInstance m_SpriteButtonBottomOver
 
CGUISpriteInstance m_SpriteBarVertical
 
CGUISpriteInstance m_SpriteBarVerticalOver
 
CGUISpriteInstance m_SpriteBarVerticalPressed
 
CGUISpriteInstance m_SpriteBackVertical
 
Horizontal Sprites
CGUISpriteInstance m_SpriteButtonLeft
 
CGUISpriteInstance m_SpriteButtonLeftPressed
 
CGUISpriteInstance m_SpriteButtonLeftDisabled
 
CGUISpriteInstance m_SpriteButtonRight
 
CGUISpriteInstance m_SpriteButtonRightPressed
 
CGUISpriteInstance m_SpriteButtonRightDisabled
 
CGUISpriteInstance m_SpriteBackHorizontal
 
CGUISpriteInstance m_SpriteBarHorizontal
 

Detailed Description

The GUI Scroll-bar style.

Tells us how scroll-bars look and feel.

A scroll-bar style can choose whether to support horizontal, vertical or both.

See also
IGUIScrollBar

Constructor & Destructor Documentation

◆ SGUIScrollBarStyle()

SGUIScrollBarStyle::SGUIScrollBarStyle ( )
default

Member Function Documentation

◆ MOVABLE()

SGUIScrollBarStyle::MOVABLE ( SGUIScrollBarStyle  )

◆ NONCOPYABLE()

SGUIScrollBarStyle::NONCOPYABLE ( SGUIScrollBarStyle  )

Member Data Documentation

◆ m_MaximumBarSize

float SGUIScrollBarStyle::m_MaximumBarSize

Sometimes you would like your scroll bar to have a fixed maximum size so that the texture does not get too stretched, you can set a maximum in pixels.

◆ m_MinimumBarSize

float SGUIScrollBarStyle::m_MinimumBarSize

Sometimes there is a lot to scroll, but to prevent the scroll "bar" from being almost invisible (or ugly), you can set a minimum in pixel size.

◆ m_ScrollButtons

bool SGUIScrollBarStyle::m_ScrollButtons

Whether or not the edge buttons should appear or not.

Sometimes you actually don't want them, like perhaps in a combo box.

◆ m_ScrollSpeed

float SGUIScrollBarStyle::m_ScrollSpeed

How much (in percent, 0.1f = 10%) to scroll each time the wheel is admitted, or the buttons are pressed.

◆ m_ScrollWheel

bool SGUIScrollBarStyle::m_ScrollWheel

Scrollable with the wheel.

◆ m_SpriteBackHorizontal

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBackHorizontal

◆ m_SpriteBackVertical

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBackVertical

◆ m_SpriteBarHorizontal

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarHorizontal

◆ m_SpriteBarVertical

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVertical

◆ m_SpriteBarVerticalOver

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVerticalOver

◆ m_SpriteBarVerticalPressed

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVerticalPressed

◆ m_SpriteButtonBottom

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottom

◆ m_SpriteButtonBottomDisabled

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomDisabled

◆ m_SpriteButtonBottomOver

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomOver

◆ m_SpriteButtonBottomPressed

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomPressed

◆ m_SpriteButtonLeft

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeft

◆ m_SpriteButtonLeftDisabled

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeftDisabled

◆ m_SpriteButtonLeftPressed

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeftPressed

◆ m_SpriteButtonRight

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRight

◆ m_SpriteButtonRightDisabled

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRightDisabled

◆ m_SpriteButtonRightPressed

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRightPressed

◆ m_SpriteButtonTop

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTop

◆ m_SpriteButtonTopDisabled

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopDisabled

◆ m_SpriteButtonTopOver

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopOver

◆ m_SpriteButtonTopPressed

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopPressed

◆ m_UseEdgeButtons

bool SGUIScrollBarStyle::m_UseEdgeButtons

True if you want edge buttons, i.e.

buttons that can be pressed in order to scroll.

◆ m_Width

float SGUIScrollBarStyle::m_Width

Width of bar, also both sides of the edge buttons.

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