TBrCtlSelectOptionData Class Reference

#include <mw/brctldialogsprovider.h>

class TBrCtlSelectOptionData

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()

Detailed Description

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

Constructor & Destructor Documentation

TBrCtlSelectOptionData ( )

TBrCtlSelectOptionData

(

)

[inline]

Default Constructor

Since: 2.8

Returns: TbrCtlSelectOptionData object

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

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

Constructor

Since: 2.8

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

Returns: TbrCtlSelectOptionData object

Member Function Documentation

HasOnPick ( )

TBool

HasOnPick

(

)

const [inline]

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

Since: 2.8

Returns: 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

IsOptGroup ( )

TBool

IsOptGroup

(

)

const [inline]

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

Since: 2.8

Returns: 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

IsSelected ( )

TBool

IsSelected

(

)

const [inline]

Indicates whether or not an option is selected.

Since: 2.8

Returns: ETrue if the option is selected EFalse if the option is not selected

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

Parameter	Description
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

Returns: None

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

Parameter	Description
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.

Returns: None

SetIsSelected ( TBool )

void

SetIsSelected

(

TBool

aIsSelected

)

[inline]

Sets the selection state of an option.

Since: 2.8

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

Returns: None

SetText ( TDesC & )

void

SetText

(

TDesC &

aText

)

[inline]

Sets the text of the option object.

Since: 2.8

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

Returns: None

Text ( )

const TDesC &

Text

(

)

const [inline]

Gets the display text associated with a specified option.

Since: 2.8

Returns: A reference to a Symbian TDesC object that contains the text associated with this option.