tool.h File Reference

(r1785/r1535)

#include "doccoord.h"
#include "binds.h"
#include "clikmods.h"
#include "ccobject.h"
#include "dlgtypes.h"
#include "list.h"

Go to the source code of this file.

Classes

class  ToolInfo_v1
 Provide information on a tool. More...
class  ToolInfo
 Provide information on a tool. The fields are as follows: MonoOn InfoVersion Indicates how much of this stucture is understood by the tool. InterfaceVersion The version of the kernel<->tool interface understood by the tool. Version The tool's own version number. ID The unique ID of this tool (allocated by Computer Concepts Ltd). ParentModuleID The unique ID of the module that provides this tool (allocated by Computer Concepts Ltd). Family A string describing the tool family this tool belongs to - e.g. "Path tools". Name A string describing the tool - e.g. "Rectangle tool". Purpose A string decribing what the tool is used for, e.g. "For drawing rectangles". Author A string naming the author(s) of the tool, e.g. "Computer Concepts Ltd". InfoBarDialog Resource ID of the dialog used in the infobar for this tool. MonoOff. More...
class  Tool_v1
 Specifies the interface between tools and the Kernel/OIL. More...
class  Tool
 The Tool type reflects the latest Tool specification. Do NOT subclass from Tool, but use the latest Tool revision (e.g. Tool_v42). The Tool type should only be used by the Kernel and OIL layers, never by tools themselves. More...

Defines

#define TOOLID_INVALID   0
#define TOOLID_TEST   2
#define TOOLID_PUSH   3
#define TOOLID_ZOOM   4
#define TOOLID_RECTANGLE   5
#define TOOLID_FREEHAND   6
#define TOOLID_SELECTOR   7
#define TOOLID_RECT   8
#define TOOLID_ROTATE   9
#define TOOLID_GRID   10
#define TOOLID_BEZTOOL   11
#define TOOLID_ELLIPSE   12
#define TOOLID_GRADFILL   13
#define TOOLID_PEN   14
#define TOOLID_BLANK   15
#define TOOLID_BLEND   16
#define TOOLID_TRANSP   17
#define TOOLID_REGSHAPE   18
#define TOOLID_MOULD   19
#define TOOLID_ACCUSOFT   20
#define TOOLID_TEXT   21
#define TOOLID_SOFTSHADOW   22
#define TOOLID_BEVELTOOL   23
#define TOOLID_CONTOURTOOL   24
#define TOOLID_SLICETOOL   25
#define TOOLID_LIVEEFFECT   26
#define TOOL_OPTOKEN_PUSH   _T("TOOL3")
#define TOOL_OPTOKEN_ZOOM   _T("TOOL4")
#define TOOL_OPTOKEN_RECTANGLE   _T("TOOL5")
#define TOOL_OPTOKEN_FREEHAND   _T("TOOL6")
#define TOOL_OPTOKEN_SELECTOR   _T("TOOL7")
#define TOOL_OPTOKEN_RECT   _T("TOOL8")
#define TOOL_OPTOKEN_ROTATE   _T("TOOL9")
#define TOOL_OPTOKEN_GRID   _T("TOOL10")
#define TOOL_OPTOKEN_BEZTOOL   _T("TOOL11")
#define TOOL_OPTOKEN_ELLIPSE   _T("TOOL12")
#define TOOL_OPTOKEN_GRADFILL   _T("TOOL13")
#define TOOL_OPTOKEN_PEN   _T("TOOL14")
#define TOOL_OPTOKEN_BLANK   _T("TOOL15")
#define TOOL_OPTOKEN_BLEND   _T("TOOL16")
#define TOOL_OPTOKEN_TRANSP   _T("TOOL17")
#define TOOL_OPTOKEN_REGSHAPE   _T("TOOL18")
#define TOOL_OPTOKEN_MOULD   _T("TOOL19")
#define TOOL_OPTOKEN_TEXT   _T("TOOL21")
#define TOOL_OPTOKEN_SOFTSHADOW   _T("TOOL22")
#define TOOL_OPTOKEN_BEVEL   _T("TOOL23")
#define TOOL_OPTOKEN_CONTOUR   _T("TOOL24")
#define TOOL_OPTOKEN_SLICE   _T("TOOL25")
#define TOOL_OPTOKEN_LIVEEFFECT   _T("TOOL26")

Enumerations

enum  DragEndType { DT_CANCELLED, DT_DIDNOTMOVE, DT_MOVEDTOSAME, DT_MOVEDTODIFF }

Variables

const UINT32 TOOLID_MAX = 99


Define Documentation

#define TOOL_OPTOKEN_BEVEL   _T("TOOL23")
 

Definition at line 180 of file tool.h.

#define TOOL_OPTOKEN_BEZTOOL   _T("TOOL11")
 

Definition at line 169 of file tool.h.

#define TOOL_OPTOKEN_BLANK   _T("TOOL15")
 

Definition at line 173 of file tool.h.

#define TOOL_OPTOKEN_BLEND   _T("TOOL16")
 

Definition at line 174 of file tool.h.

#define TOOL_OPTOKEN_CONTOUR   _T("TOOL24")
 

Definition at line 181 of file tool.h.

#define TOOL_OPTOKEN_ELLIPSE   _T("TOOL12")
 

Definition at line 170 of file tool.h.

#define TOOL_OPTOKEN_FREEHAND   _T("TOOL6")
 

Definition at line 164 of file tool.h.

#define TOOL_OPTOKEN_GRADFILL   _T("TOOL13")
 

Definition at line 171 of file tool.h.

#define TOOL_OPTOKEN_GRID   _T("TOOL10")
 

Definition at line 168 of file tool.h.

#define TOOL_OPTOKEN_LIVEEFFECT   _T("TOOL26")
 

Definition at line 183 of file tool.h.

#define TOOL_OPTOKEN_MOULD   _T("TOOL19")
 

Definition at line 177 of file tool.h.

#define TOOL_OPTOKEN_PEN   _T("TOOL14")
 

Definition at line 172 of file tool.h.

#define TOOL_OPTOKEN_PUSH   _T("TOOL3")
 

Definition at line 161 of file tool.h.

#define TOOL_OPTOKEN_RECT   _T("TOOL8")
 

Definition at line 166 of file tool.h.

#define TOOL_OPTOKEN_RECTANGLE   _T("TOOL5")
 

Definition at line 163 of file tool.h.

#define TOOL_OPTOKEN_REGSHAPE   _T("TOOL18")
 

Definition at line 176 of file tool.h.

#define TOOL_OPTOKEN_ROTATE   _T("TOOL9")
 

Definition at line 167 of file tool.h.

#define TOOL_OPTOKEN_SELECTOR   _T("TOOL7")
 

Definition at line 165 of file tool.h.

#define TOOL_OPTOKEN_SLICE   _T("TOOL25")
 

Definition at line 182 of file tool.h.

#define TOOL_OPTOKEN_SOFTSHADOW   _T("TOOL22")
 

Definition at line 179 of file tool.h.

#define TOOL_OPTOKEN_TEXT   _T("TOOL21")
 

Definition at line 178 of file tool.h.

#define TOOL_OPTOKEN_TRANSP   _T("TOOL17")
 

Definition at line 175 of file tool.h.

#define TOOL_OPTOKEN_ZOOM   _T("TOOL4")
 

Definition at line 162 of file tool.h.

#define TOOLID_ACCUSOFT   20
 

Definition at line 149 of file tool.h.

#define TOOLID_BEVELTOOL   23
 

Definition at line 152 of file tool.h.

#define TOOLID_BEZTOOL   11
 

Definition at line 140 of file tool.h.

#define TOOLID_BLANK   15
 

Definition at line 144 of file tool.h.

#define TOOLID_BLEND   16
 

Definition at line 145 of file tool.h.

#define TOOLID_CONTOURTOOL   24
 

Definition at line 153 of file tool.h.

#define TOOLID_ELLIPSE   12
 

Definition at line 141 of file tool.h.

#define TOOLID_FREEHAND   6
 

Definition at line 135 of file tool.h.

#define TOOLID_GRADFILL   13
 

Definition at line 142 of file tool.h.

#define TOOLID_GRID   10
 

Definition at line 139 of file tool.h.

#define TOOLID_INVALID   0
 

Definition at line 129 of file tool.h.

#define TOOLID_LIVEEFFECT   26
 

Definition at line 155 of file tool.h.

#define TOOLID_MOULD   19
 

Definition at line 148 of file tool.h.

#define TOOLID_PEN   14
 

Definition at line 143 of file tool.h.

#define TOOLID_PUSH   3
 

Definition at line 132 of file tool.h.

#define TOOLID_RECT   8
 

Definition at line 137 of file tool.h.

#define TOOLID_RECTANGLE   5
 

Definition at line 134 of file tool.h.

#define TOOLID_REGSHAPE   18
 

Definition at line 147 of file tool.h.

#define TOOLID_ROTATE   9
 

Definition at line 138 of file tool.h.

#define TOOLID_SELECTOR   7
 

Definition at line 136 of file tool.h.

#define TOOLID_SLICETOOL   25
 

Definition at line 154 of file tool.h.

#define TOOLID_SOFTSHADOW   22
 

Definition at line 151 of file tool.h.

#define TOOLID_TEST   2
 

Definition at line 131 of file tool.h.

#define TOOLID_TEXT   21
 

Definition at line 150 of file tool.h.

#define TOOLID_TRANSP   17
 

Definition at line 146 of file tool.h.

#define TOOLID_ZOOM   4
 

Definition at line 133 of file tool.h.


Enumeration Type Documentation

enum DragEndType
 

Comment: Describes how a drag was ended. Dragging operations can call the tools virtual function DragFinished() with a var of this type so that the tool can take appropriate action. NB. the tool can cancel the effects of a drag by returning FALSE from the DragFinished() function. THERE IS NO* NEED TO DO THIS IF YOU RECEIVE A CALL TO DragFinished() WITH THE DT_CANCELLED PARAMETER! MonoOn DT_CANCELLED, // the drag was cancelled by the user (eg. ESC pressed) DT_DIDNOTMOVE, // The Drag did not move at all DT_MOVEDTOSAME, // The Drag moved but ended up in the same place DT_MOVEDTODIFF // The drag moved & ended up in a different place MonoOff

Enumerator:
DT_CANCELLED 
DT_DIDNOTMOVE 
DT_MOVEDTOSAME 
DT_MOVEDTODIFF 

Definition at line 289 of file tool.h.

00290 {
00291     DT_CANCELLED,           // the drag was cancelled by the user (eg. ESC pressed)
00292     DT_DIDNOTMOVE,          // The Drag did not move at all
00293     DT_MOVEDTOSAME,         // The Drag moved but ended up in the same place
00294     DT_MOVEDTODIFF          // The drag moved & ended up in a different place
00295 };


Variable Documentation

const UINT32 TOOLID_MAX = 99
 

Definition at line 185 of file tool.h.


Generated on Sat Nov 10 03:49:21 2007 for Camelot by  doxygen 1.4.4