exomWin32 Namespace Reference

Detailed Description

Add-On for exom framework to support a graphical user interface based on win32.

Classes

class CXmWin32Namespace

The namespace containing the IDs intended for the module exomWin32. More...

class CXmActionItem

Hold a path and optional parameters used for actions. More...

class CXmActionItems

Container of items of type CXmActionItem attached to an integer id. More...

class CXmFindDlg

Search dialog for user interface, which also perform the search. More...

class CXmFindNotifier

Interface to notify starting or finishing a search stage of CXmFindHandler. More...

class CXmFindHandler

Supply a complete search process using a dialog and providing the search results. More...

class CXmImageMap

A map used by CXmImageList::AddBitmapRes() to index icons within an image list. More...

class CXmImageMapSeq

A map providing the ascending indices starting from the specified id. More...

class CXmImageMapTbl

A map providing the indices from a given array. More...

class CXmImageList

An image list contain a set of icons having the same size. More...

class CXmListCtrl

A switchable tree/list control displaying objects in multiple columns. More...

class CXmNavigationView

Provide the "standard" view for a exom based GUI application. More...

class CXmNavResult

Connect a object list to a list control and allow forward and backward navigation between the items. More...

class CXmPageCont

Page container hold different dialogs and control showing one of them. More...

class CXmPropertiesCtrl

Control, which show the properties of an object. More...

class CXmUIDialog

Implement a GUI dialog, which support the connection between win32 controls and their assigned application data. More...

Enumerations

enum XM_LIST_SYTLE {
  LS_TREEVIEW = exom::BIT_0,
  LS_TREEGRID = exom::BIT_1,
  LS_REMEBER_FOCUS = exom::BIT_2 ,
  LS_SHOW_ROOT_ITEM = exom::BIT_4,
  LS_FULLROWSELECTION = exom::BIT_5,
  LS_USE_GLOBAL_MEM_DC = exom::BIT_6,
  LS_USE_DEF_OBJIMAGELIST = exom::BIT_7,
  LS_NO_NAVIGATION = exom::BIT_8,
  LS_SELECT_NEW_ITEMS = exom::BIT_9
}

Specify the properties of a tree/list control. More...

enum XM_LISTCOL_SYTLE {
  LCS_DELETABLE = exom::BIT_0,
  LCS_NOEDIT = exom::BIT_1,
  LCS_SHOWICON = exom::BIT_2 ,
  LCS_HLEFT = 0,
  LCS_HCENTER = exom::BIT_4,
  LCS_HRIGHT = exom::BIT_5,
  LCS_LINES_AT_ROOT = exom::BIT_6
}

Specify the properties of a colum within a tree/list control. More...

enum DET_SEL {
  DET_SEL_DEF = exom::BIT_0,
  DET_SEL_FIND = exom::BIT_1,
  DET_CUR_CONT = exom::BIT_2,
  DET_CUR_CTRL = exom::BIT_3
}

Specify the context of a selection in the user interafce. More...

Functions

EXOMWIN32_API void exomWin32Init (HINSTANCE hInstance, XmDialog *baseDlg, CXmDialogManager *dlgMan)

Initialize the exomWin32 module.

EXOMWIN32_API void SetFunctionIcon (XmFcnID &id, int icon)

Assign an icon index of exomWin32::g_CmdImageList to a function id.

EXOMWIN32_API void SetAtomIcon (XmAtmID &id, int icon)

Assign an icon index of exomWin32::g_CmdImageList to the specified atom id.

EXOMWIN32_API int GetMemberIcon (XMID id)

Return the icon index of the specified id within its dedicated image list (exomWin32::g_CmdImageList or exomWin32::g_ObjImageList).

EXOMWIN32_API void SetObjectIcon (XmObjID &id, int icon)

Assign the icon index of exomWin32::g_ObjImageList to the spcified object id.

EXOMWIN32_API void DetermineSelection (XmPath &path, DET_SEL selMask)

Have to be called to determine the selected object within the specified context.

EXOMWIN32_API bool GetModuleDir (XmString &dir)

Return the path of the calling process (application).

Variables

EXOMWIN32_API CXmWin32Namespace cxmn

Provide all ID's used within the Add-On exomWin32.

EXOMWIN32_API CXmImageList g_CmdImageList

Global image list containing icons used for commands.

EXOMWIN32_API CXmImageList g_ObjImageList

Global image list containing icons used for objects.

Enumeration Type Documentation

enum XM_LIST_SYTLE

Specify the properties of a tree/list control.

Enumeration values:

LS_TREEVIEW 1 = tree view; 0 = list view.

LS_TREEGRID enable the tree grid for tree view.

LS_REMEBER_FOCUS rember the focus when navigating in list view

LS_SHOW_ROOT_ITEM show the root item in tree view

LS_FULLROWSELECTION Enable only full row selection (instead of selecting each cell).

LS_USE_GLOBAL_MEM_DC Enable the global memory DC for the control.

LS_USE_DEF_OBJIMAGELIST Use the default object image list for the displayed icons.

LS_NO_NAVIGATION Disable the navigation with key (enter, del) or mouse (doubleclick) in list view.

LS_SELECT_NEW_ITEMS Automtic selection of new items in list view.

enum XM_LISTCOL_SYTLE

Specify the properties of a colum within a tree/list control.

Enumeration values:

LCS_DELETABLE Set to true, if column is deletable by user interface.

LCS_NOEDIT Colum is read only.

LCS_SHOWICON Show an icon in object columns, created by CXmListCtrl::InsertColumnObjLook();.

LCS_HLEFT Content of cells are left aligned (default).

LCS_HCENTER Content of cells are centered aligned.

LCS_HRIGHT Content of cells are right aligned.

LCS_LINES_AT_ROOT Show the root lines in grid view for columns created by CXmListCtrl::InsertColumnObjLook().

enum DET_SEL

Specify the context of a selection in the user interafce.

Enumeration values:

DET_SEL_DEF The current selected object. Normally identifiable by a (blue) selection rectangle. Typical related GUI function: cut, copy, delete and moving.

DET_SEL_FIND The context, from where a search will start.

DET_CUR_CONT The current container object. Will be used as target for pasting clipboard objects.

DET_CUR_CTRL The current control (if derived from XmObject). CXmListCtrl support functions like: sorting and deletion of columns by this way.

Function Documentation

EXOMWIN32_API void exomWin32Init ( HINSTANCE hInstance,

XmDialog * baseDlg,

CXmDialogManager * dlgMan

)

Initialize the exomWin32 module.
Have to be called befor using any function of this module.

EXOMWIN32_API void DetermineSelection ( XmPath & path,

DET_SEL selMask

)

Have to be called to determine the selected object within the specified context.
Typically the path instance is used as base for another path like exom::XmPathRef. The ref. path will epanded by one of the functions mentioned at DET_SEL. If no object found for the given context, path.GetPathSet() is false.