dmIToolInfo Class Reference

Tool manipulator. More...

#include <CCI_ToolInfo.h>

Inherits dmINotify.

Inherited by dmIRgnBlobs.

List of all members.

Public Member Functions

bool Assign (dmTool *tool)
 Assign a tool.
bool Clear ()
 Clear/Release the current tool.
bool AddListener (cci_object *listener, dm_uint evtMask, dm_uint flags)
 Add an event listener to the tool.
bool RemoveListener (cci_object *listener, dm_uint evtMask, dm_uint flags)
 Remove an event listener from a tool.
bool GetPos (dm_uint index, dm_point &pt)
 Return the position of a carret.
bool Rename (const char_t *newname)
 Rename a tool.
bool MoveTo (dm_int index, dm_int x, dm_int y)
 Move carret to a given position.
bool MoveBy (dm_int index, dm_int x, dm_int y)
 Offset carret position.
bool Rectangle (dm_rect &rect)
 Return the bounding rectangle of that tool.
bool SetToolState (dm_uint state, dm_bool status)
 Set internal state of the tools.
dm_bool GetToolState (dm_uint state)
 Return internal state of the tools.
bool Remove ()
 Remove the tool from its container.
bool Update ()
 Update the tool.
const char_t * GetClass ()
 Return the classname for that tool.
dm_bool ExecCommand (const char_t *command, const char_t *arg, cci_Object *param)
 Execute a command.
dm_bool IsCommandSupported (const char_t *command)
 Check if a command is supported.


Detailed Description

Tool manipulator.


Member Function Documentation

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

Add an event listener to the tool.

Parameters:
listener a dmIEventListener object
evtMask mask of event type to be intercepted (
See also:
dmTk::dmEventType ) The mask should be a combination (OR) of dmEVENT_MASK(eventType) values.
Parameters:
flags Propagation flags: dmEVENT_FLAG_CAPTURE - listen for capturing events. dmEVENT_FLAG_BUBBLE - listen for bubbling events. ( see daim_event_model for details ).

bool dmIToolInfo::GetPos dm_uint  index,
dm_point &  pt
[inline]
 

Return the position of a carret.

Parameters:
index index of the carret
pt index of the carret

bool dmIToolInfo::Remove  )  [inline]
 

Remove the tool from its container.

This method search all parent for a tool manager. If the manager is found, the tool is removed from it and eventually destroyed.

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

Remove an event listener from a tool.

Parameters:
listener a dmIEventListener object
evtMask mask of event type to be intercepted (
See also:
dmTk::dmEventType ) The mask should be a combination (OR) of dmEVENT_MASK(eventType) values.
Parameters:
flags Propagation flags: dmEVENT_FLAG_CAPTURE - listen for capturing events. dmEVENT_FLAG_BUBBLE - listen for bubbling events. ( see daim_event_model for details ).


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