Home
Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members
exom Namespace Reference
Detailed Description
Contain all interfaces and classes used for the core of the exom framework.The key class of the exom frame work is XmObject. This should by the base class for all application classes, which should support the different features of the exom framework.
Classes | |
| class | TXmListIterator |
| Iterator template used to iterate through the elements within a TXmList container. More... | |
| class | TXmList |
| Template to create a list based type safe container for classes or simple data types. More... | |
| class | TXmListIterAll |
| Iterator template used to iterate within all elements within a TXmList container. More... | |
| class | TXmObjectListBox |
| Item class used within the container template TXmObjectList holding the index and the reference to an instance of specfied item type. More... | |
| class | TXmObjectListIterator |
| Iterator template used to iterate through the elements within a TXmObjectList container. More... | |
| class | TXmObjectList |
| List based container with XmArray interface managing references to classes of type C derived from XmObject. More... | |
| class | TXmObjectListObject |
| Template with XmObject interface and all capabilities of TXmObjectList. More... | |
| class | TXmObjectVector |
| Container template with XmArray interface for managing items of the specified class derived from XmObject. More... | |
| class | TXmObjectVectorObject |
| Template with XmObject interface and all capabilities of TXmObjectVector. More... | |
| class | TXmVector |
| Template to create a vector based type safe container for classes or simple data types. More... | |
| class | XmNamespaceInst |
| Namespace for identifieres used in the exom core. More... | |
| class | XmActionCx |
| Context class used in XmObject::OnAction() for handling user actions. More... | |
| class | XmApplication |
| Is used as application singleton, when using the exom application/document model. More... | |
| class | XmApplicationExt |
| Application extension to handle application specific needs of multiple exom based libraries (modules). More... | |
| class | XmArray |
| Interface class, which supply container functionality for objects in the exom Object Model. More... | |
| class | XmAppendCx |
| context class for appending items to a container derived from XmArray. More... | |
| class | XmArrayProp |
| Contain general array properties, describing the behaviour of a XmArray container. More... | |
| class | XmIOCondition |
| General format settings for input and output. More... | |
| class | XmAtom |
| Used to encapsulate native atomic data (int, bool, float,...). More... | |
| class | XmAtomHandler |
| This class support the conversion between different formats of atomic data. More... | |
| class | XmAtomProp |
| Provide information about the currently handled atom in XmMan::manAtmCallback(). More... | |
| class | XmClipboard |
| Contain general clipboard functions. More... | |
| class | XmClipboardData |
| Provide the possibility to retrieve the data within the clipboard via an in stream. More... | |
| class | XmCmdline |
| Implement a user interface dialog for command line based interfaces. More... | |
| class | XmData |
| Abstract class to handle different atomic data formats in the same way. More... | |
| class | XmDataAtom |
| This class provide a XmData interface for native atomic data. More... | |
| class | XmDataBytes |
| This class provide a XmData interface for atomic data stored in byte arrays. More... | |
| class | XmDataString |
| This class provide a XmData interface for atomic data stored in strings. More... | |
| class | XmDateTime |
| This class supply a human readable Date/Time format and allow convertions between different Date/Time formats. More... | |
| class | XmDialog |
| Application specific representation of a dialog as counterpart to XmUIDialog. More... | |
| class | XmDocument |
| Class is used as a document, when using the exom application/document model. More... | |
| class | XmDocumentLoader |
| Context class used in XmApplication::OnReadDocument() to handle the reading of documents. More... | |
| class | XmDynObject |
| Interface class for dynamic object generation. More... | |
| class | XmEnumList |
| Container class used for representing enumerations in user interface. More... | |
| class | XmFcnParams |
| Small container class for optional parameters used for member functions. More... | |
| class | XmID |
| Base class to identify objects, member data and functions. More... | |
| class | XmObjID |
| ID class to identify objects (see XmObject::ObjectID()). More... | |
| class | XmAtmID |
| ID class to identify member data, so-called atoms. More... | |
| class | XmFcnID |
| ID class to identify member functions. More... | |
| class | XmLock |
| Pure virtual class providing the basic interface for synchronization needs. More... | |
| class | XmNoLock |
| Empty implementation for the synchronization class XmLock. More... | |
| class | XmCriticalSection |
| Ensure the access to a resource by only one thread at a time. More... | |
| class | XmSingleLock |
| Helper class used to simplify implementation of XmLock::lock() and XmLock::unlock() sequences. More... | |
| class | XmMan |
| context class used in XmObject::manage() to connect member data and objects. More... | |
| class | XmManFcn |
| Context class used in XmObject::manageFcn() to provide functions for user interface. More... | |
| class | XmObjectProp |
| Provide information about the currently handled object in XmMan::manObjCallback(). More... | |
| class | XmManContainerCx |
| Context class used to create a list of objects contained within a superior object. More... | |
| class | XmManContainer |
| Support the generation of a object list, which are contained within a superior object. More... | |
| class | XmManPropertiesCx |
| Context class used to generate a list of properties and functions of an object. More... | |
| class | XmManProperties |
| Support the creation of a properties and function list for an object. More... | |
| class | XmManSearchCx |
| Context class to search an object or member identified by a path. More... | |
| class | XmManSearch |
| Support the search for an object or member identified by a given path. More... | |
| class | XmSeriExt |
| Interface to handle read actions dedicated to objects via XmObject::GetSeriExt(). More... | |
| class | XmManSeriRead |
| Context class used via XmObject::GetSeriExt() for deserialization. More... | |
| class | XmManSeriReadXml |
| Support reading data in XML format from a stream to an object. More... | |
| class | XmManSeriWrite |
| Context class to write the data of an object to a stream. More... | |
| class | XmManSeriWriteXml |
| Support writing data from an object to a stream in XML format. More... | |
| class | XmManTextFind |
| Support searching a text within an object hierarchy. More... | |
| class | XmMemberExtCx |
| Context class used for XmObject::MemberExt() to enable extended member functionality. More... | |
| class | XmMemberProp |
| Contain the state of member data of functions, during calculation. More... | |
| class | XmMemberStateCx |
| Context class used in XmObject::MemberState() to set the appearance of object members. More... | |
| class | XmMemberState |
| Context to calculate the member state of member data or functions. More... | |
| class | XmModuleInfo |
| Contain a list of different language depending strings especially used for ID's. More... | |
| class | XmNamespace |
| A namespace contain all ID's (XmID) used for a library or application. More... | |
| class | XmNamespaceMan |
| XmNamespaceMan is used to register all used namespaces. More... | |
| class | XmObjSetCx |
| Context class used in XmObject::ObjSet to enable differnet exom features for an object. More... | |
| class | XmObject |
| Base class for the Object Model of the exom framework to support various features. More... | |
| class | XmObjectFilter |
| Used to filter objects in XmMan derived classes. More... | |
| class | XmObjectID |
| XmObjectID give the possibility to compare object or member ID's in a generic way. More... | |
| class | XmObjectListBox |
| Item class used within the container XmObjectList holding the index and the reference to an instance of XmObject. More... | |
| class | XmObjectListIterator |
| Iterator used to iterate through the elements within a XmObjectList container. More... | |
| class | XmObjectList |
| List based container with XmArray interface managing references to classes derived from XmObject. More... | |
| class | XmObjLookCx |
| Context used in XmObject::ObjLook() to set the appearance and behaviour of an object. More... | |
| class | XmParamAccess |
| Provide access to parameters delivered along with user interface functions. More... | |
| class | XmPath |
| Instances of this class are used to identify objects, member data and functions. More... | |
| class | XmPathObj |
| Create a path, which is relative to the given object. More... | |
| class | XmPathRef |
| Create a path, which is relative to the referenced path. More... | |
| class | XmPathRoot |
| Create a path, which is relative to the exom root. More... | |
| class | XmPathDoc |
| Create a path, which is relative to the given document. More... | |
| class | XmPathDocBase |
| Create a path, which is relative to the given document base (XmDocument::DocBase()). More... | |
| class | XmPathApp |
| Create a path, which is relative to the exom application singleton (XmApplication). More... | |
| class | XmPathInfo |
| Supply simple access to a path used in some context classes. More... | |
| class | XmPathItem |
| Item within the enclosing container XmPath. More... | |
| class | XmPathPrs |
| Helper context class to determine a XmPath from a given string. More... | |
| class | XmPlaceholderText |
| Placeholder text is used for flexibel handling of multilingual strings in comination with application specific arguments. More... | |
| class | XmPrsStream |
| Class with basic functionality for parsing text encapsulated by a XmStreamIn. More... | |
| class | XmPrsStreamError |
| Hold additional error information related to parsing from streams. More... | |
| class | XmReadAtomCx |
| Context class, which provide information about the current data to be loaded. More... | |
| class | XmPathNavigator |
| Interface which execute the navigation to a specified path. More... | |
| class | XmReferenceList |
| Container for paths to objects or object members and additional data. More... | |
| class | XmFileFilterItem |
| Define a file filter and associate a native description to it. More... | |
| class | XmFileFilter |
| Container for none, one or more file filters of class XmFileFilterItem. More... | |
| class | XmSelectFileOpt |
| Different options for file selection - used in XmSelectFile. More... | |
| class | XmSelectFile |
| Support selecting a file via a dialog, which will mostly be used for load or save needs. More... | |
| class | XmStreamIn |
| Interface class, which encapsulate the reading from streams. More... | |
| class | XmStreamInMem |
| Support reading from a given string or memory block via the XmStreamIn interface. More... | |
| class | XmStreamInFile |
| Support reading from a file via the XmStreamIn interface. More... | |
| class | XmStreamOut |
| Interface class, which encapsulate the writing to streams. More... | |
| class | XmStreamOutNull |
| Support using a XmStreamOut without any stream destination. More... | |
| class | XmStreamOutString |
| Support writing to a string via the XmStreamOut interface. More... | |
| class | XmStreamOutAByte |
| Support writing to a byte array via the XmStreamOut interface. More... | |
| class | XmStreamOutFile |
| Support writing to a file via the XmStreamOut interface. More... | |
| class | XmString |
| String class especially used within the exom framework. More... | |
| class | XmStrTbl |
| Small utility class to support multilingual strings. More... | |
| class | XmThreadLocals |
| Store local thread data, which can be accessed global within the thread. More... | |
| class | XmTime32 |
| Represent a date/time value, using a 32 bit integer. More... | |
| class | XmUIDialog |
| Base class for platform specific implementations of a dialog as counterpart of a XmDialog. More... | |
| class | XmUserRequest |
| Support handling simple user questions like: yes, no, ok, cancel. More... | |
User request functions | |
| XMAPI XMFCN | UserRequestDlg (const char *questionStr, XmUserRequest::OPTIONS questionType, XmUserRequest::CATEGORY cat) |
| Open a dialog with a simple user request and respons options. | |
| XMAPI void | MessageDlg (const XmString &text, XmUserRequest::CATEGORY cat=XmUserRequest::CAT_INFORMATION) |
| Open a message dialog, which can be closed by Ok. | |
| XMAPI bool | ConfirmDlg (const XmString &text, XmUserRequest::CATEGORY cat=XmUserRequest::CAT_QUESTION) |
| Open a message dialog, which return true when confirmed with Ok or false when dismissed by Cancel. | |
| XMAPI XMFCN | YesNoCancelDlg (const XmString &msg, XmUserRequest::CATEGORY cat=XmUserRequest::CAT_QUESTION) |
| Open a message dialog with the options Yes, No or Cancel. | |
Typedefs | |
| typedef bool | xmBool |
| boolean | |
| typedef unsigned char | xmUInt8 |
| 8 bit unsigned integer | |
| typedef unsigned short | xmUInt16 |
| 16 bit unsigned integer. | |
| typedef unsigned int | xmUInt32 |
| 32 bit unsigned integer. | |
| typedef signed char | xmInt8 |
| 8 bit signed integer | |
| typedef signed short | xmInt16 |
| 16 bit signed integer. | |
| typedef signed int | xmInt32 |
| 32 bit signed integer. | |
| typedef float | xmFlt32 |
| 32 bit float. | |
| typedef double | xmFlt64 |
| 64 bit float - double. | |
| typedef unsigned int | xmFlags |
| unsigned int representing a 32 bit bit mask. | |
| typedef const XmID & | XMID |
| General ID. | |
| typedef const XmAtmID & | XMATM |
| Atom ID. | |
| typedef const XmFcnID & | XMFCN |
| Function ID. | |
| typedef const XmObjID & | XMOBJ |
| Object ID. | |
| typedef bool | ARESULT |
| Result of XmObject::OnAction(). Possible values: ASUCCESS and AFAILS. | |
Enumerations | |
| enum | DOC_INTERFACE { SINGLE_DOCUMENT_INTERFACE, MULTIPLE_DOCUMENT_INTERFACE } |
| Type of the document interface of an application. More... | |
| enum | ATOM_TYPE { ATOM_STRING = 0, ATOM_BYTE = 1, ATOM_BOOL = 2, ATOM_INT8 = 3, ATOM_INT16 = 4, ATOM_INT32 = 5, ATOM_UINT8 = 6, ATOM_UINT16 = 7, ATOM_UINT32 = 8, ATOM_FLT32 = 9, ATOM_FLT64 = 10, ATOM_TIME32 = 12, ATOM_ITEM_INDEX = 13, ATOM_C_STRING = 14, ATOM_BIT_0 = 16, ATOM_BIT_1 = 17, ATOM_BIT_2 = 18, ATOM_BIT_3 = 19, ATOM_BIT_4 = 20, ATOM_BIT_5 = 21, ATOM_BIT_6 = 22, ATOM_BIT_7 = 23, ATOM_BIT_8 = 24, ATOM_BIT_9 = 25, ATOM_BIT_10 = 26, ATOM_BIT_11 = 27, ATOM_BIT_12 = 28, ATOM_BIT_13 = 29, ATOM_BIT_14 = 30, ATOM_BIT_15 = 31, ATOM_BIT_16 = 32, ATOM_BIT_17 = 33, ATOM_BIT_18 = 34, ATOM_BIT_19 = 35, ATOM_BIT_20 = 36, ATOM_BIT_21 = 37, ATOM_BIT_22 = 38, ATOM_BIT_23 = 39, ATOM_BIT_24 = 40, ATOM_BIT_25 = 41, ATOM_BIT_26 = 42, ATOM_BIT_27 = 43, ATOM_BIT_28 = 44, ATOM_BIT_29 = 45, ATOM_BIT_30 = 46, ATOM_BIT_31 = 47 } |
| Specify the type of an atom (native data like, int, bool, float,...). More... | |
| enum | LABEL_TYPE { LABEL_XML, LABEL_ID, LABEL_NATIVE, LABEL_HELP_TEXT, LABEL_LINK } |
| Define the type of label for a XmID in user interface. More... | |
| enum | ACN_RES { ACN_OK = 0, ACN_CANCEL = 1, ACN_ERROR = 2 } |
| Result of executing a function or changing an atom with XmDialog::DoFunction() or rather XmDialog::ChangeAtom(). More... | |
| enum | MAN_MODE { MAN_SHOW = BIT_0 , MAN_READONLY = BIT_2, MAN_SEARCH = BIT_3, MAN_LIST = BIT_4, MAN_TEXTFIND = BIT_5, MAN_CALC = BIT_6, MAN_WRITE = BIT_7, MAN_READ = BIT_8, MAN_SERIALIZE = MAN_WRITE | MAN_READ , MAN_ATOM , MAN_ITEM = MAN_DEF | MAN_LIST } |
| Bits to control various exom features for objects, member data and functions. More... | |
| enum | RET_DLG { RET_OK = 0, RET_CANCEL = 1, RET_ERROR = -1 } |
| Specify the value of the result of XmDialog::DoModalPath(). More... | |
| enum | SEARCH { SEARCH_NOTFOUND = 0, SEARCH_FOUND = 1, SEARCH_FOUND_FCN = 3, SEARCH_FOUND_OBJ = 5, SEARCH_FOUND_ATOM = 7 } |
| Specify the type of element found after performing a search. More... | |
| enum | SERIFLAGS { SF_ASK_TO_CONTINUE = BIT_0, SF_STOP_ON_MISSING_ITEM = BIT_1, SF_STOP_ON_UNUSED_ITEM = BIT_2, SF_STOP_ON_INVALID_VALUE = BIT_3, SF_DEFAULT = SF_STOP_ON_MISSING_ITEM |SF_STOP_ON_INVALID_VALUE } |
| Serialization flags used, to specifiy the behavior of XmManSeriRead in case of a validation error. More... | |
| enum | eExtRecallMode { eRecallBasicExtensions, eRecallComboList } |
| Specify the type of information, which should be retrieved in XmObject::MemberExt(). More... | |
| enum | PARTOF { PARTOF_FALSE = 0, PARTOF_REAL = 1, PARTOF_EQUAL = 2 } |
| Specify the relation between two instances of XmPath. More... | |
| enum | TIMEBASE { TIMEBASE_LOCAL, TIMEBASE_UTC } |
| Specify the timebase for time data. More... | |
Functions | |
| XMAPI bool | exomInit (const char *key) |
| Initialize the exom framework and enable it to use it. | |
| XMAPI XmApplication & | GetApp () |
| Return the application singleton. | |
| XMAPI XmAtomHandler * | SetAtomHandler (XmAtomHandler *newAtomHandler) |
| Enable setting an advanced instance of XmAtomHandler. | |
| XMAPI bool | stdioLoop (const XmPath &p, XmDialog *baseDlg=NULL) |
| Console loop for handling input and output for console based exom applications. | |
| XMAPI RET_DLG | ModalObjDlg (XmObject &o, const char *dlgName, int prop) |
| Open a model dialog, using the given object o as base object. | |
| XMAPI bool | ModalAcnCxDlg (XmActionCx &ac, const char *dlg, int prop=DLGPROP_CANCEL_RESTORE) |
| Open a modal dialog, using the current path of ac as base object. | |
| XMAPI ARESULT | DeleteObjectDlg (XmActionCx &ac) |
| Open a modal dialog to confirm the deletion of the current object wihtin the action context ac. | |
| int | bfm (xmFlags bitMask) |
| bfm - bit from mask; Inline function to calculate the bit number from the specified bitMask. | |
| XMAPI bool | LoadModuleInfo (XmStreamIn &in, XmPrsStreamError *err=NULL) |
| Load module information described in XmModuleInfo. | |
| XMAPI bool | DirFromFile (XmString &dir, const XmString &path) |
| Extract the directory string from the given path. | |
| XMAPI bool | CalcCmdlinePath (XmString &dest, const XmPath &p, int begin=0) |
| Calculate the text presentation of a path p (start from path-item begin) for a command line. | |
| XMAPI bool | FileDialog (XmSelectFile::MODE mode, XmString &path) |
| Open a file selection dialog with the predefined path name. | |
| XMAPI bool | FolderDialog (XmString &path) |
| Open a folder selection dialog with the predefined path name. | |
| XMAPI XmThreadLocals & | ThreadLocals () |
| Return the thread locals for the calling thread. | |
Variables | |
| XMAPI XmNamespaceInst | xmn |
| Provide all ID's used within the core of the exom framework. | |
| const bool | ASUCCESS = true |
| Value of ARESULT. Signal success after executing an action. | |
| const bool | AFAILS = false |
| Value of ARESULT. Signal failure of executing an action. | |
Typedef Documentation
|
|
General ID. |
|
|
Atom ID. The assignment of ID's to member data (atom), will be done in manXxx() functions in XmMan. |
|
|
Function ID. The assignment of ID's to member functions, will be done in XmManFcn::manFcn() |
|
|
Object ID. The assignment of ID's to objects, have to be done in XmObject::ObjectID() |
Enumeration Type Documentation
|
|
Type of the document interface of an application. Specify the number of documents which can be controlled by the application at one time. |
|
|
Specify the type of an atom (native data like, int, bool, float,...). The type ids <= 128 are reserved for the exom framework. You are able to define your own atomic types, which enforces the implementation of your own XmAtomHandler.
|
|
|
Define the type of label for a XmID in user interface. The label types LABEL_XML and LABEL_ID are mandatory for ID's. The other labels types are optional.
|
|
|
Result of executing a function or changing an atom with XmDialog::DoFunction() or rather XmDialog::ChangeAtom().
|
|
|
Bits to control various exom features for objects, member data and functions. By setting one or more of these bits, the corresponding exom feature are enabled. The description of these features are at XmObject. Enabling these features is different between objects, member data and member functions:
|
|
|
Specify the value of the result of XmDialog::DoModalPath(). This value will be passed by XmDialog::CloseDlg(). |
|
|
Specify the type of element found after performing a search. One of these values (except SEARCH_FOUND) will be set after performing a search with XmManSearch. |
|
|
Serialization flags used, to specifiy the behavior of XmManSeriRead in case of a validation error. They are used in the error handler of XmSeriExt.
|
|
|
Specify the type of information, which should be retrieved in XmObject::MemberExt().
|
|
|
Specify the relation between two instances of XmPath.
|
|
|
Specify the timebase for time data.
|
Function Documentation
|
|
Initialize the exom framework and enable it to use it. Return true, if initialization is successful. It fails, if evaluation period of specified key expired. |
|
||||||||||||||||
|
Open a model dialog, using the given object o as base object.
|
|
||||||||||||||||
|
Open a modal dialog, using the current path of ac as base object.
|
|
|
bfm - bit from mask; Inline function to calculate the bit number from the specified bitMask. This result into the following mapping. Bit mask 0x01 to 1. 0x02 to 2. 0x04 to 3, ... , 0x40000000 to 30, 0x80000000 to 31. This function will by optimized completely away in case of using a constant bit mask parameter. This function is intended for XmMan::manBit() to enable using the bit mask instead of the concrete bit number. So access to those bits can be done consistent through the whole application by using only its bit mask.
|
|
||||||||||||
|
Open a message dialog with the options Yes, No or Cancel.
|