UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]



Commands

Control

How to guide

Resource reference

Command List

Commands in the User Interface

QIK_COMMAND_LIST

Command

Commands in the User Interface

QIK_COMMAND


CQikCommand

Visual representation of an action in the user interface. CQikCommand is a visual representation of an action in an application. Application users initiate an action by selecting the corresponding command in the user interface. The Command Processing Framework decides where to place each command. A command can be placed on a softkey, in a button bar or in a menu depending on the phones interaction style and the other commands that are displayed at the same time. Developers cannot hard code commands to be placed in a specific place. Instead, attributes are set that control where in the user interface the command will be located. Use SetTextL() to set text that represents the command in the user interface. Use SetType() to specify the type of function the command executes. Some common types are "Item", "Done", "Yes" and "No". Setting a type is mandatory. Use SetPriority() to set the priority. A priority is expressed as an integer, negative, positive or zero. The lower the value, the higher the priority will be. For example, a command with priority = -5 will be given a better position than one with priority = 10. Setting a priority is not mandatory. The default value is 0. The type and priority of a command can be changed at anytime. More information about the Command Processing Framework, CPF is available in the UIQ Developer Library.

Class reference

CQikCommand

[Top]


CQikCommandStateMonitor

Optional class for keeping track of different states in your application model and update the commands state accordingly.

Class reference

CQikCommandStateMonitor

[Top]


MQikCommandHandler

Interface for classes responsible of executing commands.

Class reference

MQikCommandHandler

[Top]


MQikCommandListOwner

Interface for classes adding commands. Any control adding commands defined in a resource file to the CQikCommandManager must implement the MQikCommandListOwner interface. With this interface the CQikCommandManager finds the object which is responsible for executing each command. The HandleCommandL method of that object responsible for executing the command is called when the command is activated. Note that the ownership refers to the resource struct QIK_COMMAND_LIST and not the command list created internally in the CQikCommandManager (which can be made up of several QIK_COMMAND_LIST resources).

Class reference

MQikCommandListOwner

[Top]


MQikCommandModelOwner

Interface for classes owning placeholders for command lists. MQikCommandModelOwner is an extension of MQikCommandListOwner. MQikCommandModelOwner must be implemented by any control that shall own a placeholder for command lists in the CQikCommandManager. Such controls must be present on the control stack of the CCoeAppUi so they can be reported as "TopFocused" controls. This interface should be implemented by views and popouts which do want to hide the commands of underlying controls. A "command model" let you store a separate list of commands for each Ui-configuration defined by the control.

Class reference

MQikCommandModelOwner

[Top]


MQikCommandObserver

Interface for command observers. Implement this interface if you want to be notified when a command is selected or deleted. A command can only have one instance of MQikCommandHandler but can have any number of instances of MQikCommandObserver . Anyone other than the command handler interested in observing when a command is activated can implement this interface. May be placed in a super-class to the actual command handler (for example CQikViewBase uses this interface to update "current category" even though its sub-class is an MQikCommandHandler. The observer must be added to the command by calling CQikCommand::AddObserverL(). The observer must be removed from the command by calling CQikCommand::RemoveObserver().

Class reference

MQikCommandObserver

[Top]


MQikCommandOperator

Interface to be implemented by command operators.

Class reference

MQikCommandOperator

[Top]


MQikCommandStateController

Optional class for keeping track of different states in your application model and update the commands' state accordingly.

Class reference

MQikCommandStateController

[Top]


MQikEmbeddedLinkInterface

Interface for a control using Embedded links in its command list. This interface MQikEmbeddedLinkInterface is used by any CoeControl that wants to include Embedded Links into its command list. The method EmbeddedLinkId() must be overloaded to return a unique identifier for that specific control.

Class reference

MQikEmbeddedLinkInterface