GuiOptionBrowser Class Reference

Display a list of menu options. More...

#include <gui_optionbrowser.h>

Inheritance diagram for GuiOptionBrowser:

Public Member Functions
	GuiOptionBrowser (int w, int h, OptionList *l)
	~GuiOptionBrowser ()
void	SetCol1Position (int x)
void	SetCol2Position (int x)
int	FindMenuItem (int c, int d)
int	GetClickedOption ()
void	ResetState ()
	Resets the element's state to STATE::DEFAULT. More...
void	SetFocus (int f)
void	Draw () override
void	TriggerUpdate ()
void	ResetText ()
	Called when the language has changed, to obtain new text values for all text elements. More...
void	Update (GuiTrigger *t)
Public Member Functions inherited from GuiElement
	GuiElement ()
	Constructor. More...
virtual	~GuiElement ()
	Destructor. More...
void	SetParent (GuiElement *e)
GuiElement *	GetParent ()
int	GetLeft ()
int	GetTop ()
void	SetMinY (int y)
int	GetMinY ()
void	SetMaxY (int y)
int	GetMaxY ()
void	SetMinX (int x)
int	GetMinX ()
void	SetMaxX (int x)
int	GetMaxX ()
int	GetWidth ()
int	GetHeight ()
void	SetSize (int w, int h)
bool	IsVisible ()
bool	IsSelectable ()
bool	IsClickable ()
bool	IsHoldable ()
void	SetSelectable (bool s)
void	SetClickable (bool c)
void	SetHoldable (bool h)
STATE	GetState ()
int	GetStateChan ()
void	SetAlpha (int a)
int	GetAlpha ()
void	SetScale (float s)
void	SetScaleX (float s)
void	SetScaleY (float s)
void	SetScale (int w, int h)
float	GetScale ()
float	GetScaleX ()
float	GetScaleY ()
void	SetTrigger (GuiTrigger *t)
void	SetTrigger (u8 i, GuiTrigger *t)
bool	Rumble ()
void	SetRumble (bool r)
void	SetEffect (int e, int a, int t=0)
void	SetEffectOnOver (int e, int a, int t=0)
void	SetEffectGrow ()
	Shortcut to SetEffectOnOver(EFFECT_SCALE, 4, 110)
int	GetEffect ()
bool	IsInside (int x, int y)
void	SetPosition (int x, int y)
void	UpdateEffects ()
void	SetUpdateCallback (UpdateCallback u)
int	IsFocused ()
virtual void	SetVisible (bool v)
virtual void	SetFocus (int f)
virtual void	SetState (STATE s, int c=-1)
virtual void	ResetState ()
	Resets the element's state to STATE::DEFAULT. More...
virtual int	GetSelected ()
virtual void	SetAlignment (ALIGN_H hor, ALIGN_V vert)
virtual void	ResetText ()
	Called when the language has changed, to obtain new text values for all text elements. More...
virtual void	Update (GuiTrigger *t)
virtual void	Draw ()=0
	Called constantly to redraw the element. More...
virtual void	DrawTooltip ()
	Called constantly to redraw the element's tooltip. More...

Public Attributes
GuiText *	optionVal [PAGESIZE]

Protected Attributes
int	optionIndex [PAGESIZE]
GuiButton *	optionBtn [PAGESIZE]
GuiText *	optionTxt [PAGESIZE]
GuiImage *	optionBg [PAGESIZE]
int	selectedItem
int	listOffset
OptionList *	options
GuiButton *	arrowUpBtn
GuiButton *	arrowDownBtn
GuiImage *	bgOptionsImg
GuiImage *	scrollbarImg
GuiImage *	arrowDownImg
GuiImage *	arrowDownOverImg
GuiImage *	arrowUpImg
GuiImage *	arrowUpOverImg
GuiImageData *	bgOptions
GuiImageData *	bgOptionsEntry
GuiImageData *	scrollbar
GuiImageData *	arrowDown
GuiImageData *	arrowDownOver
GuiImageData *	arrowUp
GuiImageData *	arrowUpOver
GuiSound *	btnSoundOver
GuiSound *	btnSoundClick
GuiTrigger *	trigA
GuiTrigger *	trig2
bool	listChanged
Protected Attributes inherited from GuiElement
GuiTrigger *	trigger [MAX_TRIGGERS]
	GuiTriggers (input actions) that this element responds to.
UpdateCallback	updateCB
	Callback function to call when this element is updated.
GuiElement *	parentElement
	Parent element.
int	focus
	Element focus (-1 = focus disabled, 0 = not focused, 1 = focused)
int	width
	Element width.
int	height
	Element height.
int	xoffset
	Element X offset.
int	yoffset
	Element Y offset.
int	ymin
	Element's min Y offset allowed.
int	ymax
	Element's max Y offset allowed.
int	xmin
	Element's min X offset allowed.
int	xmax
	Element's max X offset allowed.
int	xoffsetDyn
	Element X offset, dynamic (added to xoffset value for animation effects)
int	yoffsetDyn
	Element Y offset, dynamic (added to yoffset value for animation effects)
int	alpha
	Element alpha value (0-255)
int	alphaDyn
	Element alpha, dynamic (multiplied by alpha value for blending/fading effects)
f32	xscale
	Element X scale (1 = 100%)
f32	yscale
	Element Y scale (1 = 100%)
f32	scaleDyn
	Element scale, dynamic (multiplied by alpha value for blending/fading effects)
int	effects
	Currently enabled effect(s). 0 when no effects are enabled.
int	effectAmount
	Effect amount. Used by different effects for different purposes.
int	effectTarget
	Effect target amount. Used by different effects for different purposes.
int	effectsOver
	Effects to enable when wiimote cursor is over this element. Copied to effects variable on over event.
int	effectAmountOver
	EffectAmount to set when wiimote cursor is over this element.
int	effectTargetOver
	EffectTarget to set when wiimote cursor is over this element.
ALIGN_H	alignmentHor
	Horizontal element alignment, respective to parent element (LEFT, RIGHT, CENTRE)
ALIGN_V	alignmentVert
	Horizontal element alignment, respective to parent element (TOP, BOTTOM, MIDDLE)
STATE	state
	Element state (DEFAULT, SELECTED, CLICKED, DISABLED)
int	stateChan
	Which controller channel is responsible for the last change in state.
bool	selectable
	Whether or not this element selectable (can change to SELECTED state)
bool	clickable
	Whether or not this element is clickable (can change to CLICKED state)
bool	holdable
	Whether or not this element is holdable (can change to HELD state)
bool	visible
	Visibility of the element. If false, Draw() is skipped.
bool	rumble
	Wiimote rumble (on/off) - set to on when this element requests a rumble event.

Detailed Description

Display a list of menu options.

Constructor & Destructor Documentation

GuiOptionBrowser()

GuiOptionBrowser::GuiOptionBrowser	(	int	w,
		int	h,
		OptionList *	l
	)

Constructor for the GuiOptionBrowser class.

~GuiOptionBrowser()

GuiOptionBrowser::~GuiOptionBrowser

(

)

Destructor for the GuiOptionBrowser class.

Member Function Documentation

Draw()

void GuiOptionBrowser::Draw ( )

overridevirtual

Draw the button on screen

Implements GuiElement.

ResetState()

void GuiOptionBrowser::ResetState ( )

virtual

Resets the element's state to STATE::DEFAULT.

Reimplemented from GuiElement.

ResetText()

void GuiOptionBrowser::ResetText ( )

virtual

Called when the language has changed, to obtain new text values for all text elements.

Reimplemented from GuiElement.

SetFocus()

void GuiOptionBrowser::SetFocus ( int  f )

virtual

Sets the element's focus

Parameters

f	Focus (true = in focus)

Reimplemented from GuiElement.

Update()

void GuiOptionBrowser::Update ( GuiTrigger *  t )

virtual

Called constantly to allow the element to respond to the current input data

Parameters

t	Pointer to a GuiTrigger, containing the current input data from PAD/WPAD

Reimplemented from GuiElement.

---

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

• source/libwiigui/gui_optionbrowser.h
• source/libwiigui/gui_optionbrowser.cpp