TBrCtlSelectOptionData Class Reference

API published in: S60 2nd Ed FP 3

Link against: browserengine.lib

Capability Information

Required Capabilities

None

Exceptions

NetworkServices capability is required for any operation that results in loading content from the network. For example, calling LoadUrlL() with a url parameter that refers to a network location requires NetworkServices capability if the content is not available from the cache or if the specified cache mode prevents loading the cached version.

#include <brctldialogsprovider.h>

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>
 
 
 @file BrCtlDialogsProvider.h


Public Member Functions
	TBrCtlSelectOptionData ()
	Default Constructor.
	TBrCtlSelectOptionData (const TDesC &aText, TBool aIsSelected, TBool aIsOptGroup, TBool aHasOnPick)
	Constructor.
const TDesC &	Text () const
	Gets the display text associated with a specified option.
TBool	IsSelected () const
	Indicates whether or not an option is selected.
TBool	IsOptGroup () const
	Indicates whether an option group member variable is a group title or a selectable option.
TBool	HasOnPick () const
	Indicates whether or not the dialog closes when an option is selected.
void	SetText (TDesC &aText)
	Sets the text of the option object.
void	SetIsSelected (TBool aIsSelected)
	Sets the selection state of an option.
void	SetIsOptGroup (TBool aIsOptGroup)
	Sets the state of the option group member variable.
void	SetHasOnPick (TBool aHasOnPick)
	Sets the state of the hasOnPick member variable.

Constructor & Destructor Documentation

TBrCtlSelectOptionData::TBrCtlSelectOptionData ( ) [inline]

Default Constructor.

Returns:: TbrCtlSelectOptionData object

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

Constructor.

Parameters:

	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

TBool TBrCtlSelectOptionData::HasOnPick ( ) const [inline]

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

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

TBool TBrCtlSelectOptionData::IsOptGroup ( ) const [inline]

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

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

TBool TBrCtlSelectOptionData::IsSelected ( ) const [inline]

Indicates whether or not an option is selected.

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

void TBrCtlSelectOptionData::SetHasOnPick ( TBool aHasOnPick ) [inline]

Sets the state of the hasOnPick member variable.

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

Parameters:

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

void TBrCtlSelectOptionData::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.

Parameters:

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

void TBrCtlSelectOptionData::SetIsSelected ( TBool aIsSelected ) [inline]

Sets the selection state of an option.

Parameters:

aIsSelected

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

Returns:: None

void TBrCtlSelectOptionData::SetText ( TDesC & aText ) [inline]

Sets the text of the option object.

Parameters:

aText

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

Returns:: None

const TDesC& TBrCtlSelectOptionData::Text ( ) const [inline]

Gets the display text associated with a specified option.

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

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

brctldialogsprovider.h

TBrCtlSelectOptionData Class Reference

Capability Information

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation