Collapse all Symbian^3 Product Developer Library

TBrCtlSelectOptionData Class Reference

class TBrCtlSelectOptionData

The TBrCtlSelectOptionData class represents a list of elements to display in the list box. This class is used for the List Selection Dialog.

  #include <brctldialogsprovider.h>
 @lib BrowserEngine.lib
 @since 2.8
 @file brctldialogsprovider.h

Public Member Functions
	TBrCtlSelectOptionData()
	TBrCtlSelectOptionData(const TDesC &, TBool, TBool, TBool)
TBool	HasOnPick()
TBool	IsOptGroup()
TBool	IsSelected()
void	SetHasOnPick(TBool)
void	SetIsOptGroup(TBool)
void	SetIsSelected(TBool)
void	SetText(TDesC &)
const TDesC &	Text()

Private Attributes
TBool	iHasOnPick
TBool	iIsOptGroup
TBool	iIsSelected
TPtrC	iText

Constructor & Destructor Documentation

TBrCtlSelectOptionData()

TBrCtlSelectOptionData

(

)

[inline]

Default Constructor

Since: 2.8

TBrCtlSelectOptionData(const TDesC &, TBool, TBool, TBool)

TBrCtlSelectOptionData	(	const TDesC &	aText,
		TBool	aIsSelected,
		TBool	aIsOptGroup,
		TBool	aHasOnPick
	)	[inline]

Constructor

Since: 2.8

Parameters

const TDesC & aText	The text to display with this element
TBool aIsSelected	If the element is selected
TBool aIsOptGroup	If a title of option group or an element
TBool aHasOnPick	If has onPick, The dialog should close when the element is selected

Member Functions Documentation

HasOnPick()

TBool

HasOnPick

(

)

const [inline]

Indicates whether or not the dialog closes when an option is selected.

Since: 2.8

IsOptGroup()

TBool

IsOptGroup

(

)

const [inline]

Indicates whether an option group member variable is a group title or a selectable option.

Since: 2.8

IsSelected()

TBool

IsSelected

(

)

const [inline]

Indicates whether or not an option is selected.

Since: 2.8

SetHasOnPick(TBool)

void

SetHasOnPick

(

TBool

aHasOnPick

)

[inline]

Sets the state of the hasOnPick member variable. Indicates whether or not the dialog closes when an option is selected.

Since: 2.8

Parameters

TBool aHasOnPick

ETrue if the dialog closes when the element is selected. This is known as having OnPick capability. EFalse if the dialog does not close when the element is selected

SetIsOptGroup(TBool)

void

SetIsOptGroup

(

TBool

aIsOptGroup

)

[inline]

Sets the state of the option group member variable. Indicates whether an option group member variable is a group title or a selectable option.

Since: 2.8

Parameters

TBool aIsOptGroup

The state of the option group. Value: ETrue if the listed item is the title of an option group. EFalse if the listed item is one of the options from which to select.

SetIsSelected(TBool)

void

SetIsSelected

(

TBool

aIsSelected

)

[inline]

Sets the selection state of an option.

Since: 2.8

Parameters

TBool aIsSelected

The state of the IsSelected member variable. Value: ETrue if the option is selected EFalse if the option is not selected

SetText(TDesC &)

void

SetText

(

TDesC &

aText

)

[inline]

Sets the text of the option object.

Since: 2.8

Parameters

TDesC & aText

A reference to a TDesC object that contains the text to associate with a particular option.

Text()

const TDesC &

Text

(

)

const [inline]

Gets the display text associated with a specified option.

Since: 2.8

Member Data Documentation

TBool iHasOnPick

TBool

iHasOnPick

[private]

TBool iIsOptGroup

TBool

iIsOptGroup

[private]

TBool iIsSelected

TBool

iIsSelected

[private]

TPtrC iText

TPtrC

iText

[private]