CAknSearchField Class Reference

Search field style.

Enumerator:

ESearch	Use only ESearch in Series 60.
EInput	(Not used)
EUrl	(Not used)
EPhone	(Not used)
EPlain	(Not used)
EPopup	Use as popup search field.
EPinb	Use as pinb search field.
EClockApp	For Clock application/list_single_heading_pane.
EFixed	Same as ESearch, but using CreateWindowL().
ESearchWithoutLine	Layout where no line is used.
EPopupWindow	Popup window layout.
EAdaptiveSearch	Since: 5.0
EAdaptive	Since: 5.0
EPopupAdaptiveSearch	Since: 5.0
EPopupAdaptiveSearchWindow	Since: 5.0

Destructor.

Returns information whether adaptive search is enabled or not.

Since:

5.0

Returns:

ETrue if adaptive search is enabled, EFalse otherwise.

Adds an adaptive search text observer.

Duplicates are not checked (i.e. adding the same observer multiple times is not prevented).

Since:

5.0

Parameters:

aObserver

Must be non-NULL.

Calls editor's ClipboardL() function.

Parameters:

aClipboardFunc

Clipboard function.

Access to the edwin owned by the search field.

Since:

Series 60 2.6

Returns:

Reference to the edwin owned by the search field.

Returns the text of search field by writing it into the buffer aSearchTxt.

Parameters:

aSearchTxt

Reference to the text buffer. Buffer size must be same or greater than maximum text length, which is given in constructor.

From MCoeControlObserver, Acts upon changes in the hosted control's state.

This class's implementation is trivial and should be able to be safely re-implemented in directly client-derived classes. For non-base setting page classes, a call to the base class should be made.

Parameters:

	aControl	Control that caused the event. (not used in default implementation)
	aEventType	Type of the event.

Handle HW keyboard active/deactive event.

Since:

5.0

From CCoeControl, Handles pointer event.

Since:

5.0

Parameters:

aPointerEvent

The pointer event. Invert adaptive search grid by tapping search field.

Indicates that is the control popup or not.

Since:

Series 60 2.6

Returns:

ETrue if it is a popup, EFalse if not.

Notify client if input language changed in settings, for adaptive search.

Since:

5.0

Returns:

ETrue if language has changed, EFalse otherwise.

Send column filter flag for adaptive search grid.

Since:

5.0

Returns:

aFlag The bit flag shows which columns take into account during filtering.

Sets this control as visible or invisible.

Since:

S60 3.2

Parameters:

aVisible

ETrue to make the control visible, EFalse to make it invisible.

From CCoeControl, Returns minimum size.

Minimum size depends on zoom factor.

Returns:

Minimum size.

Two-phased constructor.

Parameters:

	aParent	Reference to parent control.
	aFieldStyle	Defines the UI style.
	aIcon	A pointer to the icon to be shown in the search box frame. Takes ownerships. Can be NULL.
	aTextLimit	Defines the maximum text length.

Returns:

A pointer to contructed CAknSearchField object.

From CCoeControl, Handles key event.

Parameters:

	aKeyEvent	The key event.
	aType	The type of the event.

Returns:

Indicates whether the key event was used by this control or not.

Returns index, where listbox focus should return when popup findbox is canceled.

Since:

Series 60 3.1

Removes an adaptive search text observer.

Since:

5.0

Parameters:

aObserver

The observer to be removed.

Returns:

ETrue if removal ok, EFalse if observer was not removed (not found from the list of observers).

Clears text in the search field.

Return search field style.

Since:

5.0

Returns:

style of search field

Selects the whole search text.

Set adaptive search grid characters.

Since:

5.0

Parameters:

aGridChars

The characters for adaptive search grid.

Sets additional info text to the search field.

Parameters:

aText

Reference to the text buffer.

Set the language changed flag, for adaptive search.

Since:

5.0

Parameters:

aLanguageChanged

ETrue if language has changed, EFalse otherwise.

Sets position of the line on main pane.

Since:

Series 60 2.0

Parameters:

aLinePos

The position as defined in TAknSeparatorLinePos

Sets a list box for this control.

Since:

Series 60 2.6

Parameters:

aListBox

A pointer to a list box object.

Set column filter flag for adaptive search grid.

Since:

5.0

Parameters:

aFlag

The bit flag shows which columns take into account during filtering.

Sets index, where listbox focus should return when popup findbox is canceled.

Since:

Series 60 3.1

Sets the parent control for this control.

Since:

Series 60 2.6

Parameters:

aParent

A pointer to the parent control.

Sets text into search field.

Parameters:

aSearchTxt

Reference to the text buffer.

Sets whether skins are enabled on this control.

The default value is determined from global setting from CAknAppUi.

Since:

Series 60 2.0

Parameters:

aEnabled

ETrue if skins are enabled, EFalse if not.

Show adaptive search grid.

Application can activate adaptive search grid from the option menu.

Since:

5.0

Returns the length of search text.

Returns:

The length of search text.