Inheritance diagram for GUI_ScrollBar:

Public Member Functions
	GUI_ScrollBar (RECT _rect, int _id, GUI_ElementStyle *_style)

void	DrawMe (SURFHANDLE _tgt, int xoffset, int yoffset, RECT &drawablerect)
	Draws this element. More...

void	SetScrollRange (int range)
	Sets the scrollrange of the scrollbar. More...

void	SetScrollSpeed (UINT speed)
	Sets the scroll speed of the scrollbar. More...

int	GetScrollPos ()

Public Member Functions inherited from GUI_BaseElement
	GUI_BaseElement (RECT _rect, int _id, GUI_ElementStyle *_style)

virtual void	Draw (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
	Draws the element and its children to a SURFHANDLE. More...

virtual bool	Update ()
	Checks if this element or any of its children need to be redrawn. More...

int	ProcessMouse (GUI_MOUSE_EVENT _event, int _x, int _y)
	Checks if the element or any of its children have been clicked. More...

virtual void	AddChild (GUI_BaseElement *child)
	Adds a child to this element. More...

void	GetRect (RECT &mRect)
	Copies the elements rect to the passed reference. More...

GUI_ElementStyle *	GetStyle ()

int	GetWidth ()

int	GetHeight ()

int	GetId ()

GUI_ELEMENT_TYPE	GetType ()

virtual void	SetVisible (bool _visible)
	Sets if the elements and its children are drawn or not. More...

bool	GetVisible ()

virtual void	SetFixed (bool fixed)

bool	GetFixed ()

virtual void	SetNoBlit (bool noblit)

bool	GetNoBlit ()

SURFHANDLE	GetSurface ()

void	AddPlugin (GUIplugin *plugin)
	Adds a GUIplugin as a child of this element. More...

void	RemovePlugin (GUIplugin *plugin)
	Unplugs a plugin from this element. More...

Private Member Functions
void	createScrollBar ()
	Draws the scrollbar to its source surface.

bool	ProcessMe (GUI_MOUSE_EVENT _event, int _x, int _y)
	Processes events for this element. More...

Private Attributes
int	scrollpos = 0
	Stores the current scrollposition of the scrollbar.

int	scrollrange = 0
	Stores the scrollrange of the scrollbar.

int	scrollspeed = 1
	Stores the scrollspeed of the scrollbar.

Additional Inherited Members
Protected Member Functions inherited from GUI_BaseElement
virtual void	DrawChildren (SURFHANDLE _tgt, RECT &drawablerect, int xoffset=0, int yoffset=0)
	Draws all direct children of this element, and tells them to draw theirs. More...

virtual int	ProcessChildren (GUI_MOUSE_EVENT _event, int _x, int _y)
	Forwards event to its children. More...

virtual bool	updateMe ()
	used for checking whether this element needs a redraw although it didn't have any user input More...

virtual bool	updateChildren ()
	checks if any of the children need a redraw More...

void	calculateBlitData (int xoffset, int yoffset, RECT &drawablerect, BLITDATA &OUT_blitdata)
	Calculates the positional and dimensional data needed for blitting, both for source as well as target surface. More...

void	calculateMyDrawableRect (RECT &drawablerect_parent, int xoffset, int yoffset, RECT &OUT_mydrawablerect)
	calculates the real drawable rect of this element considering the drawable rect of the parent. More...

Protected Attributes inherited from GUI_BaseElement
GUI_ELEMENT_TYPE	type
	The type of this element.

RECT	rect
	Rect the element should draw on, relative to parent.

int	width
	The width of the element.

int	height
	The height of the element.

int	id
	The locally unique identifier of the element.

SURFHANDLE	src = NULL
	Source surface to draw the element on. When the element is drawn on the panel, it will be blitted from this surface.

bool	noBlitting = false
	Some elements might not have to blit themselves because they are static part of the background. This is not the same as !visible, as the element still processes events and still draws children, it just doesn't draw itself.

vector< GUI_BaseElement * >	children
	List containing all direct children of this element.

vector< GUIplugin * >	plugins
	List containing all GUIplugins currently pluged into this element.

GUI_font *	font
	The font used by this element.

GUI_ElementStyle *	style
	The style used by this element.

bool	visible
	Whether the element is visible or not (if false, element and any of its children will neither draw nor process events)

bool	isfixed = false
	Whether the element retains a fixed position in a scrolling frame.

Detailed Description

A simple scrollbar element

This is rarely used in code directly. The more common approach is for Elements that need one to create it themselves and add it to their children.

Constructor & Destructor Documentation

GUI_ScrollBar::GUI_ScrollBar	(	RECT	_rect,
		int	_id,
		GUI_ElementStyle *	_style
	)

Parameters

_rect	Parent-relative position and dimensions
_id	Identifier of the element, locally unique to the containing GUIentity
_style	The style to render the checkbox in

Member Function Documentation

void GUI_ScrollBar::DrawMe	(	SURFHANDLE	_tgt,
		int	xoffset,
		int	yoffset,
		RECT &	drawablerect
	)

virtual

Draws this element.

Separated from DrawChildren so it can be freely overloaded

Parameters

_tgt	The target surface to draw to
xoffset	The offset between this element rects left edge and the left panel edge, in pixel
yoffset	The offset between this element rects top edge and the top panel edge, in pixel
drawablerect	The total drawable rect of this element. Serves as clipping rect.

Reimplemented from GUI_BaseElement.

int GUI_ScrollBar::GetScrollPos ( )

inline

Returns: the current position of the scrollbar

Note: scrollposition is between 0 (all the way up) and scrollrange (all the way down)

bool GUI_ScrollBar::ProcessMe	(	GUI_MOUSE_EVENT	_event,
		int	_x,
		int	_y
	)

privatevirtual

Processes events for this element.

Separated from ProcessChildren() so either can be freely overloaded without the other

Parameters

_event	The mouse event that triggered the call
_x	the x coordinate of the click, relative to the panel
_y	the y coordinate of the click, relative to the panel

Returns: True if this element has consumed the event

Reimplemented from GUI_BaseElement.

void GUI_ScrollBar::SetScrollRange ( int range )

inline

Sets the scrollrange of the scrollbar.

Parameters

range Scrollrange in pixel.

void GUI_ScrollBar::SetScrollSpeed ( UINT speed )

inline

Sets the scroll speed of the scrollbar.

Parameters

speed Scrollspeed in pixel per frame

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

C:/Orbiter2016/Orbitersdk/IMS2/GUI_ScrollBar.h
C:/Orbiter2016/Orbitersdk/IMS2/GUI_ScrollBar.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation