SGUIScrollBarStyle Struct Reference

The GUI Scroll-bar style. More...

#include <IGUIScrollBar.h>

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...
Horizontal 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
Vertical 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

Definition at line 57 of file IGUIScrollBar.h.

Member Data Documentation

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.

Definition at line 98 of file IGUIScrollBar.h.

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.

Definition at line 91 of file IGUIScrollBar.h.

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.

Definition at line 84 of file IGUIScrollBar.h.

float SGUIScrollBarStyle::m_ScrollSpeed

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

Definition at line 78 of file IGUIScrollBar.h.

bool SGUIScrollBarStyle::m_ScrollWheel

Scrollable with the wheel.

Definition at line 72 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBackHorizontal

Definition at line 136 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBackVertical

Definition at line 120 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarHorizontal

Definition at line 137 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVertical

Definition at line 116 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVerticalOver

Definition at line 117 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteBarVerticalPressed

Definition at line 118 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottom

Definition at line 111 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomDisabled

Definition at line 113 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomOver

Definition at line 114 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonBottomPressed

Definition at line 112 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeft

Definition at line 128 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeftDisabled

Definition at line 130 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonLeftPressed

Definition at line 129 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRight

Definition at line 132 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRightDisabled

Definition at line 134 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonRightPressed

Definition at line 133 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTop

Definition at line 106 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopDisabled

Definition at line 108 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopOver

Definition at line 109 of file IGUIScrollBar.h.

CGUISpriteInstance SGUIScrollBarStyle::m_SpriteButtonTopPressed

Definition at line 107 of file IGUIScrollBar.h.

float SGUIScrollBarStyle::m_Width

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

Definition at line 67 of file IGUIScrollBar.h.

---

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

• /home/sathyam/0ad.svn/source/gui/IGUIScrollBar.h