dmIManager Class Reference

Daim tool manager document interface. More...

#include <CCI_Manager.h>

Inherits dmIDocument.

Inherited by dmIToolHistogram.

List of all members.

Public Member Functions

bool FromInfo (const char_t *name, dm_uint flags, cci_object *info)
 Retrieve or create a manager from the current info object.
bool Create (dm_uint width, dm_uint height)
 Create a stand alone manager.
dmTool * GetToolByName (const char_t *name)
 Return a tool from its name.
dmTool * GetCurrentTool ()
 Return the current active tool descriptor.
dmTool * CreateTool (dm_uint id, const char_t *classid, const char_t *name, const dm_point *pts, dm_uint count, bool edit)
 Create a new tool.
dmTool * EditTool (dm_uint id, const char_t *classid, const char_t *name)
 Edit a new tool.
dm_uint GetCurrentToolId ()
 Return the current edited tool id.
bool AbortEdit (dm_uint id=0)
 Abort the current editing of a tool.
bool ReleaseMngr ()
 Release the attached tool manager.
bool AddListener (cci_object *listener, dm_uint evtMask, dm_uint flags)
 Add an event listener to the attached manager.
bool RemoveListener (cci_object *listener, dm_uint evtMask, dm_uint flags)
 Remove an event listener from he attached manager.
bool GetToolInfo (cci_object *toolinfo, const char_t *toolname)
 Initialize a dmIToolInfo object.
bool HasFocus ()
 Return true if the manager has the focus.
bool IsEmpty ()
 Return true if the manager is empty.


Detailed Description

Daim tool manager document interface.

Manager is a special kind of Daim document,used to display graphical informations using the tools library. It is possible to add/remove/control tools that will interact with user using the default gui environment (In this case, you will need to have a proper dmIGraphics object in order to achieve display). Capture of events must be done at implementor level wich must translate and passe them to the document (see dmIDocument::OnCommand methods ).


Member Function Documentation

bool dmIManager::AbortEdit dm_uint  id = 0  )  [inline]
 

Abort the current editing of a tool.

This method generate a evAbort bubbling event

bool dmIManager::AddListener cci_object *  listener,
dm_uint  evtMask,
dm_uint  flags
[inline]
 

Add an event listener to the attached manager.

See also:
dmIEventListener::AddListener() for a description of the parameer

dmTool* dmIManager::CreateTool dm_uint  id,
const char_t *  classid,
const char_t *  name,
const dm_point *  pts,
dm_uint  count,
bool  edit
[inline]
 

Create a new tool.

Parameters:
id Integer identifier returned by GetCurrentToolId()
classid The class name of the tool to be created. class must correspond to a registered tool class. If this is parameter is null, id must be one of the predefined tool id defined in daim_ui.h.
pts An array of dm_point for initializing the tools. This parameter can be null.
count The number of points in count.
edit Create the tool for manual editing. The tool is inserted into the manager only when the editing sequence has been completed. Editing can be aborted with th the AbortEdit method.

dmTool* dmIManager::EditTool dm_uint  id,
const char_t *  classid,
const char_t *  name
[inline]
 

Edit a new tool.

This is a shortcut for CreateTool(id,classid,name,NULL,0,true)

bool dmIManager::FromInfo const char_t *  name,
dm_uint  flags,
cci_object *  info
[inline]
 

Retrieve or create a manager from the current info object.

This method will attach a new or existing manager to this interface. The manager will be attached to the dmIImageInfo object info ( or to the current dmIImageInfo object if info is set to ull ) flags can be a combination of the following values :

  • DM_Manager_Create: Create a new manager and insert it in the manager list of the given dmIImageInfo object.
  • DM_Manager_Select: Select the manager and bring it to the foreground.

bool dmIManager::GetToolInfo cci_object *  toolinfo,
const char_t *  toolname
[inline]
 

Initialize a dmIToolInfo object.

If toolname is a valid non empty string, the method will look for for the first tool where the name match the passed string. Otherwise, the current default tool (if any) is assigned to the dmIToolInfo object.

bool dmIManager::RemoveListener cci_object *  listener,
dm_uint  evtMask,
dm_uint  flags
[inline]
 

Remove an event listener from he attached manager.

See also:
dmIEventListener::RemoveListener() for a description of the parameters


Generated on Tue May 9 12:34:57 2006 for Daim Library Module Set by  doxygen 1.4.6-NO