XmApplication Class Reference

Inheritance diagram for XmApplication:

List of all members.

Detailed Description

Is used as application singleton, when using the exom application/document model.

The application is responsible to control and manage documents of class XmDocument. Via the application, documents can be created, closed, opened and saved. The application can be used as a single or a multiple document interface (see DOC_INTERFACE).

The application has also the possibility to load and save application settings. These settings are saved in the directory which is supplied by InitApp().

More information in section Application / Document Model.

Public Member Functions

XmApplication (DOC_INTERFACE di=SINGLE_DOCUMENT_INTERFACE)

Construct an application by using this given DOC_INTERFACE.

void InitApp (const char *filename=NULL)

Enable the document/application model.

void AddAppExt (XmApplicationExt *factory)

Add an application extension (especially used as a document factory) to an application.

Public Attributes

XmSelectFileOpt m_FileOptions

Filter options and default path for the application "Open" and "Save" dialog.

Protected Member Functions

Overridables

virtual void OnCloseApp ()

Will be called when application is closed.

virtual XmDocument * OnNewDoc (const XmObjectID *id)

Will be called, if application has to create a new document.

virtual bool OnReadDocument (XmDocumentLoader &loader)

Will be called, if application has to load a new document.

Overridables - XmObject

XMOBJ ObjectID () const

Return the ID of an object.

void manage (XmMan &m)

Provide the possibility to connect member data and sub objects.

void manageFcn (XmManFcn &m)

Defines the object functions usable in user interface.

ARESULT OnAction (XmActionCx &ac)

Is called, when processing user action.

void MemberState (XmMemberStateCx &mc) const

Define the presentation of member data and functions.

Member Function Documentation

void InitApp ( const char * filename = NULL )

Enable the document/application model.

Parameters:

filename directory where to save the application settings.

XMOBJ ObjectID ( ) const [inline, protected, virtual]

Return the ID of an object.
The ID give the exom framework the possibility to identify a class derived from XmObject. So all classes derived from XmObject should have their own ID.
Implements XmObject.

void manage ( XmMan & m ) [protected, virtual]

Provide the possibility to connect member data and sub objects.
Member data and sub objects can be connected, by calling the corresponding manXxx functions of XmMan.
Implements XmObject.

void manageFcn ( XmManFcn & m ) [protected, virtual]

Defines the object functions usable in user interface.
All functions included manageFcn() are visible in user interface. The availibility is controlled by MemberState().
Reimplemented from XmObject.

ARESULT OnAction ( XmActionCx & ac ) [protected, virtual]

Is called, when processing user action.
OnAction give the application the possibility to handle user input via the user interface. For example: range checks or additional actions like closing a dialog. This function is called recursive in the member hierarchy.
Reimplemented from XmObject.

void MemberState ( XmMemberStateCx & mc ) const [inline, protected, virtual]

Define the presentation of member data and functions.
Via MemberState() the application has the possibility to control the appearance of member data and functions in user interface, like enabled/disabled, checked/unchecked,... This function is called recursive in the member hierarchy.
Reimplemented from XmObject.