0 A.D.: CGUIScrollBarVertical

Overview

Project

Class

Tree

Deprecated

Index

0 A.D.

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gui
Class CGUIScrollBarVertical

IGUIScrollBar
   |
   +--CGUIScrollBarVertical

in CGUIScrollBarVertical.h
in CGUIScrollBarVertical.cpp

class CGUIScrollBarVertical
extends IGUIScrollBar

Vertical implementation of IGUIScrollBar

See Also:: IGUIScrollBar

Field Summary
`protected bool`	`m_RightAligned` Should the scroll bar proceed to the left or to the right of the m_X value.

Fields inherited from class IGUIScrollBar

m_UseEdgeButtons, m_Width, m_X, m_Y, m_Z, m_Length, m_ScrollRange, m_ScrollSpace, m_BarSize, m_ScrollBarStyle, m_pStyle, m_pHostObject, m_pGUI, m_BarPressedAtPos, m_BarPressed, m_BarHovered, m_ButtonPlusHovered, m_ButtonMinusHovered, m_ButtonPlusPressed, m_ButtonMinusPressed, m_Pos, m_PosWhenPressed

Constructor Summary
`CGUIScrollBarVertical()`
`virtual ~CGUIScrollBarVertical()`

Method Summary
`virtual void`	`Draw()` Draw the scroll-bar
`virtual CRect`	`GetBarRect() const` Get the rectangle of the actual BAR.
`virtual CRect`	`GetOuterRect() const` Get the rectangle of the outline of the scrollbar, every component of the scroll-bar should be inside this area.
`virtual void`	`HandleMessage( const SGUIMessage& Message )` If an object that contains a scrollbar has got messages, send them to the scroll-bar and it will see if the message regarded itself.
`virtual bool`	`HoveringButtonMinus( const CPos& mouse )`
`virtual bool`	`HoveringButtonPlus( const CPos& mouse )`
`virtual void`	`SetPosFromMousePos( const CPos& mouse )` Set m_Pos with g_mouse_x/y input, i.
`void`	`SetRightAligned( const bool& align )` Set Right Aligned

Methods inherited from class IGUIScrollBar

SetupBarSize, GetStyle, GetGUI, UpdatePosBoundaries, HandleMessage, Draw, SetPosFromMousePos, HoveringButtonMinus, HoveringButtonPlus, GetPos, SetPos, ScrollPlus, ScrollMinus, ScrollPlusPlenty, ScrollMinusPlenty, SetHostObject, SetGUI, SetWidth, SetX, SetY, SetZ, SetLength, SetScrollRange, SetScrollSpace, SetBarPressed, SetUseEdgeButtons, SetScrollBarStyle, GetBarRect, GetOuterRect

Field Detail

m_RightAligned

protected bool m_RightAligned;

Should the scroll bar proceed to the left or to the right of the m_X value. Notice, this has nothing to do with where the owner places it.

Constructor Detail

CGUIScrollBarVertical

public CGUIScrollBarVertical();

~CGUIScrollBarVertical

public virtual ~CGUIScrollBarVertical();

Method Detail

Draw

public virtual void Draw();

Draw the scroll-bar

GetBarRect

public virtual CRect GetBarRect() const;

Get the rectangle of the actual BAR.

GetOuterRect

public virtual CRect GetOuterRect() const;

Get the rectangle of the outline of the scrollbar, every component of the scroll-bar should be inside this area.

HandleMessage

public virtual void HandleMessage( const SGUIMessage& Message );

If an object that contains a scrollbar has got messages, send them to the scroll-bar and it will see if the message regarded itself.

HoveringButtonMinus

public virtual bool HoveringButtonMinus( const CPos& mouse );

See Also:: IGUIScrollBar::HoveringButtonMinus

HoveringButtonPlus

public virtual bool HoveringButtonPlus( const CPos& mouse );

See Also:: IGUIScrollBar::HoveringButtonPlus

SetPosFromMousePos

public virtual void SetPosFromMousePos( const CPos& mouse );

Set m_Pos with g_mouse_x/y input, i.e. when draggin.

SetRightAligned

public void SetRightAligned( const bool& align );

Set Right Aligned