CEikAppUi Class Reference

Processes shell commands.

The Uikon application framework calls this overload when an application is launched by the user opening a file from the shell or when a Create new file command is issued.

This overload simply returns whether or not the file aDocumentName exists.

Many document based applications will override this function to invoke the 2-parameter utility version of this methid.

See also: CEikAppUi::ProcessCommandParametersL(TApaCommand aCommand, TFileName& aDocumentName)

Processes shell commands.

This is the ProcessCommandParametersL() method that the Uikon application framework will call at application startup. The implementation will extract the command, document file name, and tail parameteres from the command line and call the 3-parameter version of this method.

The default implementation will simply returns whether or not the file aDocumentName exists.

See also: CEikAppUi::ProcessCommandParametersL(TApaCommand aCommand ,TFileName& aDocumentName, const TDesC8& aTail)

This is a convinience utility method that an application can call from an overriden version of the virtual ProcessCommandParametersL() taking three arguments. This method will not be called unless explicitly used by the application in this way.

This method is useful for applications that are used to view or edit document files, such as text documents or spreadsheets.

This method will make an application automatically open the document file that was last open in the application, unless a document file is explicitly defined as part of the command line, and the Open or Create commands are specified.

This method will call CEikAppUi::ValidFileType() to find out if the specified document file can be opened by this application.

In detail: If aCommand is EApaCommandCreate, the function simply returns EFalse as the file does not yet exist.

If aCommand is EApaCommandOpen, the function tests whether the specified document is valid and exists. If not, the function attempts to generate a valid default filename and returns that in aDocumentName provided the file name portion of the specified full path name has valid format.

If aCommand is any other value, the function tests whether the most recently open document that is valid for the application exists, and returns that in aDocumentName.

The file must be a valid document file, as indicated by the UID value(s),otherwise the function generates a new filename. An application may handle the request by overriding CEikAppUi::ValidFileType() if required.

See also: CEikAppUi::ValidFileType()

Processes Application Architecture messages.

This is overridden by subclasses to handle messages sent from the Application Architecture framework. This implementation only recognises the message UIDs KUidApaMessageSwitchOpenFileValue and KUidApaMessageSwitchCreateFileValue. It performs no action if the message contains other values.

See also: CCoeAppUi::HandleMessageReadyL() CApaTask::SendMessage()

Reads the application UI information at the specified offset in the app's standard resource file.

This function is called by BaseConstructL(), unless either of the ENoAppResourceFile or ENonStandardResourceFile flags was specified.

Reports a resource change to the application.

Calls ReportResourceChangedToAppL( aEventId ) on recursively on each ContainerAppUi. For use with embedded applications (where iContanerAppUI != NULL)

See also: CEikAppUi::ReportResourceChangedToAppL(TInt aType)

Saves any changes made to the app UI's associated document, if the document is marked as having changed.

Saves the app UI's associated document, or sets the document as changed, if the app UI is embedded.

Marks the app UI's associated document as having changed.

Sets this app UI's document.

The document associated with the app UI is initially owned by CEikProcess, and there is usually no reason to change it with this function.

Sets the embedded document's observer and read only state.