Camelot Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
_NEW_DOCINFOA
_NEW_DOCINFOW
ABC
ABFXBayerColour
ABFXBayerMono
ABFXBrightnessContrast
ABFXDiffusionColour
ABFXDiffusionMono
ABFXFlipX
ABFXFlipY
ABFXHalftoneMono
ABFXMakeGreyscale
ABFXOctree
ABFXPopularityColour
ABFXRemoveDither
ABFXResize
ABFXRotate180
ABFXRotate270
ABFXRotate90
ABFXSharpenBlur
ABFXSpecialEffect
AboutDlgThe about dialogue shows information on the Camelot program version number and details on the environment in which Camelot is executing
AbstractTextCharThis is the base class for all VisibleTextNodes which have an associated Unicode character
AccusoftBitmapEffectBase class for all accusoft bitmap effects
AccusoftBMPOILFilterProvide the OIL parts of the Accusoft BMP filter
AccusoftOILFilterProvide the OIL parts of the Accusoft filters
AcornDrawFilterEncapsulates an RISC OS Draw input filter system
ActionThis class represents an Action which is an individual job which is executed to accomplish an operation. An operation contains lists of actions to perform Undo, Redo and Smart Duplication
ActionApplyPlugInToBitmapWhen executed, this sets up an action to redo/undo an apply a plug-in to a bitmap
ActionColourChangeWhen executed, this copies the IndexedColour 'Defn' over the top of the IndexedColour 'Target', so that Target is redefined. This is used to undo/redo colour edits. A flag 'ChangeIsinvisible' is used to tell whether to broadcast a ColourChangingMsg COLOURUPDATED or COLOURUPDATEDINVISIBLE when the change is applied
ActionHideColoursWhen executed, sets/clears an IndexedColour's 'deleted' flag, so that it becomes {un}hidden - this is then un/redoable by using a HideAction with the opposite 'HideFlag' value
ActionListAn ActionList is a list object which holds actions which can be executed. It is used by Operation objects to hold UNDO, REDO and Smart duplicate actions
ActionPageResizeWhen executed, this sets up an action to redo/undo a page resize
ActionSetDefaultGridWhen executed, this sets up an action to redo/undo a default grid resize
ActiveDlgStateItemStored on an ActiveDlgStateStack. See this class for a definition of its purpose
ActiveDlgStateStackAn ActiveDlgStateStack holds ActiveDlgStateItems. Whenever a MODAL dialog is closed we will need to restore the previously active window. What's more if the previously active window is a MODAL dialog , then we must disable the mainframe and other popups owned by the mainframe; so that the dialog continues to behave modally. This stack stores this information
AdditionalVirtKeyUsed to store 'additional' known virtual key codes so the range of handled keys can be extended at runtime
AddPressurePointsActionAn action which adds points to the Pressure list of a BrushAttValue
AddTimeStampPointsActionAn action which adds points to the timestamping list of a BrushAttValue
AddWebFoldersParam
AdobeColourSwatchFilterAdobe Colour Swatch palette filter
AdobeColourSwatchOILFilterProvide the OIL parts of the Adobe Colour Swatch file filter
AdobeColourTableFilterAdobe Colour Table palette filter
AdobeColourTableOILFilterProvide the OIL parts of the Adobe Colour Table file filter
AI5EPSFilterA filter that imports EPS files in Adobe Illustrator 7.0 EPS format
AI5EPSOILFilterProvide the OIL parts of the Illustrator 5.0 EPS filter
AI5GradientUsed to hold the definition of an Illustrator 5 gradient fill, while we are importing an AI5 file
AI8EPSFilterAllows us to import Adobe Illustrator 8.0 files. (at the time of writing only the version 7.0 documentation was available so some omissions are inevitable)
AI8EPSOILFilterProvide the OIL parts of the Illustrator 8.0 EPS filter
AIBitmapProcessorHelps with the import of Adobe Illustrator 8.0 files. (at the time of writing only the version 7.0 documentation was available so some omissions are inevitable). It creates a list of bitmaps from the input stream
AIEPSFilterA filter that imports EPS files in Adobe Illustrator EPS format
AIEPSGradientScanRenderRegionRenderRegion used to scan through the tree, looking for gradient fills to be cached for Illustrator export
AIEPSOILFilterProvide the OIL parts of the Illustrator EPS filter
AIEPSRenderRegionA render region for exporting EPS files in Adobe Illustrator 7.0 EPS format
AIGradientProcessorHelps with the import of Adobe Illustrator 8.0 files. (at the time of writing only the version 7.0 documentation was available so some omissions are inevitable). It creates a list gradient fills and allows the filter to extract them
AIHighlightHelps with the import of Adobe Illustrator 8.0 files. Holds the definition of a highlight to be used in subsequent fills. (not interpreted at present)
AILayerProcessorHelps with the import of an Adobe Illustrator layer. These are defined by a pair of instructions:
AldusFormatOILFilterProvide the OIL parts of the Aldus-format filter
AlignParam
Allocator< T >
Allocator< void >
AllowOpScanPerforms an AllowOp test and update on all the objects which are members of highlighted 'Used Name' items in the Attribute gallery; performs the same, but only on members of a specified set. Notes: The present implementation is not reentrant or thread-safe
AllowOpScan::IsLitUsedName
AllowOpSingleScan
AluPix32
AnimatedBitmapItemSaves out the list of bitmaps currently in the animation sequence
AnimatedGIFImageStores details on the GIF image which is part of an export animation sequence
AnimationColoursTabAllows the user to set various Animation Colours
AnimationPropertiesTabAllows the user to set various Animation properties
AnimExOptnsInvokes the Animation Export Options dialog. This is a two tab form of the GIFAnimationPropertyTabsDlg. The two tabs present are:- Animation colours and the animation properties
AnimPropertiesParamAllows the transfer of data from our Frame Gallery to a current spread object
ApplicationRepresents an instance of the Camelot application
AppliedAttributeAt the moment it allows applied attributes to appear in a list, but will probably supersede the MultiCommonAttrItem class
ApplyActionWhen executed this action will show a node. It will also generate a HideNodeAction action adding it to the opposite Action list
ApplyAttribsToSelectedParamParameters for the OpApplyAttribsToSelected operation. See OpApplyAttribsToSelected::DoWithParam for a description
ApplyPropScan
ApplyScanApplies all the highlighted 'Used Name' items in the Attribute gallery to all the selected objects (if they don't already have them); a single name to all the selected objects if they don't already have it; 'applies' a NodeSetProperty for a set, with default SGNameProps, to the NodeSetSentinel
ApplyScan::ApplyItems
ApplySingleScan
AppPrefsDlg
ArrangeAlignmentAlign object dialog
ArrowRecA class defining a Line ArrowHead Record
ArtWorksEPSFilterA filter that imports EPS files in ArtWorks EPS format
ArtWorksEPSOILFilterProvide the OIL parts of the ArtWorks EPS filter
ArtWorksEPSRenderRegionA render region for exporting ArtWorks EPS format files
async_fstreamConverts fstream to use an async_filebuf
AsynchBitmapImportParam
AsynchClipartImportParam
AsynchDownloadAsynchronous download class - downloads a url to a local file using HTTP Used by the download manager
AsynchDownload::AsynchBindStatusCallback
asynchstreambufAsynch version of streambuf It is assumed that two versions of the file will be open i.e. read and write. The read and write will run in seperate threads. Any access to the file that might fail due to lack of data will cause the read thread to sleep until more data is available. It is assumed that the write thread will never seek - this would corrupt the BytesAvailable count
ATMFontA class description of our ATM fonts. Mainly uses all base class functions at the moment, apart from the type
ATMFontManA static class to allow access to Type 1 fonts. There are few functions in this class which should be called directly. The OILFontMan provides the generic interface of font calls within this application
AtomicTagListKeeps a list of all the atomic tags present in the imported file
AtomicTagListItemAn item that appears in the AtomicTagList
AttrBevelBase class for bevel attributes
AttrBevelContrastBevel indent attribute
AttrBevelIndentBevel indent attribute
AttrBevelLightAngleBevel indent attribute
AttrBevelLightTiltBevel indent attribute
AttrBevelTypeBevel indent attribute
AttrBitmapChangeChange Bitmap Attribute class. This Attribute never exists in the Tree. It is used for changing a Bitmap Fill
AttrBitmapColourFillBitmap Graduated Colour Fill Attribute class
AttrBitmapDpiChangeChange Fill Transp Type Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp type of an existing Fill Geometry
AttrBitmapFillBitmap Fill Attribute class
AttrBitmapTessChangeChange Fill Transp Type Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp type of an existing Fill Geometry
AttrBitmapTranspFillBitmap Graduated Colour Fill Attribute class
AttrBrushTypeBrushType attribute BrushType attributes are very simple, and merely contain a BrushTypeAttrValue, which is the entity which holds all the info and does all the work
AttrChangedMsgThis message is sent whenever an attribute changes in some way. It is used to update the Grad Fill Info Bar
AttrCircularColourFillRadial Graduated Fill Attribute class
AttrCircularTranspFillRadial Graduated Fill Attribute class
AttrClipView
AttrColFillRampChangeAn attribute to control the changes of colour on a fill ramp
AttrColourChangeChange Fill colour Attribute class. This Attribute never exists in the Tree. It is used for changing the colours of an existing Fill Geometry
AttrColourDrop'Drop a colour on an object' Attribute class. This Attribute never exists in the Tree. It is used for changing the colours of an existing Fill Geometry
AttrConicalColourFillConical Graduated Colour Fill Attribute class
AttrConicalFillConical Fill Attribute class
AttrConicalTranspFillConical Graduated Transparency Fill Attribute class
AttrDashPatternDash Pattern Attribute class
AttrdCharBoundsCacheEntryGet the bounds of a char specified by the char descriptor at default size
AttrEndArrowEnd Arrow Attribute class
AttrFeather
AttrFillEffectFill effect Attribute class
AttrFillEffectAltRainbowAlternate Rainbow (HSV) fill effect Attribute class
AttrFillEffectFadeRGB Fade fill effect Attribute class
AttrFillEffectRainbowRainbow (HSV) fill effect Attribute class
AttrFillGeometryFill Geometry Attribute class
AttrFillMappingFractal Transparency Fill Attribute class. Fill mapping Attribute class
AttrFillMappingLinearLinear fill mapping Attribute class
AttrFillMappingSinSinusoidal fill mapping class Attribute class
AttrFlatColourFillFlat Colour Fill Attribute class
AttrFlatFillFlat Fill colour Attribute class
AttrFlatTranspFillFlat Transparency Fill Attribute class
AttrFourColColourFillFourCol Graduated Colour Fill Attribute class
AttrFourColFillFourCol Graduated Fill Attribute class
AttrFourColTranspFillFour point graduated transparency Fill Attribute class
AttrFractalChangeChange Fractal Attribute class. This Attribute never exists in the Tree. It is used for changing a Fractal Fill
AttrFractalColourFillFractal Colour Fill Attribute class
AttrFractalFillFractal Fill Attribute class
AttrFractalGrainChangeChange Fill Transp Type Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp type of an existing Fill Geometry
AttrFractalTileableChangeChange Fractal Tileable Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp type of an existing Fill Geometry
AttrFractalTranspFillFractal Transparency Fill Attribute class
AttributeAgglomeratorAn AttributeAgglomerator finds the Common Attributes among the nodes provided by an RenderableNodeEnumerator. This allows us to derive classes to retrieve more specialized attributes, namely AttrUser's. Notes: This code was copied from Range. It should either replace the code there or be thrown out when plug-in attributes are supported
AttributeEntry
AttributeGroupThe current attribute group object consists of a group identifier, and a list of attribute nodes which belong to the group. It is used by the AttributeManager
AttributeGroupItemAttributeGroupItem
AttributeManagerThe attribute manager is currently responsible for managing the application of current attributes. It contains a list of Attribute groups along with instances of current attributes which belong to each group. An attribute group is identified by the RuntimeClass of an object
AttributeRecEncapsulates an item in the RenderStack class
AttributeValueTo encapsulate rendering attributes. Derivations of NodeAttribute will hold an instance of this class (or derivation of it) to store the attribute information - this instance field should always be called 'Value'. An AttributeValue object is capable of being pushed onto and popped off the render context stack, and being rendered. This is accomplished by using virtual functions to perform these operations
AttrImagesettingBase class from which all imagesetting attributes are derived
AttrJoinTypeJoinType Attribute class
AttrLinearColourFillLinear Graduated Colour Fill Attribute class
AttrLinearFillLinear Graduated Fill Attribute class
AttrLinearTranspFillLinear Graduated Transparency Fill Attribute class
AttrLineWidthLine Width Attribute class
AttrMakeFlatTranspForce object to be 50% transparent This Attribute never exists in the Tree. It is used for changing the Transp of an existing Fill Geometry
AttrMitreLimitMitre Limit Attribute class
AttrMouldMould Attribute class
AttrNoiseColourFillNoisy colour Fill Attribute class
AttrNoiseScaleChangeChange Noise fill class This Attribute never exists in the Tree. It is used for changing a Noise fill
AttrNoiseTranspFillNoisy transparent Fill Attribute class
AttrOverprintFillAttribute indicating if overprint-Fill is enabled or disabled
AttrOverprintLineAttribute indicating if overprint-line is enabled or disabled
AttrPrintOnAllPlatesAttribute indicating if "print on all plates" is enabled or disabled
AttrQualityQuality NodeAttribute class
AttrRadialColourFillRadial Graduated Colour Fill Attribute class
AttrRadialFillRadial Graduated Fill Attribute class
AttrRadialTranspFillRadial Graduated Transp Fill Attribute class
AttrRecordItemUsed to record the state of an AttributeEntry array
AttrRecordListUsed to store a stack of AttributeEntry states. Used by filters that need to keep an attribute state stack (eg the RTF filter)
AttrRemoveStrokeTranspRemoves the transparency from objects. This Attribute never exists in the Tree. It is used for changing the Transp of an existing Fill Geometry
AttrRemoveTranspRemoves the transparency from objects. This Attribute never exists in the Tree. It is used for changing the Transp of an existing Fill Geometry
AttrSquareColourFillSquare Graduated Colour Fill Attribute class
AttrSquareFillSquare Graduated Fill Attribute class
AttrSquareTranspFillSquare Graduated Transparency Fill Attribute class
AttrStartArrowStart Arrow Attribute class
AttrStartCapStart Cap Attribute class
AttrStrokeColourStroke Colour Attribute class
AttrStrokeColourChangeChange Stroke colour Attribute class. This Attribute never exists in the Tree. It is used for changing the colours of an existing Stroke
AttrStrokeTranspStroke Transparency Attribute class
AttrStrokeTranspChangeChange Stroke transparency Attribute class. This Attribute never exists in the Tree. It is used for changing the transp of an existing Stroke
AttrStrokeTranspTypeChangeChange Stroke transparency Attribute class. This Attribute never exists in the Tree. It is used for changing the transp of an existing Stroke
AttrStrokeTypeStrokeType attribute StrokeType attributes are very simple, and merely contain a StrokeTypeAttrValue, which is the entity which holds all the info and does all the work
AttrTextureColourFillTexture fill attribute class. Acts as a base class for common code used by texture fills such as FractalColourFill and NoiseColourFill DO NOT INSTATIATE AN OBJECT OF THIS TYPE!
AttrTextureTranspFillFractal Colour Fill Attribute class. Transparency base class for textures
AttrThreeColColourFillThreeCol Graduated Colour Fill Attribute class
AttrThreeColFillThreeCol Graduated Fill Attribute class
AttrThreeColTranspFillThreeCol Graduated Transparency Fill Attribute class
AttrTranspChangeChange Fill colour Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp of an existing Fill Geometry
AttrTranspFillGeometry
AttrTranspFillMappingFill mapping Attribute class
AttrTranspFillMappingLinearLinear fill mapping Attribute class
AttrTranspFillMappingSinSinusoidal fill mapping class Attribute class
AttrTranspFillRampChangeAn attribute to control the changes of transparency on a fill ramp
AttrTranspTypeChangeChange Fill Transp Type Attribute class. This Attribute never exists in the Tree. It is used for changing the Transp type of an existing Fill Geometry
AttrTxtAspectRatioAttrTxtAspectRatio specifies the aspect ratio of text
AttrTxtBaseAttrTxtBase is the base class from which all text attribute nodes are derived
AttrTxtBaseLineAttrTxtBaseLine: specifies an absolute offset from the base-line
AttrTxtBoldAttrTxtBold specifies if text is bold or not
AttrTxtFirstIndentAttrTxtFirstIndent: specifies the first line indent
AttrTxtFontSizeAttrTxtFontSize: specifies the size of a font (height)
AttrTxtFontTypefaceAttrTxtFontTypeface specifies a font typeface
AttrTxtItalicAttrTxtFontTypeface specifies if text is italic or not
AttrTxtJustificationAttrTxtJustification specifies how text is justified
AttrTxtLeftMarginAttrTxtLeftMargin: specifies the left margin
AttrTxtLineSpaceAttrTxtLineSpace: specifies the size of a font (height)
AttrTxtRightMarginAttrTxtRightMargin: specifies the right margin
AttrTxtRulerAttrTxtRuler: specifies the ruler
AttrTxtScriptAttrTxtScript: Specifies sub/super script
AttrTxtTrackingAttrTxtTracking specifies text tracking
AttrTxtUnderlineAttrTxtUnderline specifies if text is underlined or not
AttrTypeItemAttrTypeItem's are held in AttrTypeSets
AttrTypeSetA set of AttrTypeitems
AttrUserUser Attribute Node
AttrValueChangeChange Fill colour Attribute class. This Attribute never exists in the Tree. It is used for changing the colours of an existing Fill Geometry
AttrVariableWidthVariableWidth attribute VariableWidth attributes are very simple, and merely contain a VariableWidthAttrValue, which is the entity which holds all the info and does all the work
AttrWebAddressThe new Web Address attribute. This is distinct from the old Web Address attribute from CorelXARA 1.5, which was a type of AttrUser
AttrWindingRuleWinding Rule Attribute class
AutoCleanOILFilter
AutoDeleteCCObjectSimplifies cleanup of temporary CCObject derived objects
AUX_DATA
AvailablePropertiesListProvides a visible list of template handlers
AvailablePropertyThis abstract class represent an item in the "Available Properties" list
BarControlThis defines a control and its associated OpDescriptor within a bar. It holds separate horz and vert versions of the control in case the appearence and/or functionality changes with the orientation of the bar
BarControlBaseBase class from which all bar control classes are derived
BarControlInfoA class that encapsulates the minimum data required to specify a control on a bar. The info is platform independant
BarCreateAbstract class for creating DialogBarOps and derived classes. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile
BarCreationDlgDialog to make building button bar rollovers easier
BarDataTypeAttributes of bars
BarItemA virtual class used for deriving all types of bar item
BarLineFeedDefines a new line after the item before this one. Can be viewed as a 'LF/CR' char pair when look at as a formatting item
BarMsg
BarNewPageDefines a gap between the item before this one and the one that follows. Can be viewed as a 'space' char when look at as a formatting item
BarRedefineStateDlg
BarSeparatorDefines a gap between the item before this one and the one that follows. Can be viewed as a 'space' char when look at as a formatting item
BarStatesDlgDialog to make building button bar states
BarTableProvide an array of window handles for all the existing Camelot bars. This enables us to get bubble help to behave correctly, i.e. when the cursor is over the bar, the bubble help goes away, but the delay timer for bubble help is not restarted
BarToolButton
BaseBar
BaseBitmapFilterBase class for bitmap filters. (Currently export only). Inherited classes tend to be in the OIL layer. The base class fails on both imports & exports, so you only need to override the half that you implement
BaseCamelotFilterThis filter is for the new web file format which is the minimilistic form of the new version 2 native file filter. Derive off VectorFilter as this is what this file format defines
BaseDocumentA simple base class document object
BaseFileDialogTo provide a custom File Save / Open Dialog that goes to the correct directory etc
BaseNameObjectsDlgBase class UI dialogs which create and rename sets of objects in the Attribute gallery
BasePMFilterProvides most of the the handling for the PPM, PGM and PBM filters
BaseSelectScanBase class for scans which select objects which are in the SGNameItem sets
BaseTextActionBase class of all text actions
BaseTextClassThe root of the TextObject hierarchy
BecomeAClass that encapsulates the params needed by virtual Node::DoBecomeA()
BevelAttributePathProcessorThis is the path processor which is used by the AttrBevelType node to do passbacks etc
BevelAttributeValueContrastSets the indent attribute
BevelAttributeValueIndentSets the indent attribute
BevelAttributeValueLightAngleSets the indent attribute
BevelAttributeValueLightTiltSets the indent attribute
BevelAttributeValueTypeSets the indent attribute
BevelComboMap
BevelHelpers
BevelInfoBarOpClass for handling the Bevel tool's information bar
BevelInfoBarOpCreateClass for creating BevelInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
BevelPathProcessorThis is the bevel path processor. It is used to combine all the paths rendered so that the next bevel node can render them
BevelRecordHandlerHandles the reading of all bevel attribute records in the v2 file format
BezierToolThis class handles the Free Hand Tool that is used to draw lines that follow the path of the Mouse Pointer
BezToolInfoBarOpClass for handling the bezier tool's information bar
BezToolInfoBarOpCreateClass for creating BezToolInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
BfxALUArithmetic and logic unit for bitmap effects
BfxALULUT
BfxBrightnessContrastProvides storage for details on a BfxBrightnessContrast plug-in
BfxBrightnessContrastDlg
BfxColourDepthProvides storage for details on a BfxColourDepth plug-in
BfxColourDepthDlg
BfxColourThresholdPixelOpPixel operator
BfxColourThresholdPixelOpPseudoPixel operator
BfxDlg
BfxErrorRegionList
BfxErrorRegionListItemStores error region list for tracing
BfxFlipAndRotateProvides storage for details on a BfxFlipAndRotate plug-in
BfxFlipAndRotateDlg
BfxHandlerProvides BFX plug-in handling characteristics. It handles defining what file types BFX plug-ins have and how to parse them. As these are the built in filters, they are just added when the handler is inited
BfxMsgThis is a foolish message to bring up a bitmap effects dialog
BfxOpHandles insertion of bitmap effect nodes into the tree
BfxOpParam
BfxPixelOp
BfxPixelOp24
BfxPixelOp32
BfxPixelOpPseudo
BfxPlugInProvides storage for details on a BFX plug-in
BfxPlugInContextMenuImplements the Bfx plug-ins context sensitive menus
BfxPlugInDlg
BfxPlugInOpOperation so that a BFX plug-ins can be invoked and used
BfxPlugInUndoOpUndoable Operation so that a Bfx plug-ins can be invoked and used
BfxPositivePixelOpPixel operator
BfxPositivePixelOpPseudoPixel operator
BfxResizeProvides storage for details on a BfxResize plug-in
BfxResizeDlg
BfxSpecialEffectsProvides storage for details on a BfxSpecialEffects plug-in
BfxSpecialEffectsDlg
BfxThresholdPixelOpPixel operator
BfxThresholdPixelOpPseudoPixel operator
BGR
BGRT
BidirectionalIterator< T, Distance >
BidirectionalIteratorTag
BITMAP
BitmapClipMapDescribes and handles import/export mappings for bitmaps
BITMAPCOREHEADER
BitmapDownloadParamDownload operation parameter structure - passes the minimum necessary information to the Op
BitmapDragInformationContains info that a Bitmapdrag may find useful
BitmapEffectBase class for all bitmap effects
BitmapEffectAtomBase class for all bitmap effect atoms
BitmapEffectBaseBase class for all bitmap effects
BitmapEffectSILT
BitmapExportDocumentA special document used for exporting single bitmaps It contains a single layer with a single NodeBitmap object
BitmapExportOptionsBase class for storing information about the bitmap we're exporting
BitmapExportPaletteControl
BitmapExportPaletteInterface
BitmapExportParamPasses infomation about bitmap(s) to export
BitmapExportPreviewDialog
BITMAPFILEHEADER
BitmapFillAttributeSpecifies a bitmap fill attribute for an object
BitmapFilterAllows filter families to contain all bitmap formats. All filters that load pure bitmap files (TIFF, JPEG, BMP etc) should be derived from this class. Some file formats contain mixes of vector and bitmap graphics (e.g. EPS) - in this case, always derive from the VectorFilter
BitmapFilterFamilyA filter for all bitmap file types. e.g. BMP, JPEG, PCX etc
BitmapImportOptionsBase class for storing import options It's not actually used much though..
BitmapImportParam
BitmapImportResultsProvides the results for the import Notes: m_bValid should be checked for TRUE after any construction because the constructor can fail Scope: public
BITMAPINFO
BitmapInfo
BITMAPINFOHEADER
BitmapListA list of Kernel Bitmaps used by a document
BitmapListChangedMsgThis message is sent whenever the document bitmap list changes in some way
BitmapListComponentProvide a component that contains a list of kernel bitmaps in use by a document
BitmapListComponentClassProvide a class that will add Bitmap components to new documents
BitmapPreviewData
BitmapPropertiesRecordHandlerHandles the reading of bitmap properties records
BitmapPtrA simple class containing a pointer to a kernel bitmap, so we can build lists with them
BitmapRecordHandlerProvide a bitmap record handler for the new native and web file formats. This asks the bitmap document component to import the bitmap definitions for us
BitmapSavePoolA list of Kernel Bitmaps to save out
BitmapSequenceMaintains a sequence of bitmaps
BitmapSequenceInfoDescribes a BitmapSequence
BitmapSGalleryThe Bitmap SuperGallery class
BitmapSmoothingRecordHandlerHandles the reading of document bitmap smoothing flag record
BitmapSourceObjects of this class encapsulate the original source for a bitmap. Scope: public
BitmapTranspFillAttributeSpecifies a bitmap fill attribute for an object
BlankInfoBarOpClass for handling the tool's information bar
BlankToolA template tool class
BlendAttrParamClass that encapsulates the params needed by virtual NodeAttribute::Blend()
BlendBecomeAThis is the class that is passed to other nodes when blenders try and get them to to turn into other types via their DoBecomeA() method
BlendedBrushDefinitionStores a vector Brush definition created by blending two other brush definitions. Unlike regular brush definitions these are not stored in the brush component, instead they are attached to a BlendPathProcessorBrush for the purposes of rendering and are then destroyed They are also created differently, rather than passing in a subtree of nodes instead they are given already blended blendpaths and attribute maps
BlendedPathProcessorBrushThis class of path processor is generated when two brushed nodes are blended. It differs from a regular PPB in that it does not retrieve its ink objects from a brush definition stored in the brush component, instead it has its own pointer to a BlendedBrushDefinition object
BlenderInfoItemHolds info on a given blender. This is used when blending a blend to a blend, or a blend to an object, as all the NodeBlenders in a given NodeBlend have to be temporarily deinitialised while the objects are contatinated
BlendHelpersThis encapsulates the blend functions which are needed to blend compound nodes (e.g. shadows etc)
BlendInfoBarOpClass for handling the tool's information bar
BlendInfoBarOpCreateClass for creating BlendInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
BlendNodeParamClass which encapsulates data for blending between nodes We need all these so we don't duplicate code between this node and the blender (unfortunately)
BlendPathThis contains a NodePath, plus other data, generated by an object that is blended
BlendPathBecomeAThis gets a list of all the blenders in pNodeBlend. The it calls Deinit() followed by Reinit() on the blenders. The Reinit() is sent the actual object pointers to the objects they blended
BlendPathOffsetStores the translation of the blendpath to the centre of its parent object
BlendRecordHandlerHandles the reading of all blend records in the v2 file format
BlendRefContains all the data that a NodeBlender needs about another node in the tree which it is blending
BlendSubRenderContextUsed during rendering to store the render context of a blender node if it has taken too long to render so far
BlendToolThe blend tool class
BlendToolRefA class that represents a start or end of a blend. The start ref is used when a click occurs. The end ref is used at the end of a drag
BlobbyBar
BlobbyDlg
BlobbyOp
BlobbyTabDlg
BlobManagerClass to Manage the various types of selection blobs in Camelot. Currently Camelot knows about the following forms of selection blob :-
BlobStyleClass for holding which blobs are required and which are not. Objects of this class are passed into the Blob Manager to tell it which of the blobs a tool wants to display and should be used something like this :- MonoOn BlobStyle ThisToolsBlobs; ThisToolsBlobs.Object = TRUE; // Display Object blobs in this tool ThisToolsBlobs.Fill = TRUE; // Display Fill blobs in this tool BlobManager->ToolInterest(ThisToolsBlobs); MonoOff
BmapPrevDlg
BmpDlg
BmpDlgParamThis will allow data (for delay between frames in animation) to be passed to and from the Bitmap Properties Dialog
BMPExportOptionsBase class for storing information about the bitmap we're exporting
BMPFilterEncapsulates a Windows BMP export filter. Will probably import one day too
BMPOILFilterProvide the OIL parts of the BMP filter
BmpPrefsDlg
BodgeTextClipMapDescribes and handles import/export mappings for UNICODE text
BodgeUnicodeClipMapDescribes and handles import/export mappings for UNICODE text
BrookTroutOILFilterProvide the OIL parts of the DBrookTroutCX filter which loads in the file as a BMP
BrowserPreviewOptions
BrowserPrvwChgdMsgMessages detailing specific changes to the Browsser preview properties
BrushAttrItemRepresents a brush attribute user-interface item within the line gallery
BrushAttrRecordHandler
BrushAttrValueBrush attribute value
BrushBecomeAThis class is passed to inknodes when we wish to turn them into blendpaths that we can use to make brushes. This is essentially a simplified version of BlendBecomeA
BrushBecomeAGroupTheres no real facility for extracting the brush objects and passing them back, however this provides some sort of workaround, as it will store all the brush objects in a group
BrushComponentA document component for handling Brush definitions
BrushComponentClassThe class that gets a Brush doc component going on start up We need to register our class as a document component and this is where we do it all
BrushDataA repository for all kinds of data that the brush uses. More of a struct than a class at the moment
BrushDefinitionStores a vector Brush definition A static list of these items is held in the BrushComponent
BrushDefMsgA message broadcast when a brush definition is edited. This enables things that represent the brush definition (such as the combo in the freeinfobar) to update themselves
BrushMsgA message broadcast by a brush when it becomes selected as the default brush
BrushPointInfoTo store information about brush objects, including pressure
BrushRef'wrapper' for the blendref class for use with the brush. Contains the information that the nodebrushmaker needs to draw the brush objects
BrushRefBlenderAn instance of this class is designed to take two BrushRef objects and blend together their paths and attributes, churning out a BlendedBrushRef object at the end. It essentially rips off a lot of what the NodeBlender does, except that instead of rendering anything or existing in the tree it just produces a blended object
BrushSubRenderContextUsed during rendering to store the render context of a brush node if it has taken too long to render so far
BubbleHelpWndProvide a special window class for bubble help windows. This window has a number of special properties. It knows how big to make itself, and where to position itself - you just create one, tell it what text to display and then tell it to show itself. It's fabby, believe you me. It registers a special window class with the CS_SAVEBITS flag so that the window update is really snappy when it goes away (this flag tells Windows to cache the windows under the bubble help window in a bitmap, and then blit that back onto the screen when the bubble goes away - the same as menus do automatically)
BuildMouldActionWhen executed this action will get the mould to rebuild itself
ButtonRepresents a button in a DialogOp
CacheBlock
CachedFontItemA font item cached by the font manager
CachedFractalA Fractal that has been cached
CachedObjectAll objects that we want to add to the ObjectCache must be derived from a CachedObject base class
CacheEntryDownloadCache support structure. Encapsulates an entry into the cache file table
CacheRemovalAlgorithmDownloadCache support structure. Implements the cache removal algorithm. When the cache fills up, files with lower priority will be discarded first (see CacheEntry::Priority); for files of equal priority we compare the time stamps
CALSOILFilterProvide the OIL parts of the CALS filter which loads in the file as a BMP
CamArtProviderA derived event handler which providers art for bitmap buttons and other controls within Camelot Notes: In the OIL See Also:
CamCache
CamelotEPSFilterA filter that imports EPS files in Camelot EPS format
CamelotEPSFilter::_BitmapAttrs
CamelotEPSOILFilterProvide the OIL parts of the ArtWorks EPS filter
CamelotEPSRenderRegionA render region for exporting files in the native EPS format
CamelotFileRecordThis derived class does all the things that are Camelot-specific
CamelotNativeEPSFilterThis filter will be almost the same as Camelot EPS, only it will hold a little more information and store data slightly more efficiently. Mainly, it will save out bitmaps as binary. It won't really be valid EPS as it will not always be ascii. The Native file format is being done this way as it will take little or no effort to do this
CamelotNativeFilterThis filter is for the new Native file format which comes after the version 1.1 ready for version 2. The BaseCamelotFilter provides common functionality for both this and the web file filter as they are essentially the same thing
CamelotNULLNativeFilterThis is a dummy filter that is used to calculate the size of the file that will be exported
CamelotNULLWebFilterThis is a dummy filter that is used to calculate the size of the file that will be exported
CamelotRecordHandlerThis is the class that encapsulates a camelot-specific record handler in the new v2 format
CamelotTreeItemDataHold pointer to CCObject associated with a wxTreeCtrl item
CamelotWebFilterThis filter is for the new web file format which is the minimilistic form of the new version 2 native file filter. The BaseCamelotFilter provides common functionality for both this and the web file filter as they are essentially the same thing
CamErrorDialogThe underlying function for [Tool-Module]Inform[Warning-Error]
CamIPCServer
CamLaunchProcessLaunch a long-running asynchronous process
CamPlatformDependentA derived clas for implementing wx-platform depedent Oil activity Notes: In the OIL See Also:
CamProcess
CamProfileTo time various bits of the Camelot subsytem Notes: In the OIL See Also: CamProfiler
CamProfilerTo report on time taken in various CamProfile sections Notes: In the OIL See Also: CamProfile
CamResourceTo control the translation of resources within Camelot Notes: In the OIL See Also:
CamResourceFixNameEntry
CamResourceRemember
CapabilityTreeThis is the class representing the wntire capability tree
CaptureHold current bitmap cacheing state during rendering and functionality to store bitmaps in cache, detect limits of cached spans, etc
CaptureHandlerAn event handler to centralise the mouse handling during a drag
CarbonCopyOpThis class allows OpClone and OpDuplicate to share common code. Both are derived from it
CaretNodeSome Notes about the Caret
CBaseBrushNameDlgBase class for the dialog that is used to name or rename brushes
CBDDItemInfo
CBDragInfo
CBevelerDoes the bevelling
CBevelFillAbstract base class for all fill types
CBevelFillFlatDo a flat fill
CBevelFillFrameDo a rounded fill
CBevelFillPointDo a pointy fill
CBevelFillRoundDo a rounded fill
CBevelFillRuffleDo a ruffle fill
CBevelFillsEncapsulates all the bevel filling stuff
CBevelFillSmoothDo a smoothed fill
CBevelFillSquareDo a rounded fill
CBGDDBrushItem
CBGDDCachedItem
CBGDDItemInfo
CBGDDKernelBitmapItem
CBGDDResourceItem
CBGDDStrokeItem
CBGDDWxBitmapItem
CBiasGainDlg
CBiasGainGadget
CBitmapCache
CBitmapCacheKey
CBitmapDropDown
CBitmapGridDropDown
CBitmapManipPerforms bitmap manipulations
CBMPBitsConverts & removes Solid on Black 32bit problems!
CBrushEditDlg
CBrushGadget
CC_CLASSINITThis type is important because it is used to build up the runtime class information used by CCObject and CCRuntimeClass. What happens is that any class declared as dynamic has a static instance of an object of this type. This static object is declared by the CC_IMPLEMENT_{DYNAMIC,DYNCREATE} macro. Declaring this object as static means that its constructor is called at program startup (very early on in the initialisation. The constructor is the important part - the object is declared passing in a pointer to the runtime class object (CCRuntimeClass) associated with the class in question. The CC_CLASSINIT then adds this object to the list of classes maintained and used by the CCRuntimeClass class
CCachedBitmap
CCamApp
CCamDocThis is the wxWidgets class for a document type object in the OIL (it was originally part of wxWidgets example app. docvwmdi). It is very simple - its main use is getting hold of the relevant Document object from the kernel layer. wxWidgets calls various member functions when processing commands from the File menu. This class calls down into the kernel to do the actual work
CCamDocTemplateAllows the customisation of the process MFC uses to create, load, and associate its view and document classes
CCamFrame
CCamViewThis OIL class implements many window functions, such as scrolling and sizing the editing windows. As such, it acts as an intermediary between the kernel and the host operating system. It is derived from the wx class wxView, which provides comprehensive methods for managing the client area of a window
CCArchiveArchive class used to save and load the Camelot tree
CCArray< TYPE, ARG_TYPE >
CCAsynchDiskFileFile class that can be used for asynchronous loading. It contains an asynchstreambuf (see above)
CCAttrMapClass that encapsulates lists of attributes in Camelot
CCBinHexFileTranslates data from binary to BinHex format
CCBufferFileProvides a CCStreamFile which can fills two buffer's simultaneously on reading: one is the working buffer (passed to read()), the other is an accumulative buffer (passed in init()). This provides a useful interface with which to fill BitmapSource's Notes: The current implementation follows iostream's handling of eof() and provides only a read() member to fill the buffers
CCClientDC
CCClipBoardFileWill be used to access Windows text clipboard files
CCCoreUIBase class for a UI element
CCDC
CCDiskFileRepresents a file class that can offer buffered disk file I/O in both text and binary modes. Derived from the CCLexFile class so you can use lexical analysis functions on it
CCDummyDC
CCFileRepresents an abstract file class from which all other file classes will be derived. It therefore acts as a generic interface to file handling of all sorts. A routine can read or write to a CCFile object without caring whether it is a real file on disk, or to the clipboard, or to a block of RAM somewhere. This class contains many pure virtual functions, which should be implemented by the derived classes. The basic functions of this class are supplemented by the derived class CCLexFile, which provides functions to perform lexical analysis on a file object. (Note that CCLexFile is also an abstract base class.) The main use of this class will be for the export and import filters. The class and its derivatives in this file used to just call InformError() about any errors that were encountered by the routines. The caller had no control over this so the liklyhood was that users would see a number of errors instead of just one. This is still the default but now all error handling goes through a GotError function which can be made to call InformError() and/or throw an exception. This is controlled by two protected BOOL values and can be either set in the constructor or via the public SetReportErrors and SetThrowExceptions calls. GotError also tries to force the bad(), fail() functions to fail on the next call so that no more file accesses should happen
CCGmtTimeCreates a time object which can be interogated about the current time. If you create a static version of this object you will most likely need to use the GetCurrentTime() function on the object from time to time, otherwise it will inevitable become out of date as time and tide waits for no man. This is not a class to use to time funtions and such. Its accuracy is to the nearest second only. This version returns Greenwich Mean Time rather than Local time
CCLexFile
CCListGadgetWrapper class for the Win95 listview control
CCListGadget::ListEntry
CCMallocCriticalSection
CCMemFileRepresents a memory IO file - IO is in byte units
CCMemTextFileRepresents a character memory IO file which can cope with unicode
CCObjectCCObject is derived from SimpleCCObject, so it provides the same new and delete operators. It also provides facilities for dynamic class information, and dynamic construction of objects
CCOleAccusoftStreamCCOleStream that manages the Accusoft stream switching as well
CCOleStreamRepresents an IStream within an OLE Structured Storage. Uses the custom iostream class costream for its implementation
CColourBarThe CColourBar window - a window like the status bar, which contains a strip of colours that can be used in the selected Document
CCPaintDC
CCPanoseClass to hold and manipulate Panose numbers See also: class FontMan, class ATMFontMan, class TTFontMan
CCPenThis provides support for Pressure Sensitive Pen devices. Its job is to keep track of the current pressure of a pen. It will automatically mutate itself into either a Real or Pretend pen, depending on what is availble when it is created. If it is a real pen, then it gets it's pressure from mouse messages. If it is a pretend pen, then the pressure is adjusted using either the keyboard (temporarily Keypad +/-) or by using a joystick
CCPrintDialogTo provide a custom Print Dialog
CCPrintInfoTo provide a custom Print Info class
CCPrintToFileDialog
CCreateBevelTrapezoids
CCResourceFileWill be used to access Windows resource files
CCResTextFileWill be used to access Windows resource text files - such as those used in the for Camelot Menu Scripts
CCRuntimeClassProvide run-time class information and dynamic class creation for objects derived from CCObject
CCStatusBarTo override various part of the CStatusBar
CCStreamFileRepresents a file class that uses an iostream type object for direct I/O. CCDiskFile is derived from this, using a standard fstream object for I/O. CCMemFile should be derived from this, but isn't, using a standard strstream object. CCOleStream is also derived from this, using a custom costream object for I/O
cctime
CCTimeCreates a time object which can be interogated about the current time. If you create a static version of this object you will most likely need to use the GetCurrentTime() function on the object from time to time, otherwise it will inevitable become out of date as time and tide waits for no man. This is not a class to use to time funtions and such. Its accuracy is to the nearest second only. This version returns local time
CCTimeBaseThe base class local time generator. Normal time generators should be derived from this
CCUserAttrMap
CCustomList
CCustomListRowWnd
CCustomListScrollableArea
CCWobJob
CDC
CDistanceSamplerDerived class which has a method to sample data over distances. Basically what you want to do is initialise the object, set the sample distances, then pass in data to the CollectData method and this object will sample at the appropriate rate
cdr3DCoord
cdr3DMatrix
CDRActionGroupEndA group end
CDRActionListA list object to store actions which need to be taken after lists in the CDR file have ended
CDRActionListItemA listitem object to store actions which need to be taken after lists in the CDR file have ended
CDRActionTransformA transform action
CDRArrowheadStoreA storage object for arrowheads from a CDR file import
CDRArrowheadStoredItemA list item object for arrowheads from a CDR file import
CDRAttributeStoreA storage object for attributes from a CDR file import
CDRAttributeStoredItemA list item object for attributes from a CDR file import
CDRBBoxListA list of bounding boxes for the CDR filter
CDRBBoxListItemA bounding box list item
CDRBitmapDoes conversion of Corel format bitmaps
CDRBitmapStoreA storage object for bitmaps from a CDR file import
CDRBitmapStoredItemA list item object for bitmaps from a CDR file import
CDRColourTranslation of colours from CDR files
cdrExtrudeInfo
cdrfArrowhead
cdrfBBox
cdrfBitmapData
cdrfBitmapData3
cdrfBitmapHeader
cdrfBitmapHeader4
cdrfBitmapPaletteEntry
cdrfBitmapPaletteEntry4
cdrfColour
cdrfColourV3
cdrfCoord
cdrfEllipseData
cdrfFillFlat
cdrfFillGradColour
cdrfFillGraduated
cdrfFillHeader
cdrfFillPattern
cdrfFillTexture
cdrfFillV3
cdrfFillVector
cdrfFontDefn
cdrfFontDefnV4
cdrfFontStyleTableEntryV3
cdrfFontStyleTableHeaderV3
cdrfFontTableEntryV3
CDRFillInfo
CDRFilterCorel Draw file importing class
cdrfLensDefn
cdrfLinkTableEntryTextOnPath
cdrfLinkTableEntryTextOnPathV3
cdrfLinkTableEntryTextV4
cdrfLinkTableHdr
cdrfMasterLayerInfo
cdrfMasterLayerInfoV3
cdrfOffsetHeader
CDRFontnameStoreA storage object for fontnames from a CDR file import
CDRFontnameStoredItemA list item object for fontnames from a CDR file import
CDRFontnameStoredItemEnumerA class for those tricky font enumerations in the CDR filter
cdrfOutline
cdrfOutlineV3
cdrfPageInfo
cdrfPageInfoV3
cdrfParaDefnV4
cdrfParaTextHeaderV4
cdrfPathCoordHeader
cdrfPatternBitmapHeader
cdrfPerspectiveEntry
cdrfPerspectiveTransform
cdrfRectangleData
cdrfStyle
cdrfStyleReference
cdrfTextCharStyledV3
cdrfTextCharStyledV4
cdrfTextCharV3
cdrfTextCharV4
cdrfTextHeaderV3
cdrfTextHeaderV4
cdrfTextInfoChar
cdrfTextInfoFontDefn
cdrfTextInfoHdr
cdrfTextInfoParaHdr
cdrfTextInfoParaInfo
cdrfTextListCharStyledV4
cdrfTextListCharV4
cdrfTextOnPathInfo
cdrfTextStoryCoordData
cdrfTextStyleAlignment
cdrfTextStyleFont
cdrfTextStyleHdr
cdrfTextStyleSpacing
cdrfTransform
cdrfTransformEntryV3
cdrfTransformEnvelope
cdrfTransformEnvelopeV3
cdrfTransformExtrude
cdrfTransformExtrudeV3
cdrfTransformHeader
cdrfTransformMatrix
cdrfTransformMatrixV3
cdrfTransformMatrixV4
cdrfTransformV3
cdrfTransformV4
CDRLayerListA list object to store layers in a page during the conversion process
CDRLayerListItemA list object to store layers in a page during the conversion process
cdrMatrix
CDROILFilterProvide the OIL parts of the CDR filter
CDRPageListA list object to store all my pages in during the conversion process
CDRPageListItemA list object to store all my pages in during the conversion process
cdrPerspective
CDRTextOnPathLinkA bounding box list item
CDRTextStyle
CDRTiledFillInfo
CDRTransformConvertor
CDRTransformConvertor3
CDRTransformConvertor4
CDRTransformConvertor5
CDRVectorStoreA storage object for vectors from a CDR file import
CDRVectorStoredItemA storage item for vectors from a CDR file import
CFileException
CFileInfoList
CFileInfoList::CListRow
CGadgetImageListKernel-usable class represeting a list of images
CGadgetImageList::ResIDListItem
CGridComboUserData
CGridDropDown
ChangeBitmapPtrActionAn action which undoes the modification of Grad Fill data. This action can be used for undoing changing control points
ChangeBlendActionAn action which changes the one-to-one flag of a blend
ChangeBlenderActionAn action which changes the blender
ChangeBlenderOpParamHolds the info needed to change the blender in a certain way
ChangeBlendOpParamThe param passed to OpChangeBlend::DoWithParam
ChangeBlendStepsActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ChangeBrushActionAn action which changes one of the members of a brush attribute
ChangeBrushDefActionAn action which changes one or all of the members of a brush definition
ChangeBrushDefOpParamThe param passed to OpChangeBrushDefinition::DoWithParam, identical to ChangeBrushOpParam except for 1) it has a brush handle member and 2) it takes its old and new values from its brush definition instead of a path processor
ChangeBrushOpParamThe param passed to OpChangeBrush::DoWithParam
ChangeContourAttributeProfileActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ChangeContourColourTypeActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ChangeContourObjectProfileActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ChangeContourProfileParamThe op param for the creation of contours
ChangeContourStepsActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ChangeContourToInnerActionChanges the node to an inner contour node & regenerates
ChangeContourToOuterActionChanges the node to an outer contour node & regenerates
ChangeContourWidthActionForces a regeneration of the bevel in all nodes in the list Used by NodeBevelcontroller::OnChildChange to force redraws in undos/redos
ChangeContourWidthParamParameter for the change countour operation
ChangeEffectResActionAn action to record/restore the current state of the LiveEffect EditList
ChangeFeatherEffectAction
ChangeFeatherEffectProfileAction
ChangeFeatherProfileAction
ChangeFeatherProfileOpDesc
ChangeFeatherSizeSliderOpDesc
ChangeFillProfileActionAction for changing fill profiles
ChangeGridAn abstract class used for changing aspects of a grid
ChangeGridDivisionsAn abstract class used for changing aspects of a grid
ChangeGridSubdivisionsAn abstract class used for changing aspects of a grid
ChangeGridTypeAn abstract class used for changing aspects of a grid
ChangeGridUnitsAn abstract class used for changing aspects of a grid
ChangeLyrAttribActionWhen executed the ChangeLyrAttribAction changes a layer's Status
ChangeShapeDataActionAn action to toggle a (Boolean or double) value of a regular shape
ChangeShapePathActionAn action to change a path in a regular shape
ChangeShapePointActionAn action to change a point in a regular shape
ChangeTranspFillProfileActionAction for changing transp fill profiles
ChapterChapters group together pages which are automatically created from the same master page
CharDescriptionThe CharDescription structure is used to identify a character within the FontCache. To extract the CharCode from a CharDescription To extract the Typeface Handle from a CharDescription To extract the Bold state from a CharDescription To extract the italic state from a CharDescription
CharMetricsParameter passing of char metrics
CharOutlineCacheA cache for a character outline. This cache can only be accessed via the OILFontMan character outline calls
CHelpDownloadWebDialog
ChildWindowParameters
CHSVChangerSimilar to its parent class but adds the following options:
  • alter HSV values in existing colours, with no replacement colour
  • replace named colours (as parent class) and make HSV changes to all colours whether named or not
CInformErrorDialog
CInitBrushNameDlg
ClassCategoryProbe
ClassRegistryEntryRepresents an entry in CLSID section of the registry, consisting of a key, subkeys, and some values
ClickModifiers
ClipartImportParamThis class represents the Undo-able operation to import and open clipart files
ClipboardMappingA class which describes and implements an available mapping between internal and external data formats. Each filter which can provide a useful clipboard export/import format will register with the ExternalClipboard instance, using an ClipboardMapping object to describe the available mapping, and to provide functions which will invoke that filter on windows clipboard data
ClipboardViewSimple view class for use when rendering (exporting) the clipboard
ClippedInkFlags
ClipRegionAttributeSee also:
ClipViewRecordHandlerHandles the reading of all ClipView records. See also:
ClosestFontEnumerator
CMap< KEY, ARG_KEY, VALUE, ARG_VALUE, BaseClass >
CmdControlA CmdControl is an abstract class from which all types of interface controls inherit. These controls include MenuItems, Keyboard Accelerators, Buttons etc. They all have one main thing in common and that is that they are built out of Operations. Unlike Tools Controls have only one operation behind them.Base class for Camelot menu items. Unfortunately neither Mario or Andy ever got round to documenting this stuff, ha ha ha
CMediaReplayDetect
CMemoryException
CMX16ClipMap
CMX16OILFilterProvide the OIL parts of the CMX filter
CMX32ClipMap
CMX32OILFilterProvide the OIL parts of the CMX filter
CMXClipMapDescribes and handles import mapping for some "QuarkXPress Picture Data"Describes and handles import/export mappings for CMX files
CMXExportDCExport device context for CMX files
CMXExportDC::CMXFutureDataCacheEntry
CMXFileRecord
CMXFilterImport filter for CMX format
CMXFilter16
CMXFilter32
CMXFutureIndex
CMXFutureLength
CMXFutureNumber
CMXFutureUpdater
CMXGroupRecord
CMXImportArrowheads
CMXImportArrowShape
CMXImportColourList
CMXImportColourListItem
CMXImportDotDash
CMXImportFilter
CMXImportFilterDataSet
CMXImportFont
CMXImportLineStyle
CMXImportOILFilterProvide the OIL parts of the CMX import filter
CMXImportOutline
CMXImportPen
CMXImportProcedure
CMXLensBBox
CMXNestedTagRecord
CMXNode
CMXNodeInfoHold information on a node displayed in the tree dialog
CMXNodeTypeStatisticsHolds info relating to a node of a particular type (i.e. tag value)
CMXNodeTypeStatisticsListClass that maintains statistics on the nodes added to the tree
CMXReferArrow
CMXReferArrowheads
CMXReferBitmap
CMXReferBitmapFill
CMXReferColour
CMXReferDefaultDotDash
CMXReferDefaultScreen
CMXReferDotDash
CMXReferLayer
CMXReferLens
CMXReferLineStyle
CMXReferListItem
CMXReferListItemOffset
CMXReferMasterIndex
CMXReferMasterLayer
CMXReferOutline
CMXReferPage
CMXReferPen
CMXRenderRegion
CMXTreeDlg
CMXTreeDlgRecordHandler
CNameBrushDlg
CNamedColourReplacerThis is a somewhat specialised class whose purpose is to temporarily replace the Named colours in a ColourFillAttribute. Its stores the colours that are replaced and can be called upon to put them back at a later time. It was designed for use with the Brush attribute, where we wish to be able to replace named colours in the brush objects, and then change them back. If you can think of any other uses for it then feel free
ColBarDefaultSizeInfo
ColEditContextMenuImplements the colour editor context sensitive menus
ColEditorDragInfoContains info that a colourdrag may find useful - used for drags from the colour editor
ColEditorDragTargetHandles dragging of colours into the colour editor window. Multiple instances of this class are created to handle the different areas of the colour editor (which one they are working on is determined from the gadget ID for which the target is created)
ColEditState
ColourBarMsgHandlerIntercepts messages for the Colour Bar (Keeps the Colourabout which document is selected)
ColourChangeInfo
ColourChangingMsgThis message is sent whenever certain events of importance happen in the colour system. Most of these events relate to IndexedColour lists, or individual IndexedColours. See Develop:Camelot.doc for details
ColourCIET
ColourCMYK
ColourContext
ColourContextArray
ColourContextCMYKObject class representing colour contexts based upon the CMYK colour model (Cyan, Magenta, Yellow, Key)
ColourContextGreyTObject class representing colour contexts based upon the GreyT colour model (Greyscale intensity, Transparent)
ColourContextHSVTObject class representing colour contexts based upon the HSVT colour model (Red, Green, Blue, Transparent)
ColourContextListDefines a list of colour contexts, as must be kept on a global basis. This is a perfectly normal list, except it has a special function to add a ColourContext item to the list, which ensures that no duplicate colour contexts are ever used, and that the usage count for any shared context is properly updated
ColourContextRGBTObject class representing colour contexts based upon the RGBT colour model (Red, Green, Blue, Transparent)
ColourContextWebRGBTThis class inherits from class ColourContextRGBT, and although (at the moment) does not add any new functionality - provides us with an appropriate way of allowing us to edit RGBT in hexadecimal (i.e. rrggbb or 0xrrggbb web format). Reasons for this are: 1) so that I did NOT have to keep copying and pasting code for all the places that a colour model combobox appears. 2) allow us to integrate correctly with the edit dialog (thereby not doing 2). 3) make the addition of subsequent ColourContexts easier (since you won't have to worry about this class at all); and 4) cause I felft like it
ColourDragInformationContains all information about a colour being dragged
ColourDropDownColour drop down class - provides a dropdown list of named colours with colour patch and name, for use in the colour editor etc
ColourDropMsgHandlerIntercepts messages for the Colour Drop Downs to allow them to stay up to date when documents change etc
ColourEditDlg
ColourEditDlgParamThe OpParam to use when Invoke()ing the ColourEditDlg You shouldn't ever need to use this - just call the static function ColourEditDlg::InvokeDialog if you want a colour editor
ColourFillAttributeThe base class for a fill geometry attribute, such as flat, linear, radial, conical, etc. This provides the basic interface for fill rendering
ColourGeneric
ColourGreyT
ColourHSVT
ColourImportContextProvides a colour context to use when importing colours, which allows us to easily import arbitrarily nested linked colours
ColourInfo
ColourLineDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. WinoilDragTargets are used as a base class from which to derive drag targets for WINOIL entities (an optional wxWindow*)
ColourListA colour list is held by each document to store the list of available IndexedColours for use by that document. (This colour list is displayed in the ColourBar/ColourGallery via the ColGalDisplayList which references colours held in the ColourList)
ColourListComponentProvide a component that is linked to a ColourList object. This allows us to save out colour lists using the serialisation facilities of the DocComponent base class
ColourListComponentClassProvide a class that will add Colour List components to new documents
ColourManagerThis class provides miscellaneous shared functions for use by various colour entities. The provided functions are currently:
ColourMatrix
ColourMatrix::elements_t
ColourNameDlg
ColourNameParamAllows the user to edit the name of a colour
ColourPacked
ColourPickerEncapsulates OS-specific colour picker dialogue system, giving a kernel interface for using whatever colour picker(s) are available
ColourPickerDragInformationContains all information about a colour being dragged
ColourPlateUsed as a descriptor defining how a colour context should separate/filter a colour as it is converted
ColourRampThis class holds a list of colour records, each of which describe a colour position in a colour ramp. The list contains the usual add/delete entry members and other suitable interfaces to allow colour ramps to be edited. The list is used inside GradFillAttribute to describe multicoloured fills
ColourRecordHandlerProvide a colour record handler for the new native and web file formats. This asks the colour document component to import the colour definitions for us
ColourRGBT
ColourSGalleryThe Colour SuperGallery class
ColourVector
ColRampItemDefines a single entry in a colour ramp. An entry is simply made up of a single doc colour definition
CombineBecomeAThis is the class that is passed to other nodes when the combine op gets them to to turn into other types via their DoBecomeA() method
CommandMapProvides a mapping from a token (i.e. an integer) to the string representation of that token. An array of these objects is used to map an EPS command string onto the enumerated type used for the token representation within Camelot
CommonAppliedAttributeRepresents an applied attribute of which there is only one for the objects given by the iterator
CommonAttributeItemThis ListItem is used by Range::FindCommonAttributes
CommonAttrMap
CommonAttrMultiSetA CommonAttributeSet. See Range::FindCommonAttributes
CommonAttrsChangedMsgRespond to this message whenever you need to call Range::FindCommonAttribute or Range::FindCommonAttributes to display up-to-date common attribute information to the user. Because FindCommonAttributes returns Current Attributes in some situations, this message is broadcast whenever any of the following msgs are receved by the SelRange
CommonAttrSet
CommonTransInfo
CompatibleFilterA simple ListItem derived class to allow a list of filters to be maintained - the list holds all the filters that claim to understand a particular file (see FilterFamily). It is not derived from the Filter class itself because although the Filter class is derived from ListItem too, we want to store a list of pointers to existing filters, rather than actual instances of the Filter class. For each entry, a 'compatibility rating' is held, to allow the FilterFamily class (the client of this class) to choose the most compatible filter from the list
CompatibleFilterListSimple list class to allow a list of compatible filters to be maintained
CompoundNodeBlendBecomeAGets the compound node to wrap up any nodes passed to the passback in a copy of its tree structure
CompoundNodeTreeFactoryEncapsulates all data needed to create a new compound node of a particular type Abstract base class to be inherited from
CompoundNodeTreeFactoryListA list of the compound node factories necessary to regenerate the shadow/ bevels/other compound nodes after bevelling
CompoundNodeTreeFactoryListItemItem in the CompoundNodeClassFactoryList
CompressionRecordHandlerProvide a compression record handler for the new native and web file formats. This asks the ZLib code within side the CCFile class to turn compression on or off
ConcurrencyControllerEnsures no update conflicts with concurrent users to Camelot
ConcurrentRenderer
config_s
ConicalFillAttributeSpecifies a conical fill attribute for an object, including the vector that defines the centre of the cone, and the angle of the fill
ConicalTranspFillAttributeSpecifies a conical fill attribute for an object, including the vector that defines the centre of the cone, and the angle of the fill
ContextItemProvides information on a context level - see ColourImportContext for more detail
ContextMenuEncapsulate the concept of pop-up, context-sensitive menus at the kernel level
ContourBecomeAThis is used to turn all nodes which are to be contoured into a single path
ContourBecomeA2ContourBecomeA2 class provides a greener alternative to ContourBecomeA
ContourDragBecomeAThis is used to turn all nodes which are to be contoured into a single path for dragging
ContourInfoBarOpClass for handling the tool's information bar
ContourInfoBarOpCreateClass for creating ContourInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
ContourNodePathProcessorThe path processor which is used to sum all paths to be contoured
ContourNodeTreeFactoryCreates a new contour node with the given parameters
ContourRecordHandlerHandles the reading of all contour records
ContourToolThe Contour tool class Notes: Copied from the blend tool
ContourWidthListItemListItem for use in ChangeContourWidthAction's list
ControlEntryContains the information for a particular control. The data members are: MonoOn wxWindow* Window - the handle of the control. OpDescriptor *pOpDesc - pointer to the OpDescriptor associated with this control. WNDPROC WndProc - pointer to the normal WndProc for the subclassed control. MonoOff
ControlHelperProvide a system for subclassing controls on Camelot bars which offers various facilities such as bubble help/status bar text and commit handling. To use this system you use the Notifyxxx() functions to keep the class up to date with which bars/controls exist. This module will subclass these controls and do some preprocessing of Windows messages in order to do bubble help/commit handling etc. You can 'fake' bubble help on a window that doesn't really have controls in it, by using the 'ad-hoc' bubble help function, DoBubbleHelpOn()
ControlHelpInfoUsed to specify details of a control that is to be added to the list of sub-classed controls. The fields are: MonoOn pOpDesc - pointer to the OpDescriptor for this control. If this field is non-NULL, then all the ID fields are ignored. Id this field is NULL, then the ID fields are used to define the bubble help text and status bar text to be displayed for this control. BubbleID - ID of the string resource to be used for bubble help. StatusID - ID of the string resource to be used for status bar text. ModuleID - defines where to find the above resources. Parent - internal use; any value you put in here will be ignored. MonoOff
ControlInfoA list of ConrolInfo ListItem's are stored 'in' a dialog box. They are used to store information which is required in a subclassed controls proc. Currently Edit controls and Button controls create a ControlInfo item when they are subclassed
ControlList
ControlList::ListEntry
ControlPts
ControlTableStores/manipulates an array of ControlEntry objects, in order to keep track of all the controls we have currently subclassed
Conv24to32A 24 to 32 bpp converter
Conv24to8
Conv32to1
Conv32to24
Conv32to32
Conv32to4
Conv32to8
Conv8to32An 8 to 32 bpp converter
ConvertThis class is used to convert things from one form to another. Mainly contains static functions. Started life as a series of conversion functions before being made to see the light and profess the one and only true class. At present in the Winoil class as it needs converting to TCHARs and using the MFC forms of scanf and sprintf .
ConvertPathToShapesBecomeAThe become A structure for the above operation Adds a node into the tree which is the stroked path of the particular node passed into the PassBack function Notes: When stepping through, you MUST store the next node before calling DoBecomeA - since the tree will be changed when PassBack is called in this class
CoordStructure holding a 32-bit cartesian coordinate
CopyBecomeAThis is the BecomeA class that is passed to other nodes when we need to make 'pathified' copy of a subtree. The effect is to create a bunch of nodes which copy identically the specified tree
CopyObjectsToClipboardActionWhen executed as an undo action nothing happens except for the creation of a redo CopyObjectsToClipboardAction
Corel3EPSFilterAn import filter to import EPS files as saved by Corel Draw! 3.x
Corel3EPSOILFilterProvide the OIL parts of the Corel 3.x EPS filter
Corel4EPSFilterAn import filter to import EPS files as saved by Corel Draw! 4.0
Corel4EPSOILFilterProvide the OIL parts of the Corel 4.x EPS filter
CorelEPSFilterA base class filter that implements the core functionality required for a Corel EPS import filter. Other filters are derived from this - this class is never instantiated as it is incomplete
CorelEPSFilter::CCAPI
CorelPaletteFileOILFilterProvide the OIL parts of the Corel Palette file filter
CorelPaletteFilterCorel Palette file importing class
CPathPointInfo
cpl_header
CProfileBiasGain
CProgressBarProgres bar display window for "busy" operations
CreateContourParamThe op param for the creation of contours
CreateDisplayScanScans the 'selected' document and creates/refreshes the groups and items of the Attribute gallery's display
CreateDisplayScan::ClearCounters
CreateDisplayScan::CreateItems
CreateDisplayScan::DelItemIfUnref
CreateDisplayScan::FoldGroupIfEmpty
CreateMouldParamThe OpParam to use when Invoke()ing the CreateNewMould operation
CRenderWndThis OIL class is rendered into. It passes all input to its parent CCamView window
CriticalSection
CSampleDataBase class to hold an array of CSampleItems
CSampleItemBrush sample data item class, records position, distance along the path and pressure at the point when it is recorded
CScrollerButtonThis OIL class extends standard Windows bitmapped buttons so that they respond to clicks with the right mouse-button, and send notification messages as long as they are held down
CScrollerCornerThis OIL class is the little square in the bottom-right of a window featuring horizontal and vertical scroll bars. It is currently completely useless (except visually, of course)
CScrollerThumbThis OIL class represents a scroll bar "thumb", which sends drag messages to its parent CScroller object
CShadowerFlat'Wrapper' for the COM interface CShadowerFlat, which is itself a 'Facade' for the flat shadow generation system. Simply delegates to its owned COM component. See also: CShadowerFlat ( in CShadowerFlat.cpp ) To calculate/estimate the bound of an unshadowed pixmap, given the bound of a (hypothetical) shadowed pixmap,
  • the inverse of CalcShadowBound(). Calculate the rectangular bound of the shadow that would be produced by DrawShadow() given a particular transparency/alpha map. Call this, use the results to allocate a shadow map, then call DrawShadow(). Draw the shadow cast by a particular transparency/alpha map
CSliceSimple class, stores the data required for each slice
CSnapPerforms the snapping required by Camelot
ct_data_s
CTemplateManager
CTransparencyReplacerSimilar to CNamedColourReplacer, this class takes a transparency attribute, changes its values, and then changes them back
CUniversalParamSimple class that makes it possible to have parameters that can either be a pointer or an INT32 in a 64bit safe manner
CurrentAttrChangedMsgThis message is sent whenever the current attributes are updated
CursorEncapsulates OIL cursors, hiding OS specific functions behind a standard sensible interface
CursorIdentUsed in the cursor stack - holds a pointer to a cursor and an identifying ID
CursorMask
CursorStackA stack of Cursor objects, which is part of the kernel (NB Cursor objects are part of the OIL)
Curve
CurveEdge
CurveFitObjectFits bezier curves to a serious of coordinates. Call the constructor, Initialise and finally FitCurve to fit a bezier curve to the coords
CustomizeBarDlg
CustomPropertyProvides a "custom" visible template handler so the user can enter raw user attributes
CViewFileDropTarget
CWindowIDItemA very simple class which contains a CWindowID. A list of CWindowIDItems are stored in the DialogPosition list
CWinScroller
CWxBitmapThe Windows implementation of the OILBitmap class. Based on a non-compressed DIB. Kernel code should not call on functions in this class except via the OILBitmap interface
CXaraFileEncapsulates the v2 file format functionality. It provides a standard way for reading and writing v2 format files
CXaraFileEllipseClass for exporting ellipses in the new file formatAbstract class holding code for exporting ellipses in the new file format
CXaraFileMapTagToHandlerThis class implements a fast way of looking the handler that handles a given tag
CXaraFileNodeBitmapSaving code for node bitmapsAbstract class holding exporting for node bitmaps
CXaraFileNodeGroupRefListHolds a list of nodes and corresponding group objects
CXaraFileNodeGroupRefListItemAn item that appears in the CXaraFileTextStoryGroupRefListHolds a list of text stories and corresponding group objects.An item that appears in the CXaraFileNodeGroupRefList
CXaraFilePathRecordRefListHolds a list of node path objects, and the corresponding record numbers of the records that represent the paths in the file
CXaraFilePathRecordRefListItemAn item that appears in the CXaraFilePathRecordRefList
CXaraFilePolygonAbstract class holding exporting code for polygons in the new file formatAbstract class holding exporting code for polygon for the new file format
CXaraFileRecordThis is the class that encapsulates a record in the new v2 format
CXaraFileRecordHandlerThis is the class that encapsulates a record handler in the new v2 format
CXaraFileRectangleAbstract lass holding exporting code for rectangles in the new file formatAbstract class holding exporting code for rectangles for the new file format
CXaraFileRegularShapeAbstract Base class for exporting regular shapesAbstract class holding importing and exporting code for regular shapes to and from the new file format
CXaraFileTxtAspectRatioExport code for the new file format
CXaraFileTxtBaseLineExport code for the new file format
CXaraFileTxtBoldExport code for the new file format
CXaraFileTxtCaretExporting code for text caret objects for the new file format
CXaraFileTxtCharExporting code for text char objects for the new file format
CXaraFileTxtEOLExporting code for text EOL objects for the new file format
CXaraFileTxtFirstIndentExport code for the new file format
CXaraFileTxtFontSizeExport code for the new file format
CXaraFileTxtFontTypefaceExport code for the new file format
CXaraFileTxtItalicExport code for the new file format
CXaraFileTxtJustificationExport code for the new file format
CXaraFileTxtKernExporting code for text kern objects for the new file format
CXaraFileTxtLeftMarginExport code for the new file format
CXaraFileTxtLineExporting code for text line objects for the new file format
CXaraFileTxtLineSpaceExport code for the new file format
CXaraFileTxtRightMarginExport code for the new file format
CXaraFileTxtRulerExport code for the new file format
CXaraFileTxtScriptExport code for the new file format
CXaraFileTxtStoryExporting code for text stories for the new file format
CXaraFileTxtTabExporting code for tab objects for the new file format
CXaraFileTxtTrackingExport code for the new file format
CXaraFileTxtUnderlineExport code for the new file format
CXaraTemplateFileCXaraFile derived class for handling Flare template files This translates the records written by the standard native format export into the text based format
CXFNode
CXFNodeTypeStatisticsHolds info relating to a node of a particular type (i.e. tag value)
CXFNodeTypeStatisticsListClass that maintains statistics on the nodes added to the tree
CXFTreeDlg
CXFTreeDlgRecordHandler
CXMLUtils
DashPatternAttributeAttribute for dash pattern style of paths
DashPatternHeaderThe header for the dash pattern structure contained in Acorn Draw files. It is usually followed by a series of dash and gap lengths in the file
DashRec
DashType
DaveDlg
DColourCIET
DCXOILFilterProvide the OIL parts of the DCX filter which loads in the file as a BMP
DDeckerBottomDefines the start of the bottom row of double decker bar controls
DDeckerEndDefines the end of a row of double decker bar controls
DDeckerTopDefines the start of the top row of double decker bar controls
DeactivateBrushDefActionDoes most of the dirty work for the above operation
DeathMsgThis message is sent just before camelot's death. When a long-life operation receives this message it should tidy-up then call End()
DebugTreeDlg
DebugTreeInfoEncapsulates the platform dependent parts of the debug tree dialog. It provides a simple way of linking a datum to a particular item in the debug tree dialog's list box. This kind of facility can often be supported by the GUI, hence it is in the OIL layer
DeflateStateA deflate state object for the deflater for the file compressor and decompressor
DialogBarOp
DialogBarOpCreateClass for creating DialogBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile
DialogColourInfoMost host operating systems supply applications with a set of colours to be used for rendering special parts of dialogues, e.g. window background, plinth colours, default text foreground/background colours, selection highlight colours, etc
DialogEventHandlerA derived event handler to wire up wxDialog derived classes to DialogManager Notes: In the OIL See Also:
DialogHelpTuple
DialogManager
DialogMgrGadgetThis is a base class representing a gadget in a DialogOp. It should not be instantiated
DialogMsgA DialogMsg is sent whenever the user interacts with the gadgets in a dialog box, It is only sensible to send this message to DialogOp objects
DialogOpThe abstract DialogOp class is used as the base class for all Dialog box classes in Camelot. It provides methods required to create dialogs and to communicate with gadgets
DialogPositionDialogPosition ListItem's are stored in the DialogManager's DialogPositionList they record the position of a dialog box before it is destroyed. They are used to restore the position of the dialog when it is created the next time
DialogTabOpThe abstract DialogTabOp class is used as the base class for all tabbed Dialog box classes in Camelot. It is a simple specialisation of a DialogOp
DialogViewSimple view class for dialogs to use when rendering via a Camelot RenderRegion
DIBClipMapDescribes and handles import/export mappings for bitmaps
DIBConvert
DIBUtilContains static functions for handy DIB manipulation. Never instantiate one of these. That would be silly
DimScaleThis class is used to scale millipoint dimension values to and from a user-set preference. E.g. the user may specify that 1 mile = 2 centimetres. This class will record the units (in this case miles) and the scale factor used to convert internal millipoint values to and from the units the user wishes to work in
DirPathRepresents and validates a directory pathname, rather than a file pathname
DitherBlock
DlgDiscardStringThis simple class holds a pointer to a string which must be deleted when a dialog is deleted
DlgEvtTimer
DLGITEMTEMPLATE
DLGTEMPLATE
DocChangingMsgThis message is sent when something about a document changes. This includes: MonoOn BORN (pChangingDoc) - When a doc has been created ABOUTTODIE (pChangingDoc) - When a doc is starting to be destructed KILLED (pChangingDoc) - When a doc has been destructed
DocColourThis class defines a colour. A DocColour stores an original definition of a colour, a cache containing the definition of the colour in the last colour context in which it was used, and sundry information. DocColours have been designed to be small things to put in attributes
DocComponentAn implementation of an instance of a document component, such as a colour table, or a list of arrowheads. These are the objects that are instantiated for each Document object that exists, and are held in a list in each Document object
DocComponentClassThis provides a class of objects which implement an interface to a particular kind of document component - for example a colour table, or a list of arrowheads. Each kind of object should register with the application on startup, and then when a document is created, each of these objects is asked to add an instance of a DocumentComponent object to it. The DocumentComponent objects are the actual implemtations of the components. For example, they contain the colours for a colour list, and so on. This class, the DocumentComponentClass, is merely for registering the existence of a new kind of document component, and providing a mechanism for inserting them into new documents
DocCoord
DocInfoComponentProvide a component that allows us to save out the information for this document using the serialisation facilities of the DocComponent base class
DocInfoComponentClassProvide a class that will add document information components to new documents
DocInfoRecordHandlerProvide a units record handler for the new native and web file formats. This asks the units document component to import the unit definitions for us
DocOpsThis class represents All the File operations
DocPrintMarkA document print mark item. This item references a cached print mark held by the print mark manager
DocPrintMarkListProvide a class that will add Print mark components to new documents
DocPseudoEnumerator
DocRectThis class is used to represent a rectangular region. It uses a union to enable the client to access the rectangle as two DocCoords (lo and hi) or as four INT32s (lox, loy, hix, hiy). An anonymous union is used, which is a defined C++ feature and so portable
DocTreeSourceConcretisation of NodeScan::Source for all NodeRenderableInks in a document's object tree (generally), or in the 'selected' document's tree (specifically)
DocumentTo represent a platform independent document object
DocumentFontDropDownDocumentFontDropDown class itself. This uses the FontDropDown class to provide a font drop down but overides some of the functionality so that it works out the fonts in the current document rather than the fonts avalaible in the system
DocumentRecordHandlerHandles the reading of all document records in the v2 file format
DocUnitListEncapsulates units within Camelot. All units (i.e. default and user-defined ones) are an instance of this class. Each document has its own list of units controlled by an instance of DocUnitList within the Document class. Therefore you should get hold of the DocUnitList within the current doc when you want to add/delete/edit/find a unit
DocViewUsed to hold non-oil data about views onto a document. When a CCamView object exists there is always a DocView object on the other side of the OIL- interface and they are linked. However, the DocView object is not destroyed when the CCamView object is destroyed so that it records the state of views while they are closed
DocView::CCAPI
DocViewMsgThis message is sent when a DocView is about to be destroyed or has just been created/loaded. It contains a pointer to the appropriate view object (pDocView), and a state indicating if the view is being destroyed or is being created etc. (State). Both members are public. See the file DOCVIEW.H for more information
oilHardwareManager::DoubleUnion
DownloadCacheImplements the file cache used by the InternetManager Comment: The interface is static so it can be accessed from anywhere in the program with the scope resolution operator ::
DownloadCache::CacheMonitor
DownloadOpFile download operation. This class is intended as a base class for new Internet-related operations - it has little use on its own. The older internet operations used in Webster 1 are derived straight from Operation and were a bit difficult to implement
DownloadOpParamDownload operation parameter structure - passes the minimum necessary information to the Op All operations derived from DownloadOp should be invoked with parameters derived from this class
DownloadQueueInternetManager support class. Represents a queue of asynchronous downloads, which are executed in sequence one at a time
DPOINT
DragInformationObjects derived from this abstract class are used to describe everything useful to know about the current global drag. They allow drag targets to decide what to do with a recieved drag
DragManagerOpAn instantiation of this class (created by a call to its static StartDrag method) is used to describe a current global drag. When the drag completes, this object will self destruct. While alive, this object controls the drag, passing relevant events on to registered drag targets, etc. See the documentation for a fuller description of the global drag system
DragMessageThis message is sent to inform the system of important global drag events. Currently the only such event is DRAGSTARTING, sent whenever a global drag is started by calling DragManagerOp::StartDrag. It informs all interested parties that they should register DragTarget objects with the drag manager to handle the drag
DragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
DragToolThe Drag tool is a base class for the Selector and Slice tools. It acts to give these tools a common heritage, so that TransOperation, which handles dragging of objects, can maintain a pointer to them and inform them of various events during a drag. At some point in the future (ie maybe never, but we can hope...) it may be useful to pull common drag functionality up from these two tools, into a base implementation in this class
DrawColourMirrors the representation of a colour as used in Acorn Draw files
DrawFileHeaderHolds the information contained in the header of an Acorn Draw file
DrawingModeAttributeAttribute for drawing mode - EOR, COPY etc
DrawingSelection
DrawObjectHeaderContains the information contained in an object header of an Acorn Draw file
DrawOILFilterProvide the OIL parts of the Draw filter
DrawPathElementUsed to load in a path element from a Draw file. Not all of the 'Coords' array is always used - it depends on the path element
DrawPathHeaderUsed to load in the header information for a path object in a Draw file. It holds details on the fill and line colours, the line width, and the style of the path
DrawPathStyleHolds the style information for a path as used in Acorn Draw files
DropDown
DummyOpThis class represents the Dummy operation
DXFOILFilterProvide the OIL parts of the DXF filter
DynamicHeap
DynArrayA temporary class to control a dynamic array of doccoords. This will be replaced by a template class whenever we can use the template directive
Edge
EditableTextAllows a user to edit a list of items
EditableText::Observer
EditButtonDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. WinoilDragTargets are used as a base class from which to derive drag targets for WINOIL entities (an optional wxWindow*)
EditRegularShapeParamThe OpParam to use when calling OpEditRegularShape. Used to pass in the shape(s) to edit and what to change them to. ChangeShape points to a specific NodeRegularShape to edit or is NULL to indicate all slected shapes should be changed ShapeData points to a NodeRegularShape whose data members are copied into ChangeShape
EditSelectionOpThe Select All operation
EditTabAllows the user to set any options which are normally associated with Editing. This includes such things as:- Nudge Size Duplicate distance x,y Default constraint angle Current attribute settings
EffectsStack
ElementCoordThe OpParam to use when calling OpMovePathPoints. Used to pass in the path to alter and which coords to change
EllipseRecordHandlerHandles ellipse type records from the new file formatRecord handler for ellipses, used when importing ellipses from the new file format. Derived from the regular shape record handler, so we use all the functions in that class to complete the regular shape
EllipseToolThe QuickShape Ellipse tool
EndArrowAttributeAttribute for end arrow type of paths
EndDocument
EndRebuildMouldActionWhen executed this action will get the mould to rebuild itself
EnhancedMetaFileOILFilterProvide the OIL parts of the Enhanced MetaFile filter
EnumAllFontsThis class allows kernel level items to enumerate fonts. To use the class simply derive another from it and implement your own NewFont function. If you then call pMyEnumObj->Execute() your NewFont function will be called for every font the font manager and oil layer support
EnumFractalDataA class to compile information about the global fractal list
ENUMLOGFONT
EnvelopeShapesThe default envelope shapes class. This class provides a bunch of static functions to create some default shapes. All shapes are defined on a (0,0),(72000,72000) coordinate system
EOLNodeEvery TextLine that is created will have a EOLNode as its last child. This means that every TextLine will always have at least one child node
EORCacheClass
EPSClipContextUsed to maintain clipping regions (masks) while importing Illustrator EPS. A stack of regions is maintained, similar to attribute rendering, with the usual save/restore semantics. Adding a new clipping region results in the new clipping region being merged with the current clipping region. In this way complex paths can be used to build up complex masks (this is the brain-damaged way AI EPS does it anyway)
EPSClipContextItemUSed to implement a stack of clipping regions for importing AI EPS with
EPSCommentDefDescribes an EPS/DSC comment, and describes how to handle it. There are four fields:
EPSCommentListWraps up the EPSCommentDef structs into a list class. This will allow me to have a changeable list for different versions of the file, and as a result the whole importing of comments much less restrictive, but at the penalty of a speed hit. Looking up a token will be on O(n) operation, rather than the much quicker array look-up that currently exists
EPSExportDCProvide a device context for rendering to an EPS file
EPSFilterEncapsulates a basic Adobe Illustrator EPS import/export filter. This filter can be used as a base class, because most EPS formats are based (more or less) on AI format. Derived filters can override whichever parts they want to implement other flavours of EPS
EPSFilter::_FontFlags
EPSFlagsDefn
EPSFontCache
EPSRenderRegionEncapsulates an EPS render region. This is used to export EPS files from Camelot. This class is specifically for Adobe Illustrator EPS files, although other EPS filters may derive their render region from this one
EPSSavedGraphicStateTo store a graphic state for the EPS filter
EPSStackProvides a heterogeneous stack for use when reading PostScript (EPS) files. Graeme (30/5/00) - I've replaced the array implementation that Tim originally used with a linked list. The array was originally there as a performance tweak, but increased CPU power has made this a less perceiveable gain. By using a linked list, I've made the implementation a little more error tolerant, which means that files containing stranglely placed bitmaps are now loaded
EPSStackItemThis class provides objects that make up an EPSStack object. The object is polymorphic, and can contain either a INT32, a double, or a TCHAR* string object
ErrorConsists only of static variables, one for the ID of the error, another for the string, and another for the ID of the module that generated the error (0 if the error happened in the kernel). The string is a simple TCHAR array to avoid the need for dynamic memory allocation during error handling. These variables must be set whenever an error condition manifests itself. The class provides static functions to do this, which are called by the ERRORIF and NERROR macros
Error::StackWalker
ErrorInfoDescribe the error/warning/question that is to be displayed. Fields are: MonoOn ErrorMsg - Resource ID of the error message. Title - resource ID of the dialogue title string (optional) Button - array of up to 4 button string resource IDs. OK - the button which is the 'OK' or default button, i.e. the one which should be activated by Enter (this in the range 1-4). Cancel - the button which is the 'Cancel' button, i.e. the one which should be activated by Esc (this in the range 1-4). Help - the index of the button which is the 'Help' button (this in the range 1-4). MonoOff
EssentialTagListKeeps a list of all the essential tags present in the imported file
EssentialTagListItemAn item that appears in the EssentialTagList
ExportBitmapRepresents a bitmap object that has been saved out into the file already. This enables any other references to the bitmap to be output as we have a mechanism to remember that a bitmap definition has already been saved into the file and the record number it was saved under
ExportBitmapListHolds a list of Bitmaps that have been exported when we are saving a Version 2 Native Camelot document out to file
ExportColourRepresents a colour object that has been saved out into the file already. This enables any other references to the colour to be output as we have a mechanism to remember that a colour definition has already been saved into the file and the record number it was saved under
ExportColourListHolds a list of colours that have been exported when we are saving a Version 2 Native Camelot document out to file
ExportDCProvide a device context for rendering to a file rather than the screen. This base class handles opening the file
ExportedBitmapsEncapsulate the process of maintaining an list of Bitmaps already exported from the current document out to file
ExportedColoursEncapsulate the process of maintaining an list of colours already exported from the current document out to file
ExportFileDialogTo provide a custom open file dialog, which enables us to resize the drop down list of filters
ExportHintEncapsulates the Export Hint for a document
ExportHintRecordHandlerHandles TAG_EXPORT_HINT
ExportSelectionAbstract classes representing selections of objects They're not actually used much though ..
ExpressViewRenders the current document into the device context given in OnDraw() This is primarily used for embedding documents
ExtendedPalette
ExtendedPaletteEntry
ExtenderPreliminary container class for Extend() function. This performs automatic extension and stretching of nodes
ExtendParamsParameter container for extension operation. See also:
ExtendSetsDlg
ExternalClipboardHandlers for external (Windows) clipboard functions. Interacts with the internal clipboard document
ExtParam
ExtraUnicode
FactorOutCommonChildAttrActWhen executed this action will factor out all attributes which are common to all children of the compound object. All common attributes become first children of the compound object
FeatherAttrValue
FeatherProfileOpParam
FeatherRecordHandlerHandles the reading of all feather records in the v2 file format
FGMItemAssociate the FillGeometry enum with the resource id of the text that gets displayed on the menu
FileDropInfo
FileFormatDabbling with filters
FileInfoThe file info dialogue shows information on the selected document
FileListOpThis operation handles all the Recent file list menu options
FilePathRepresents and validates a file pathname, rather than a directory pathname
FileUtilThis class contains a library of static functions for use on Windows platforms. The functions perform general file manipulation operations, rather than single file data IO. If you want the size of a file, to locate a particular file on disc etc, then here's where you'll find all those useful routines to do it
FillAttrBlobStateUsed to record the fill blob selection state to determine wether apply ops should be merged or not
FillAttrRecordHandlerHandles the reading of all fill attribute records in the v2 file format
FillBlobSelectionStateUsed to record the fill blob selection state to determine wether apply ops should be merged or not
FilledStrip
FillEffectAltRainbowAttributeSpecifies an 'alternate rainbow' graduation for fills, i.e. the same as a FillEffectRainbowAttribute, but it goes around the HSV cone in the opposite direction
FillEffectAttributeSpecifies the fill 'effect', i.e. how it passes from one colour to another. e.g. fade, rainbow, alternate rainbow
FillEffectFadeAttributeSpecifies a 'fade' graduation for fills, i.e. a simple fade in RGB space
FillEffectRainbowAttributeSpecifies a 'rainbow' graduation for fills, i.e. a fade through the HSV cone
FillGeometryAttributeThe base class for a fill geometry attribute, such as flat, linear, radial, conical, etc. This provides the basic interface for fill rendering
FillMappingAttributeSpecifies how a fill graduation behaves, e.g. linear, sinusoidal and so on
FillMappingLinearAttributeSpecifies a linear fill mapping for a filled object. This is used for normal graduated fills
FillMappingSinAttributeSpecifies a sinusoidal fill mapping for a filled object. i.e. the graduation sort of wibbles from one colour to another in a sort of whirly sinusoidal fashion
FillProfileOpParamServes as our param passing stuff for undo/redo of fill profile changing
FillRampThe base class fill ramp. This class contains common functionality between colour and transparency ramps. Each ramp entry derived from RampItem will contain a selection state and a (float) parameter value. The parameter value usually ranges between 0 and 1 and hence can be used to generate a coordinate from any given fill geometry
FillToolsProvides functionality for generating a list of AttrFillGeometry nodes. This class is used by the profiling function GetProfileFromSelection (virtual overide)
FilterPure base class for import and export filters. Provides static functions to initialise and deinitialise all the available filters
FilterEntryA simple ListItem derived class to allow a list of filters to be maintained - the list holds all the filters that claim to understand a particular file (see FilterFamily). It is not derived from the Filter class itself because although the Filter class is derived from ListItem too, we want to store a list of pointers to existing filters, rather than actual instances of the Filter class. For each entry, a 'compatibility rating' is held, to allow the FilterFamily class (the client of this class) to choose the most compatible filter from the list
FilterFamilySpecial version of an import filter. This filter is actually a subset of the installed filters, to allow the user to easily specify a broad category of file rather than the exact file format and application version that they want to import (because they might not actually know!). It understands all the files that all the family of filters understand, by the simple expedient of being a generic interface to all of them. i.e. Given any file, this filter asks all the others how compatible they are with the file. It then chooses the filter that has the highest compatibility rating, and gets it to import the file
FilterFlagsIndicate what functions a filter is capable of
FilterListTake out some of the functionality from filters
FilterManagerTake out some of the functionality from filters
FilterRenderCallbackHandling callbacks from RenderTree Notes: RenderTree function calls the main function in this class when it's about to render any Node
FindFilesThis class can be used for searching directories for files. It is basically equivalent to the
FitCurveNoChangeGeometryThis class uses the fit curve functionality to reduce the number of points in a path, whereas keeping the geometry as close to the original as possible
FitPointThis class is really a vector class that is used by the curve fitting functions. It is also used as a coordinate class in the curve fitting functions, but these are really regarded as vectors from the origin. It has the following public member variables :- MonoOn double x; - The X coord of the vector MonoOff MonoOn double y; - The Y Coord of the vecotr MonoOff
fixed16
fixed24
FIXEDPOINT
FlareTemplateFilterA filter for the new flare template format (text based form of the the new version 2 native file filter
FlareTemplateHelperStatic function to convert Flare template file to binary Flare format
FlareTemplateOILFilterThe Flare template format Oil Filter (Extension etc)
FlashBitmapRecordMaintains a record of the bitmaps used for fills
FlashButtonRecordMaintains a record of the buttons used by the Flash file
FlashColour
FlashExportDCOutline for a Flash export DC
FlashFilterEnables Camelot to export images in the Flash (SWF) file format
FlashFontRecordMaintains a record of all text styles used, and the characters they contain. This is then used when exporting path records to create the DefineFont entries within a Flash format file when exporting the image. Elements are stored in a double-linked list
FlashOILFilterProvide the OIL parts of the Flash 4 filter
FlashPlaceObjectContains the information necessary to do a PlaceObject tag
FlashRenderCallbackHandling callbacks from RenderTree Notes: RenderTree function calls the main function in this class when it's about to render any Node
FlashRenderRegionProvides the necessary functions to convert image data stored in the Camelot tree into the correct values for exporting to the Flash 4 format, and output these to the relevant device context
FlashShapeRecordContains the information necessary to render a DefineShape class to a file
FlashSpriteContains the necessary data to generate a sprite object within a Flash file
FlashTextRecordMaintains a record of the string being used
FlatFillAttributeSpecifies a flat fill attribute for an object, i.e. it is filled with one solid colour
FlatTranspFillAttributeSpecifies a flat fill attribute for an object, i.e. it is filled with one solid colour
FloatCoord
oilHardwareManager::FloatUnion
FontBaseA class which all Oil level fonts should be derived from. Its really an abstract class but contains some other functionaity too
FontCacheThe FontCache maps a character description to a path for that character. There only ever needs to be a single instance of the FontCache so all data and methods are static
FontComponentProvides a compoent to the document that handles the saving and loading of font definitions to and from the new file format
FontComponentClassThe document font componentA class that will add Font Components to new documents
FontComponentListList header object for the list of font information held by FontComponent objects
FontComponentListItemList item object used by class FontComponentList
FontDefRecordHandlerRecord Handler for font definition records
FontDropDownFontDropDown class itself
FontDropEnumFontClass for enumerating the fonts for the font dropdown system
FontDropItemItem class for the FontDrop system
FontFactoryProvide a centralised place for claiming commonly used fonts. All fonts allocated here are automatically released when Camelot shuts down
FontInfoParameter passing of info extracted from a LogFont
FontKerningPairsCacheA cache for the kerning pairs for a font
FontKerningPairsCacheEntryHolds a cache of kerning pairs for a font
FontListA class which can be used to create a font usage list. Create an instance of this class and pass its Build() function a particular document pointer. The function will create a list of used fonts in that particular document, each item of which will contain a font name and usage count
FontListItemA class to describe the structure of an item held in the font usage list. An item simply contains a fontname and a usage count
FontManagerThe font manager controlling class
FontMetricsCacheHolds a cache of char widths, ascent, descent and em for a particular font
FontMetricsCacheEntryHolds a cache of char widths, ascent, descent and em for a particular font
FontsSGalleryThe Fonts SuperGallery class
FormatArray
FormatEntry
FormatPositionA class used for holding Format Positions
FormatRegionA FormatRegion is a render region that is used during the formatting of characters. No actual rendering is done; the FormatRegion provides a simple way of managing the attribute stack
FormatStateEncapsulates state when wrapping/formatting a text line
FourColFillAttributeSpecifies a Four colour fill for an object
FourColTranspFillAttributeSpecifies a FourCol graduated fill for an object, including the start and end points
FractalFillAttributeSpecifies a Fractal fill attribute for an object
FractalTranspFillAttributeSpecifies a Fractal fill attribute for an object
FrameBehindOpDescriptorNew FrameBehindOpDescriptor class whose purpose is to allow an OpDescriptor to be created which allows us to over-ride the virtual function GetText
FrameInFrontOpDescriptorNew FrameInFrontOpDescriptor class whose purpose is to allow an OpDescriptor to be created which allows us to over-ride the virtual function GetText
FramePropertiesParamAllows the transfer of data from our Frame Gallery to our current layer object
FramePropertiesTabAllows the user to set various Frame properties
FrameSGalleryThe Layer SuperGallery class
FreeHandEPSFilterAldus FreeHand 3.0 filter
FreeHandEPSOILFilterProvide the OIL parts of the FreeHand EPS filter
FreeHandInfoBarOpClass for handling the FreeHand tool's information bar
FreeHandInfoBarOpCreateClass for creating FreeHandInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
FreeHandJoinInfoHolds assorted data used to help join new path with existing paths
FreeHandToolThis class handles the Free Hand Tool that is used to draw lines that follow the path of the Mouse Pointer
FTFontA class description of a font managed by FreeType
FTFontCacheEntryEntry in the new font list cache - used as the value part of a key/value pair where the key is the face name wrapped in an ENUMLOGFONT structure
FTFontManA static class to allow access to fonts managed by FreeType
FTTypeListObject used by CXaraFileRecord for recording type information while writing
GadgetBase class for a UI element
GadgetBubbleHelp
GadgetHelpInfo
GadgetListItem
GalDlgParam
GalleryBarA subclass of BaseBar that is the oil representation of a Gallery
GalleryBitmapDragInfoA bitmap drag, which was started from the bitmap gallery
GalleryClipartDragInfoA fill drag, which was started from the fill gallery
GalleryColourDragInfo
GalleryContextMenuImplements the SuperGallery context sensitive menus
GalleryFillsDragInfoA fill drag, which was started from the fill gallery
GalleryFontsDragInfoA fill drag, which was started from the fill gallery
GalleryLibFontsDragInfoA fill drag, which was started from the fill gallery
GalleryLineDragInfoA Line attribute drag, which was started from the line gallery
GalleryNameDragInfo
GBlend
GBrushA GBrush is a way of getting to Gavin-created brushes, when available. It can supply GDI with better dithered brushes than it does normally. Before use, you should call Init which tells you whether a GBrush is available. If it is not, no further use can be made of it. If it is, call Start on it (cv StartRender). It can then be used, until such time as End is called on it. An in-line member function called Available can be used to determine its functionality at any time. There can only be one active GBrush in use at a time
GCONTEXT
GDrawAsmA C++ wrapped around the assembler in GDRAW.DLL
GDrawBorrower
GDrawContextTo put a C++ wrapper around the GDraw DLL. Also allows non-Gavin originated GDraws (e.g. XDraw) to be dropped in as required. This class is almost a pure base class - inherited classes have to have their own functions for almost everything
GeneralAttrRecordHandlerHandles the reading of all attribute records in the v2 file format that are not line or fill attributes
GeneralRecordHandlerThis is the general record handler. It handles all the general record types, such as the End Of File, file header, etc
GenerateIndexFileFor generating of index files
GenericDownloadParamFile Download param, download a file in the OpMenuImport::Do(). Download operation parameter structure - passes the minimum necessary information to the Op
GenericEPSFilterA filter for all EPS files, regardless of the flavour
GenericFilterA filter for all file types. This is the default filter that the user can import with
GEnvelopeThe low level enveloper class
GEnvelope2x2The low level enveloper class
GeometryLinkedAttrValue
GIFAnimationExportParamPasses infomation about the GIF animation and its bitmap(s) being exported
GIFAnimationPropertyTabsThese encompass all the tabs available for the Animation properties dialog box to use
GIFAnimationPropertyTabsDlg
GIFExportFileDialogTo provide a custom open file dialog for GIF Animation Export. This class has been derived because the help system uses the name of the class - in this case, "ExportFileDialog" - to determine which help page the button should link to. In order to get this help button to link to a separate "Export Animated GIF" help page, we have created a derived class of "ExportFileDialog" that the Export Animated GIF command can display
GIFExportOptionsBase class for storing information about the bitmap we're exporting
GIFImportOptionsImport options for the GIF filter. Allows a clean method of passing assorted parameters for the GIF filter. Specifically, that the BaseBitmapFilter should give us a progress bar. Scope: public See Also: BitmapImportOptions
GIFImportResultsProvides the results for the import of a GIF Notes: m_bValid should be checked for TRUE after any construction because the constructor can fail Scope: public
GIFOILFilterProvide the OIL parts of the GIF filter which loads in the file as a BMP
GIFUtilContains functions to read in a GIF file as a DIB
GlobalBitmapListA list of Greyscale bitmaps A list of all the OIL Bitmaps available in the application
GlobalFractalListA list of all the Fractals available in the application
GMATRIX
GMould
GPerspectiveThe perspective function class
GrabFrameFilterSpecial filter used to convert the selected frame into a bitmap
GradEndCol
GradFillAttributeBase class for a graduated fill attribute to be derived from. It includes one vector (stored as two coordinates) to represent the basic direction of the fill. Some fills will need more vectors (e.g. radial fills) but they can just add data fields in their derived classes
GradFillToolThe fill tool
GradInfoBarOpClass for handling the gradfill tool's information bar
GradInfoBarOpCreateClass for creating GradInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
GradTableA kernel representation of a graduation table. (This is a table of 8-bpp dither pattern specifiers for GDraw)
GradTable32A kernel representation of a 32 bpp graduation table. (This is a table of COLORREF RGB values for GDraw)
GradTranspFillAttributeBase class for a graduated fill attribute to be derived from. It includes one vector (stored as two coordinates) to represent the basic direction of the fill. Some fills will need more vectors (e.g. radial fills) but they can just add data fields in their derived classes
GraduationTable
GraduationTable32
GRECT
GRenderBitmapA GDraw render region that uses normal DIBs for the bitmap and can save itself out into an OIL bitmap
GRenderBrushA GDraw render region that uses normal DIBs for the bitmap. It serves a particularly special purpose in that it provides a number of functions that allow us to blit to the screen very quickly without getting tangled up in the render loop. This is so that we can draw brush strokes and have them appear on the screen in real time. This is achieved by maintaining not one but four static bitmaps. These work in the following way:
GRenderClickSpecial version of a GRenderRegion that renders into a mono bitmap. It is used for hit-detection only. It can also be asked if it is 'blank'
GRenderClickColourSpecial version of a GRenderClick that renders into a colour bitmap. It is used for colour picker hit-detection/pixel colour detection only
GRenderClickColourNoPaperSpecial version of a GRenderClick that renders into a colour bitmap. It is used for hit-detection. The only difference between this and GRenderClickColour is that when it attaches to a CCDC that CCDC's NeedsPaper function will return FALSE
GRenderDIBA GDraw render region that uses normal DIBs for the bitmap
GRenderOptPaletteA GDraw render region that generates an opimised palette for the output bitmap
GRenderPrintA GDraw render region that uses normal DIBs for the bitmap and can output the result to a printer
GRenderRegionEncapsulates rendering using Gavins routines (ie. into a bitmap). This object is created when something needs rendering using Gavins routines eg. When anti-aliasing. See RenderRegion notes for more general details of this class. This is an abstract class - see GRenderDIB or GRenderDDB for implementations
GRenderRegionWrapper
GRenderWinGA GDraw render region that uses normal DIBs for the bitmap and WinG to blit them
GridFlagsType
GridInfoBarOpClass for handling the grid tool's information bar
GridInfoBarOpCreateClass for creating GridInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
GridResizeInfo
GridTabAllows the user to set any options which are normally associated with the document's default grid and hence the page rulers. This includes such things as:- Grid and rulers origin Grid and rulers spacing and divisions Grid type
GridTabAppPrefsDlgTo open up the application preference's dialog box with the grid tab selected. This is used by the pop up menu when on the ruler
GridToolA Tool for creating and editing grids
GroupRecordHandlerHandles the reading of all line attribute records in the v2 file format
GuidelineListItemUsed to generate a sorted list of guidelines within a layer
GuidelinePropDlgAllows the user to change the properties of a guideline
GuidelinePropDlgParamsParameters needed for the guideline properties dlg to function correctly
GuidePropertiesDlgTo open up the layer properties tabbed dialog box with the guide's tab selected. This is used by the guides pop up menu
GuidesPropertiesTabAllows the user to set various layer properties, such as:-
GX2OILFilterProvide the OIL parts of the GX2 filter which loads in the file as a BMP
GZipFileA file stream compressor and decompressor. Allows the CCDiskFile to offer compression of files. At present just used to compress the native file format
GZipStreamA file stream compressor and decompressor. Allows the CCDiskFile to offer compression of files. At present just used to compress the native file format
HaloCUTOILFilterProvide the OIL parts of the HaloCUT filter which loads in the file as a BMP
HandleBecomeAObjects of this class are passed into NodeBlender::CreateBlends() so that they can receive all the paths the blender generates in order to convert the blender into shapes (or more specifically NodePaths)
HandleBrushBecomeAThis class of object is used to store the paths and attribute maps generated for each individual brush object generated by a brushed ink node. It can either turn these paths into nodepaths for insertion into the tree of pass them back for whatever salicious reason
HandleFlagsUsed to determin what to do when rendering drag handles. ie which handles should be rendered and how they relate to the drag mouse coord
HandleRecordTable entries used by the HandleTable class. This class currently supports pen handles and brush handles. Other handles (e.g. Fonts) will be added as necessary
HandleTableProvide a mirror of the table of handles maintained by GDI when importing a MetaFile. This is necessary because, given a GDI handle, it is not possible to ask GDI what kind of object it is, and hence work out e.g. what kind of pen/brush it is. This class therefore creates, selects, and deletes handle objects in the same way that GDI would (see EnumMetafile help in SDK documentation for further details...possibly). At the moment, this HandleTable only supports pens and brushes
HandleTableStruct
HelpDownloadDlg
HelpDownloadOp
HelpDownloadParamFile Download param, download a file in the OpMenuImport::Do(). Download operation parameter structure - passes the minimum necessary information to the Op
HelpOpsThis class is used for all the Help Operations found on the help menu
HideColoursInfoAn operation which will delete
HideNodeActionWhen executed this action will hide a node. It will also generate a ShowNodeAction action adding it to the opposite Action list
HidePropScan
HidePropScan::HideProp
HideScanHides names of objects and their properties which are highlighted members of the 'Used Names' group in the Attribute gallery; hides a specified name of objects
HideScan::HideItems
HideSingleScan
HorizontalRulerEncapsulates horizontal ruler
HorizontalTabA horizontal tab character
HotKeyEncapsulates hot keys in camelot
HTMLExportFilterThe HTML export filter base class
HTMLFileListList of Item
HTMLFileListItemItem to add in the list
HTMLFilterA filter for html file, recognise only tags containing bitmaps
HTMLOILFilterProvide the OIL parts of the HTML filter
IAsynchDownLoad
ICommandControlInterface definition for the ICommandControl interface. This will be supported by a RalphDocument
ICreationInterface definition for the ICreation interface
IErrorCallback
IEventCallbackInterface definition for the IEventCallback interface. This interface will be implemented by a Harness that needs to respond to events sent from a RalphDocument. The interface is registered with a RalphDocument thru a call to IInitRalph::SetEventCallback. Note that it is not derived from IUnknown as there is no reason for it to have AddRef, Release, QueryInterface methods
IFFOILFilterProvide the OIL parts of the IFF filter which loads in the file as a BMP
IInitRalph
ImageAndBitmap
ImageMagickExportOptions
ImageMagickFilterEncapsulates a ImageMagick export filter. Derives off the masked filter which provides funcitonality for doing masked bitmap export and import
ImageMagickFilterBMP
ImageMagickFilterCUR
ImageMagickFilterCUT
ImageMagickFilterDCM
ImageMagickFilterDCX
ImageMagickFilterDIB
ImageMagickFilterDNG
ImageMagickFilterEPDF
ImageMagickFilterEPI
ImageMagickFilterEPS
ImageMagickFilterEPS2
ImageMagickFilterEPS3
ImageMagickFilterEPSF
ImageMagickFilterEPSI
ImageMagickFilterEPT
ImageMagickFilterFAX
ImageMagickFilterFITS
ImageMagickFilterICO
ImageMagickFilterJNG
ImageMagickFilterMIFF
ImageMagickFilterMPC
ImageMagickFilterOTB
ImageMagickFilterP7
ImageMagickFilterPALM
ImageMagickFilterPAM
ImageMagickFilterPBM
ImageMagickFilterPCD
ImageMagickFilterPCDS
ImageMagickFilterPCL
ImageMagickFilterPCX
ImageMagickFilterPDB
ImageMagickFilterPDF
ImageMagickFilterPGM
ImageMagickFilterPICT
ImageMagickFilterPIX
ImageMagickFilterPNM
ImageMagickFilterPPM
ImageMagickFilterPS
ImageMagickFilterPS2
ImageMagickFilterPS3
ImageMagickFilterPSD
ImageMagickFilterPTIF
ImageMagickFilterPWP
ImageMagickFilterRLA
ImageMagickFilterRLE
ImageMagickFilterSCT
ImageMagickFilterSFW
ImageMagickFilterSUN
ImageMagickFilterSVG
ImageMagickFilterTGA
ImageMagickFilterTIFF
ImageMagickFilterTIM
ImageMagickFilterTTF
ImageMagickFilterVICAR
ImageMagickFilterVIFF
ImageMagickFilterWBMP
ImageMagickFilterWPG
ImageMagickFilterXBM
ImageMagickFilterXCF
ImageMagickFilterXPM
ImageMagickFilterXWD
ImageMagickOILFilterThe PNG File format Oil Filter (Extension etc)
ImagemapThis is a list of clickable areas
ImagemapClickableAreaThis class represents a clickable area
ImagemapClickableCircleThis class represents a clickable circle
ImagemapClickablePolygonThis class represents a clickable n-sided polygon
ImagemapClickableRectangleThis class represents a clickable rectangle
ImagemapDlg
ImagemapFilterThe imagemap export filter class
ImagemapFilterOptionsAn ImagemapFilterOptions object contains all the information the ImagemapFilter needs to set itself up ready for export
ImagemapOILFilterThe Imagemap Oil Filter
ImagemapRenderRegionThe render region for the imagemap filter
ImagesettingAttrRecordHandler
ImagesettingAttrValueBase class from which all binary imagesetting attribute values are derived
IMGOILFilterProvide the OIL parts of the IMG filter which loads in the file as a BMP
ImportBitmapRepresents a bitmap object that has been loaded in from the file already. This enables any other references to the bitmap to be resolved as we have a mechanism to remember that a bitmap definition has already been loaded into the file and the record number it was loaded under
ImportBitmapListHolds a list of Bitmaps that have been exported when we are saving a Version 2 Native Camelot document out to file
ImportedBitmapsEncapsulate the process of maintaining an list of Bitmaps already exported from the current document out to file
ImportedColoursEncapsulate the process of importing a number of colours into a document. This object maintains a list of colours to be imported, and implicitly handles all the merging/duplication problems that may occur
ImportedNewColourA structure to hold a new colour, which can be represented in any colour model. Uses a ColourGeneric which must be cast because C++ can't do unions in any useful way
ImportedStringEncapsulates an imported string that's come from the a v2 format file
ImportedStringListUsed to manage a list of ImportedString objects
ImportFileDialogTo provide a custom open file dialog, which enables us to resize the drop down list of filters
ImportPosition
IndexedColourDefinition of a colour, stored to high (128-bit) precision. DocColours in the Document may refer to IndexedColour objects from which they are defined
IndexedColourInfo
IndGenFileBufferSince MSDOS seems happy returning filenames of files in a directory in a completely random fashion, we need to have some way of storing all the ones it returns us and sorting them alphabetically, so we can generate index files in a nice alphabetical order
inflate_blocks_stateAn inflate blocks state object for use by the inflater for the file compressor and decompressor
inflate_codes_stateAn inflate codes state object for use by the inflater for the file compressor and decompressor
inflate_huft_s
InflateStateAn inflate state object for use by the inflater for the file compressor and decompressor
InfoBarOp
InfoBarViewOp
InformationBarOpThe kernel version of info bar
InitBlendAction
InitBlendersActionAn action which deinits or reinits a blend
InitNodeBlendPathActionAn action which destroys the cached info in a blend path node
InputManagerThis provides support for all Input Devices
InsertFloaterActionAn action to provide the Line tool with an undoable way of inserting the floating endpoint. This isn't stored in the document, which makes life tricky
InsertFloaterParamThis is the OpParam object passed to OpInsertFloater to position the floating endpoint
InsertionNode
InsertLevelStackHolds a list of level items The class gives the list a stack-like interface
InsertLevelStackItemThis item holds all the info for a given insert level of the tree. It is used when building the tree on import
InsertPathElementActionAn action which undoes the removal of an element into path data (hence replacing the deleted data)
InsertTreeContextStructure for saving and restoring tree insertion contexts. This is used by things like print marks and brush stroke definitions, which embed a subtree definition in the file, but want to import it somewhere other than into the document tree
InsetPathPathProcessorMakes sure the original nodes aren't rendered, if the active flag is set
internal_state
InternalClipboardCamelot's internal clipboard document
InternalClipboardFormatThis class is a very simple class which describes an internal clipboard data format. Each ClipboardMapping uses one of these to describe the type of input data they require in order to export, and thes export mappings will only be available to the clipboard if at least one node in the InternalClipboard supports output in this internal format
InternetManagerWebster connection/download manager. It is responsible for schedulling downloads for execution according to the priority declared by the client on registration, ensuring that no more than a preset number of connections are open at any one time (important for users with limited bandwidth), and otherwise keeping track of their fate. The sheduling sheme is as follows:
  • downloads with AsynchDownload::PRIORITY_NORMAL will be executed one at a time, as long as there are no high priority downloads queued up and the maximum number of connections is not exceeded. They all share the same progress dlg, which is hidden when there are no downloads scheduled
  • downloads with AsynchDownload::PRIORITY_HIGH will be executed simultaneously, up to the maximum no of connections. Each download gets its own progress dlg
InternetTabAllows the user to set Internet-related options
InvalidateArbitaryActionWhen executed this action will Force a redraw of the bounding rectangle it contains
InvalidateBoundsActionAn action which invalidates the bounds of a node
InvalidateRectActionWhen executed this action will Force a redraw of a bounding rectangle over a certain spread
InvalidateRegionActionWhen executed this action will Force a redraw of the bounding rectangles of each node in a range
InvalidateRegionIfBgRedrawActionWhen executed this action will Force a redraw of the bounding rectangles of each node in a range. This version will only invalidate the region if Background Redraw is in progress
IOCAOILFilterProvide the OIL parts of the IOCA filter which loads in the file as a BMP
IProfile
Item
IUnknown
IViewControl
JCWColourFilterLoad's Jason's private palette file format
JCWColourOILFilterProvide the OIL parts of the Jason palette filter
JoinInfo
JoinShapesBecomeAThis is the class that is passed to other nodes when the combine op gets them to to turn into other types via their DoBecomeA() method
JoinTypeAttributeAttribute for join types of paths
JPEGBitmapSource
JPEGDataDestinationProvides an overridden version of the IJG library source manager, using CCFile's
JPEGDataDestination::IJGDestMgr
JPEGDataSourceProvides an overridden version of the IJG library source manager, using CCFile's
JPEGErrorManagerProvides an error handler for the IJG JPEG Library. Specifically it uses standard Camelot practices to cope with errors generated within the library. Scope: public
JPEGExportFilterProvides an Accusoft-free JPEG export filter
JPEGExportOILFilterOILFilter for non-Accusost version of JPEG export filter
JPEGExportOptionsAllows JPEG specific export options to be manipulated
JPEGExportPrefsDialogProvides a dialog asking for user options in the JPEG export
JPEGImportFilterProvides a JPEG import filter using the IJG JPEG LIBRARY
JPEGImportOILFilterOILFilter for non-Accusost version of JPEG import filter
JPEGImportOptionsImport options for the JPEG import filter. Allows a clean method of passing assorted parameters for the JPEG import filter. Specifically, that the calling class should give us a progress bar. Scope: public See Also: BitmapImportOptions
JPEGOILFilterProvide the OIL parts of the JPEG filter which loads in the file as a BMP
JPEGProgressByFilterProvides progress update callback for the IJG library JPEG Filters using the Update member of the Filter class
JPEGProgressBySelfProvides progress update callback for the IJG library JPEG Filters using a self-contained Progress object
JPEGProgressMonitorProvides progress update callback for the IJG library JPEG Filters
KernCodeA Kern code
KernelBarPosTo assist in transfer of BarPosition Data between OIL and Kernel Layers
KernelBitmapTo encapsulate bitmaps, which are implemented in the OIL layer. Kernel code is only allowed to use this interface. OIL code is allowed to use the specific OILy functions that can be done via the OILBitmap pointer
KernelBitmapRefA reference to a KernelBitmap object
KernelBmpListItemHolds a pointer to a KernelBitmap for tracking the creation of bitmaps for cleanup purposes. This class should be eliminated by modifying the bitmap classes to correctly reference count and handle the concept of temporary bitmaps
KernelDCProvide a base device context for rendering to something other than the screen. This includes printers, files, and PostScript devices
KernelDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. KernelDragTargets are used as a base class from which to derive drag targets for KERNEL entities (usually a DialogOp and optional Gadget ID)
KernelStatistics
KernelTimerA class exposing a timer to the kernel Notes: In the OIL See Also:
KernelTimer::CamTimer
KeyMsgThis is sent when a key press occurs that hasn't yet been processed by other parts of the key press handing system, such as the current too, temporary tool switching, and the hot-key system
KeyPressEncapsulates key presses in camelot
KeyPressSysMsgRepresents a key press message that is slightly more abstract than the raw Windows message. This will hopefully aid the porting of this code to other platforms
KOFAXOILFilterProvide the OIL parts of the KOFAX filter which loads in the file as a BMP
LaserDataOILFilterProvide the OIL parts of the LaserData filter which loads in the file as a BMP
LayerLayers optionally exist on a page, they group together objects which are drawn at a particular level in a document
LayerColourActionAn action which changes the colour of a guide layer
LayerDlgThe Layer dialog allows a user to
LayerDlgParamHolds the parameters for the LayerNameDlg to perform its stuff on
LayerManagerThe LayerManager is used to make changes to layers in the document tree. It holds a pointer to a current spread, and a list of layer details for the current spread (LyrDetLst). The layerDlg and InfoBar make changes to layers in the current spread indirectly by changing the LyrDetList. Layer changes are deferred until the CommitLayerChanges() method is called. Changes made to the LyrDetList can also be cancelled by calling the CancelLayerChanges() method
LayerMsgMessages detailing specific changes to layers
LayerMsgHandlerIntercepts messages to ensure that layers are up to date
LayerNameDlgAllows the user to edit the parts of a layer
LayerPropertiesDlgTo open up the layer properties tabbed dialog box with the layer's tab selected. This is used by the layers pop up menu
LayerPropertiesTabAllows the user to set various layer properties, such as:-
LayerPropertyTabsThese encompass all the tabs available for the layer properties dialog box to use. Derived off the baseclass which has a lot of globally useful functionality for all property tabbed dialog box handlers. This is just derived of the list class
LayerPropertyTabsDlg
LayerSGalleryThe Layer SuperGallery class
LayerStateActionAn action which changes the state of a layer or the layer system
LayerStatusThis class (structure) holds layer information which can be changed by the user. The reason that this information is held in a seperate class is that it needs to be stored in both the Layer and Layer Manager classes
LegendLabelThis is the class for the "set origin" gadget,
LessBitmapCacheKey
LibClipartSGalleryThe LibClipart SuperGallery class
LibColourFlagsThis DisplayTree node is used by the Colour SuperGallery It is responsible for providing the ability to handle/redraw one library colour displayed in said gallery
LibFillsSGalleryThe LibFills SuperGallery class
LibraryThis is the main super gallery library group creation class... Creating one of these will create a single group in your gallery. It will contain items for each entry in the sub-lib
LibraryFileThis is the main super gallery library creation class... Creating one of these will give your gallery a set of new sub-lib groups containing DisplayItems for the entries in the sub-group
LibraryGalleryA base library gallery class with common library gallery stuff in
LibSettingsThe Gallery Resource Management class..
LibSettingsListItemMemory list of section lines to speed GRMFile reading up somewhat
LinearFillAttributeSpecifies a linear graduated fill for an object, including the start and end points
LineArrowItemClass to represent a arrowhead/tail user-interface item within the line gallery
LinearTranspFillAttributeSpecifies a linear graduated fill for an object, including the start and end points
LineAttrGroupSpecialises the SGDisplayGroup class, overriding the function that builds up the title string. This derived class can have any string as its title
LineAttrItemThis DisplayTree node is used by the Line SuperGallery It is responsible for providing the ability to handle/redraw one LineAttrItem displayed in said gallery
LineAttrRecordHandlerHandles the reading of all line attribute records in the v2 file format
LineCapItemRepresents a line-cap user-interface item within the line gallery
LineComponentA document component for handling Line definitions
LineDashItemRepresents a line dash-pattern user-interface item within the line gallery
LineData
LineDefinitionStores a vector Line definition A static list of these items is held in the LineComponent
LineEdge
LineGalleryThe Line SuperGallery class Notes: SuperGalleries are specced in a number of docs including specs.doc ("super" gallery extensions) specs.doc (gallery basic ui) There is also howtouse.doc which describes creating a supergallery
LineJoinTypeItemRepresents a line-join user-interface item within the line gallery
LineNoArrowItemClass to represent a no-arrowhead/tail user-interface item within the line gallery. Only used as a base class for LineNoStartArrowItem and LineNoEndArrowItem
LineNoEndArrowItemClass to represent a no-start-arrowhead/tail user-interface item within the line gallery
LineNoStartArrowItemClass to represent a no-start-arrowhead/tail user-interface item within the line gallery
LinePropertiesDlgParam
LineStrip
LineWidthAttributeRepresent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator
LineWidthItemRepresents a line-width user-interface item within the line gallery
List
ListControlRepresents a List in a DialogOp
ListFillRelatively generic Gradient Fill holder class, so that gradient fills can be stored in a linked list (mainly used while scanning for grad fills)
ListItemA list item is an abstract class which is used to derive all objects which are linked together in lists. It has no member functions because all useful operations are defined in the List class. The reason for doing this is that list operations may need to alter the list header
ListItemIdxA ListItem that points to another ListItem. Used to created list indexes
ListItemOpPtrTo enable storage of pointers to operations on lists
ListItemPtrItemA ListItem object which is a pointer to a ListItem, used by the MarkedStack class
ListListItemA ListItem with a 'list' in it. Useful for lists of lists. The destructor deletes all items in its List
ListRangeThis class represents a list of explicitly declared nodes (rather than the implicitly chosen nodes controlled by RangeControl flags)
ListStepperThis class it used to step along two lists, choosing matching pairs. This really comes into play when you have different numbers of items in the two lists, and you want to step along them without missing out any items. E.g. List A contains 4 items, list B contains 2 items this would produce the following pairs: A B 0 0 1 0 2 1 3 1 E.g. List A contains 3 List B contains 5 A B 0 0 0 1 1 2 1 3 2 4
ListT< T >Generic List
ListT< T >::ConstIterator
ListT< T >::Iterator
ListT< T >::ListNode
LiveEffectRecordHandlerHandles the reading of live effects records
LiveEffectsInfoBarOpClass for handling the FreeHand tool's information bar
LiveEffectsInfoBarOpCreateClass for creating LiveEffectsInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
LiveEffectsToolThis class implements the Live Effects tool that allows the use to apply live bitmap effects to objects
LoadBrushDirectClass is used to load a document containing the default brushes on startup. Most of the action takes place in the base class
LoadContextTo encapsulate all data local to a download
LoadDirectThis class allows the caller to load a xara document in, process the data held inside and close the document again. You should derive your own class and override the OnLoadDocument() function. You'll be given a CCamDoc and Document* which can be used to access data within the doc. On return from OnLoadDocument, the document will be destroyed
LoadPrintMarksA derived class to load the print marks. Uses the winoil class LoadDirect
LoadRegistryEntriesThis class can be used for loading a list of items into the registry
LocaleChangedMsgThis message is sent whenever the locale information changes, eg keyboard layout, decimal character, etc..
LocalEnvironmentProvide access to the locale settings Camelot is running under
LocaliseCommonAttrActThis action copies all attributes common to the group to each child object within the group which requires each attribute. The groups common attributes are deleted
LOGBRUSH
LOGFONT
LogicalCoord
LOGPALETTE
LyrDetailsLyrDetails objects are stored in a list within the LayerManager. They record changes made to a layer
MacPaintOILFilterProvide the OIL parts of the MacPaint filter which loads in the file as a BMP
MakeBitmapExportOptionsAllows "Create Bitmap Copy" to provide own defaults
MakeBitmapFilterSpecial filter used to convert the selection into a bitmap
MarkEditListActionAn action to record/restore the current state of the LiveEffect EditList. An action to record/restore the current state of the LiveEffect EditList
MarkedStackA marked stack is a special purpose stack/list. Its properties are described:
MarkFormat
MarkFormatRegionThe mark formatting region. Given a doc rect ie the position of the region around the page, this class can be used to work out the position of the marks which need to be formatted in this region ie those marks which have been specified by the user to fall into this position. As one adds marks, the formatting region updates itself and keeps track of all mark positions. You can then call the formatting regions render function which will use the positions so generated to render each mark within it. On rendering, each mark will be asked to render itself at a given position
MarkListHolds an array of up to 8 marks formatted into a particular position eg middle centre in a particular region (of which there can be 16 around a page)
MarkPositionAn instance of a mark lives in a particular region and not only this, contains a format and a transform
MarkPosType
MaskedFilterEncapsulates a masked filter which provides funcitonality for doing masked bitmap export and import
MaskedFilterExportOptionsBase class for storing information about the bitmap we're exporting
MaskedRenderRegionThe Masked Render region is used when rendering to regions that can not do all the fabby things that GRender Regions are capable of (eg Transparancy). They are used as part of the 3 phase rendering process, in the middle phase. In this phase all the objects that are deemed to be too complicated to be rendered by the host render region are actually rendered into a GRenderRegion. Each of the individual objects that are complex are also rendered into this Mono Masked Render Region. At the end of the process this Masked Render region is used to identify the minimum area of the render region that needs to be blitted into the host render region
MaskPair
MaskRegion
MatrixRepresents a mathematical transformation matrix. Transformation matrices can transform the coordinate pairs of one coordinate space into another coordinate space. Matrices are used in Camelot for the rendering process in various ways. These include coordinate conversion, scaling, rotation and translation
MatrixFitToPathActionThis action is used when fitting a TextStory on a path in order to undo matrix changes
MatrixRemoveFromPathActionThis action is used when fitting a TextStory on a path in order to undo matrix changes
MemoryBlock
MemTrackExtraHolds the info that we use in the memory tracking code. It is a doubly linked list that tells us how big a block is, where it was allocated etc
MenuItemMenuItems are the things that appear in menus, but in camelot they are also the menus themselves. The idea is that the menu system is a dynamically growing, living-thing where all the elements are connected in a tree like structure. The elements of the menu system or the nodes in the tree are MenuItems. MenuItems can therefore be simple or composite i.e. a menu option or a sub menu. In windows there is a third type of MenuItem: the separator, in our new improved menuing system separators will not be modelled as MenuItems. Instead a MenuItem may be specified as having a menu separator following it
MenuPopupOpsThis class represents All the Menu Popup operations
MeshNodeListItem
MessageHandlerIf a system object must respond to system messages then its class should be derived from the abstract MessageHandler class. When a MessageHandler is constructed it gets added to a list of MessageHandlers which are all targets of system messages. To send a message to all or just a subset of MessageHandlers, you should use the static Broadcast method. The virtual 'Message' function is called whenever the MessageHandler is sent a message
MessageHandlerListA MessageHandlerList contains a List of MessageHandler objects derived from the same runtime class
METADATA
MetaFileClipMapA class which describes and implements an available mapping between internal and external data formats
MetaFileFilterEncapsulates a filter for importing Windows MetaFiles (16-bit only at the moment)
MetaFileFilter::CImportInfo
MetaFileOILFilterProvide the OIL parts of the MetaFile filter
MetafileViewSimple view class for metafiles to use when rendering via a Camelot RenderRegion
MillipointKerningPairSame as windows structure KERNINGPAIR but using millipoints
MiscTabAllows the user to set any options which are either too specific to have an associated tab or just do not fit any where else. This includes such things as:- Save preferences on exit switch and save preferences now button. Nudge Size Duplicate distance x,y Default constraint angle Current attribute settings
MitreLimitAttributeAttribute for mitre limits of paths
ModifyElementActionAn action which undoes the modification of a single element of path data. This action can be used for undoing changing coordinates or flags or verbs. This action is not really suitable if you have a lot of path data to change - ModifyPathAction is more efficient because it encodes multiple elements. This action was written because for single elements, ModifyPathAction is too complicated to call
ModifyFilledActionAn action which undoes the modification of a path's filled bit (or redoes it) It can also be used to undo the IsStroked flag as well
ModifyFlagsActionAn action which undoes the modification of a path element's flags. This is a smaller action that ModifyElementAction and is more economic for undoing selection change
ModifyPathActionAn action which undoes the modification of path data. This action can be used for undoing changing coordinates or flags or verbs. Other actions will exist for adding or deleting elements from paths. This action is useful for undoing large amounts of path editing (e.g. dragging several points around) but is less useful for undoing the alteration of single coordinates. Another Action might be created later for undoing single element alterations
ModInfoHolds details about a module. This class will always be derived from the latest version of the ModInfo_vnn class. Having this class means that the source only needs to be changed in one place when the ModInfo spec changes.Text string describing the purpose of the module
ModInfo_v1Holds details of a Module. See ModInfo for details
ModuleThe Module type reflects the latest Module specification. Do NOT subclass from Module, but use the latest Module revision (e.g. Module_v42). The Module type should only be used by the Kernel and OIL layers, never by Modules themselves
Module_v1Module interface definition. See Module for details
ModuleListUsed by the kernel to hold information on all the modules it currently knows about. It has an overloaded Add function which will only add modules if their ID has not already been used by another module
ModuleListItemUsed by the kernel to hold information on a particular module
MonotonicTimeThis class stores samples of the ever-increasing system ticker (the "monotonic clock" in Archy speak) and stores them. The samples can then be manipulated by member functions
MouldAttributeSpecifies wether the attributes are moulded or not
MouldBecomeAThis is the class that is passed to other nodes when the mould tool is trying to turn them into other types via their DoBecomeA() method
MouldEnvelopeThe envelope mould node. Provides control over a coons patch shape made from 4 connected 3rd order bezier splines
MouldEnvelope2x2Another envelope mould. Provides control over a coons patch shape made from 2x2 4 connected 3rd order bezier splines
MouldEnvelopeBaseThe envelope mould node. Provides control over a coons patch shape made from 4 connected 3rd order bezier splines
MouldGeometryAn abstract base class for mould shapes
MouldInfoBarOpClass for handling the tool's information bar
MouldInfoBarOpCreateClass for creating MouldInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
MouldPerspectiveThe perspective mould class. This mould implements a rectangular transform with true perspective
MouldRecordHandlerHandles the reading of all mould records in the v2 file format
MouldToolA template tool class
MouldTransformDefines the mould transform class. This class is used by a moulder when it needs to ask other objects to transform themselves geometrically. It provides various functions for nodes to call to transform coordinates or paths
MovePointsParams
MsgThe base Msg class from which all messages must be derived
MSIconsOILFilterProvide the OIL parts of the MSIcons filter which loads in the file as a BMP
MSPaintOILFilterProvide the OIL parts of the MSPaint filter which loads in the file as a BMP
MSPaletteFilterMicrosoft Windows palette filter
MSPaletteOILFilterProvide the OIL parts of the Windows Palette file filter
MTRand
MultiAppliedAttributeRepresents an applied attribute of which there is only one for the objects given by the iterator
MultiCommonAttrItemThis ListItem is used by Range::FindCommonAttributes
MultipleBitmapSelection
MyFontEnumerator
NamedExportPropClass to manage the UI and execution of batch-export properties
NameDialogAllows the user to edit the parts of a layer
NameDialogParamAllows a string (the Name) to enter and emerge from a NameDialog, and tells us if the dialog was cancelled
NamedSlicePropClass to manage the UI and execution of slice properties
NamedStretchProp
NamedTickboxPropAbstract base class for the various kinds of properties associated with SGNameItems that have a UI of a (tri-state) tick-box
NameGalleryCore object of the Camelot naming system
NameGallery::BarSizeType
NameGallery::NameGalleryTimer
NameGroupIterBase classes for iterations and searches over all groups and all items in the name gallery
NameItemIterAbstract base classes for iterations and searches over all groups and all items in the Name gallery
NameIterOpSpecialisation of base class to combine a node and an operation
NameObjectsDlg
NativeClipMapClipboard mapping class for Native files -- wired into the system in winoil.cpp
NativeEPSOILFilterThe Native File format Oil Filter (Extension etc)
NativeExportDCThis class makes use of the base class for almost everything. Its real purpose is just to overide the Binary and Bitmap areas of the DC. In EPSExportDC these are converted to Hex strings and here they are output directly as binary..
NativeFileOpParams
NativeOILFilterThe Native File format Oil Filter (Extension etc)
NativePrefsDlg
NativeRenderRegionThe render region class for the native file save
NewBrushMsgA message broadcast when a new brush is created from the Brush edit dialog. It should be picked up by the Freehand infobar and used to update its brush list
NewColourRepresents a new colour object to be added to a document after a file has beeen imported. It holds information on whether the colour name will need to be mangled
NewColourDlg
NewColourInfo
NewColourListHolds a list of colours that are imported while importing a file into a Camelot document
NewColourParamAllows the user to create a new colour (based on another one)
NewPathCreatedMsgThis message is sent whenever a new path is created. The only client of this message (at the moment) is the Line tool, which needs to clear it's floating endpoint when a new path is created
NEWTEXTMETRIC
NodeThis abstract class describes the fundamental type of object which can be linked into a camelot tree. All other objects which are linked into the tree are derived from this class
Node::NodeFlags
NodeAnimatingBitmap
NodeAttributeAbstract class from which various Attribute nodes are derived
NodeAttributeClassItemThis ListItem holds an attribute's runtime class
NodeAttributePtrItemThis ListItem holds a ptr to an attribute
NodeBarPropertyChild node of NodeSetSentinel that stores individual property records for a bars
NodeBevelDoes the bevelling
NodeBevelBeginDenotes the beginning of a bevel
NodeBitmapA class for including bitmap objects within the tree
NodeBitmapEffectBitmap effects nodes are type of Post-Processors. They process the bitmap output of their child nodes
NodeBlendThe NodeBlend class
NodeBlenderA NodeBlender is the class that actually renders the blend stages of a blend object. It also generates NodePath objects when the user does a 'make shapes' on a blend
NodeBlendPathDefines the structure of a node blend path object. This object exists only as a child of a blend object
NodeBrushThe NodeBrush class
NodeBrushMakerThe NodeBrushMaker class
NodeBrushPathThe NodeBrushMaker class
NodeClipViewClipView node. This node works in tandem with NodeClipViewController to provide clipview functionality. It sits underneath a NodeClipViewController, between the keyhole node and the clipped nodes, so that it is rendered after the keyhole node. Its Render() method saves GDraw's current clipping region and applies a new region, derived from the keyhole node's outline. See also:
NodeClipViewControllerClipView controller node. This is the node which does all the hard work with respect to clipview functionality. Initially at least, it is really a more-or-less normal group, with special rendering qualities. The bottom-most (in a z-order sense) NodeRenderableInk in the group is rendered, then its path is used to create a clipping region, into which all other members of the group are rendered
NodeCompoundEncapsulates everything to do with compound nodes
NodeCompoundBlendBecomeA
NodeContourContour node
NodeContourControllerContour node controller class
NodeDocumentThis class represents the root of a document tree. It contains the extents of the entire document as two DocCoords (LowExtent, HighExtent). LowExtent is the Coordinate position of the low corner of its first chapter whilst High Extent is the coordinate position of the high corner of its final chapter
NodeEffectEncapsulates everything to do with post processor nodes PostProcessor nodes are compound nodes which take the rendered output of their children and change it in some way. They are compound nodes so that they have a user-controlled position in the rendering order
NodeEllipseThis is the Ellipse shape. It is based on the NodeSimpleShape, which means that it is fitted into a parallelogram. It is actually made up of 4 bezier curve sections
NodeFeatherEffectFeather effects are specialised types of LiveEffect
NodeGridAn abstract class defining the common elements of grid nodes
NodeGridIsoA class defining an isometric grid node
NodeGridRectA class defining a rectangular grid node
NodeGroupGroup Node
NodeGuidelineDefines the NodeGuideline Class
NodeHiddenNodes are generally never deleted from the tree, instead they are hidden. To hide a node a NodeHidden is inserted into the tree at the old position of the hidden node, the HiddenNode holds a pointer to the hidden node. The static ShowNode function of NodeHidden will delete the NodeHidden and relink the hidden node into the tree
NodeListItemStores a pointer to a Node. Used to build a list of nodes in the current range. The actual node can be accessed through the public member variable pNode
NodeListItemWithComplexityThis is used to ensure that blends print correctly. If a particular NodeBlender was classified as simple, and is later used with a blend that is complex, then complex blend steps will not render. This class allows us to reclassify a simple node as a complex one
NodeListItemWithDocPtrThis is used to allows blends of compounds to manage memory correctly. The class stores a pointer to the owning document - so that when the document dies, we only kill nodes associated with that document
NodeListItemWithIndex
NodeLiveEffectBitmap effects nodes are type of Post-Processors. They process the bitmap output of their child nodes. They are "Live" in that as soon as their children change they re-process the output
NodeLockedEffectBitmap effects nodes are type of Post-Processors. They process the bitmap output of their child nodes. They are "Locked" in that they capture the output once then ignore changes to their children (because they cannot reproduce the processing)
NodeMouldThis class defines the structure of a mould node object. This object is the parent of a MouldGroup node and a Moulder node. Objects being moulded are placed inside MouldGroup and all resulting moulded objects are placed inside the Moulder node
NodeMouldBitmapThis class controls the renderable mould objects. ie those objects which are moulded and rendered in one action. It will live under Moulder objects along with NodePaths eg
NodeMoulderDefines the structure of a moulder object. The moulder exists only as a child of a mould object, controlling the production and manipulation of moulded versions of associated siblings. ie for each child (C) of a mould object, we create a moulder object (M). M controls the actual production and rendering of paths and bitmaps generated by C
NodeMouldGroupDefines the structure of a mould group object. This object lives inside a NodeMould and keeps track of all mould source objects
NodeMouldPathDefines the structure of a node mould path object. This object exists only as a child of a mould object, controlling the editing of the mould manifold
NodePathPuts path objects into the tree
NodePointer
NodeRectA Node rect represents a rectangle object in the tree. It is derived from NodeSimple Shape that contains most of the functionality it needs. Simple Shapes are a group of nodes that are based around a parallelogram. The shape is fitted into a parallelogram so that it can be transformed while keeping its own identity (ie, it does not have to be turned into a NodePath)
NodeRegularShapeA NodeRegularShape represents an regularly shaped object. It encompasses NodeSimpleShape (but is not derived from it as it needs to do more things)
NodeRenderableThis abstract class describes a node which is renderable. See the Node class for an important note about producing derived classes of Node
NodeRenderableBoundedAs NodeRenderable, but with a bounding box describing the area this object occupies. This class also includes functions for use with attribute optimisation
NodeRenderableInkThis abstract class describes a renderable ink node. A property of Ink nodes is that they should be rendered after their children have been rendered
NodeRenderableInkDetailsItemThis ListItem is used by the Object Registry. It has the RuntimeClass of a NodeRenderableInk node, along with the following information which is likely to grow
NodeRenderablePaperThis abstract class describes a renderable paper node. A property of paper nodes is that they need to be rendered before their children
NodeScanAbstract base class for scans over sequences of nodes
NodeScan::SourceAbstract base class for interfaces to SelRanges, Document trees etc whose nodes can be scanned over. Notes: If your derived class defines data members then remember to define a copy constructor and consider concurrency issues!
NodeSetProvide a mechanism for marking a set of nodes for redrawing. This mechanism is independent of the number of render regions associated with a particular tree, as it stores a list of pointers to nodes, rather than marking the nodes themselves. The NodeSet can be instructed to mark or unmark all nodes in the set. This allows us to selectively render these nodes without interfering with other render regions, because when we start rendering, we mark the nodes, render the marked nodes, unmark the nodes, and then we have stopped rendering. This means we only ever mark nodes while the render region is actively rendering, and as there can only ever be one render region actively rendering at one time (including the possibility of background rendering) then we don't get any interaction between render regions
NodeSetPropertyChild node of NodeSetSentinel that stores individual property records for a set of objects (SGNameItem)
NodeSetSentinelDummy node that has one instance of each different Wix ObjectName attribute also applied to it. Every document has one of these nodes after the last default attribute and before the first chapter. Whenever a new name is first applied to any objects in the document, it is also applied to this node; similarly, whenever a name is deleted (ie. hidden) from a document, it is also deleted from this node. Hence, during the normal course of creating or deleting objects with particular names, even if the last object which has a name is deleted by the user, the name still exists as a single attribute applied to this node, will remain an active item in the Attribute gallery, and can be saved out in the native format. And when the user creates or deletes names that never refer to any objects, the action always result in tree manipulations and are properly integrated into the undo system
NodeSimpleShapeA NodeSimpleShape is the base class for several primitive shapes that are bounded by a Parallelogram. This class contains 2 Pure Virtual functions that need to be re-written in base classes. These should be the only functions that need re-writting in most cases. They build a path for the shape given a bounding parallelogram
NodeThreeBoolListItem
NodeToOutlinesBecomeAThe class that handles the convertion of a node to outlines. It receives all the paths passed back from the node, and appends them to a group object
NodeTypeEntry
NoiseBase
NoiseFillAttributeSpecifies a noise fill attribute for an object
NoiseFractalFillA noise based fill. Really simple
NoiseGen1
NoiseMan
NoiseTranspFillAttributeSpecifies a noise fill attribute for an object
NormCoordNormalised vector/coordinate When normalised, the vector is always of unit length
NotifiableAllows UIElements to interact with proxies
NotifierAllows UIElements to interact with proxies
NotifyingGadgetThis is an abstract class representing a gadget that notifies other Notifiable objects. Avoids multiple inheritance
NotifyNobodyDummy Notifiable object used to initialize references
NotSelectSourceConcretisation of NodeScan::Source for all NodeRenderableInks NOT in the application's selection range
NullQualifierA suffix qualifier is one of the form <...><QualifierToken>, e.g. 5.00%
NULLXaraFileDummy CXaraFile that swallows up all bytes written to it
ObjChangeFlagsDefines physical changes which have occured on an object. These should be as high level as possible. If your object has changed in a subtle way, try and choose the field which best matches the change. Try not to invent a new field for your change as like as not no one will respond to it
ObjChangeMaskDefines what messages if any are passed to parent objects. The starting message is not defined here as this is used to allow nodes to actually set the mask. All flags are initialised to FALSE and should be set by nodes to TRUE when they want to receive a message. If any parent node requires a message then all will get the message. Note the mask is verified and corrected so that messages will be sent correctly in sequence
ObjChangeParamProvides a derivable structure for passing to a nodes OnChildChange virtual function. To create this class parameter simply call Define with the necessary change variables
ObjChangeParamWithTokenIdentical to a ObjChangeParam object, except that there is an additional field that contains the OpToken
ObjChangePathEditA derived change parameter for use in path editing. It is exactly the same as ObjChangeParam apart from providing a path pointer, for use during eor drags, to describe the current state of the dragged path. Obviously this cannot be determined from the tree object until it has been updated when the drag finishes
ObjectCacheBase class for the cache. The cache replacement policy algorithms are implemented in the derived classes such as ObjectCacheRand...etc
ObjectCacheFIFOFIFO cache replacement policy See also: class ObjectCache
ObjectCacheRandomRandom cache replacement policy See also: class ObjectCache
ObjectCacheWeakestProvides a delete algorithm cache replacement policy according to the size of the object. See also: class ObjectCache
ObjectItemObjectItems are held in ObjectSets
ObjectRegistryThe object registry currently records the attributes which are required by each NodeRenderableInk node in Camelot. Such a list is required during attribute optimisation, to determine the attributes to collect to make a subtree attribute complete
ObjectSetA set of NodeRenderableInk objects
ObjInfo
Octree
OctreeElementColour octree
OffscreenAttrValue
OILBitmapTo encapsulate the OILy end of bitmaps. Each OIL layer inherits from this and puts real functionality into the class. Things defined in this class must remain kernel-ly
OilCoord
OILDockingBarThis is the base class for FixedDockBars and FloatingBars,
OilDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. OilDragTargets are used as a base class from which to derive drag targets for WINOIL entities (an optional HWND)
OILEnumFontsA class which allows kernel level and tool functions to inherit the ability to enum fonts. The class will call each OIL level font manager to enum their own specific set of fonts and the results will be returned to the derived NewFont() function
OILFilterThis class is used to encapsulate the platform specific features of a filter. Every Filter object has a pointer to an OILFilter object. For example, under Windows, it holds the file extensions that this file understands
OILFilterFamilyAutomate the production of the OIL parts of a filter family object
OILFixedDockingBar
OILFloatersThis class handles the OIL-specific parts of Floaters. They handle the low-level creation/deletion details,
OILFontManThe base font class controller inside the WinOil. The kernel should make calls to this font manager class only. The class acts as a switching layer calling other OIL level font managers dependent on the type of font in use
OILHorizontalRuler
OILModuleThis class hides the mechanism of loading modules via whatever OS calls are required. For example, under Windows it loads DLLs and interrogates them, whereas on the Arc something quite different could happen. It also provides a link between a kernel 'Module' item and the OIL transport mechanism used to load it
OILPanoseSpecification of the OIL related Panose code Abstract, static class, holding OIL related Panose code
OILPreferencesThis class, like the Preferences class, is only ever instantiated once. It is a collection of routines to be used to handle the OIL side of reading and writing preferences. This class is used internally by the Preferences class - no other class should need to use it
OilRect
OILRulerThis is the base class for Horizontal and Vertical rulers, It looks after the basic's - creating windows etc.. and handles all mouse events fo the rulers
OILTool
OILVerticalRuler
OpAddBlendPathAdds a blend path to the selected blends
OpAddNewPathThis op actually adds a new path to the current document. The path has been created and edited with OpPenCreatePath() which will handle EOR drawing It can now be instantiated as a physical object by this op
OpAddPathThe base class for various addpath operations. This is not really an operation in its own right as it does not provide an init and getstate function. Its use is to provide common functions required by distinct addpath operations
OpAddPathToPathThis op will add an element to an existing path within the tree. The new element and context path should be passed into the do function as parameters
OpAddShapesOp that invokes the Add Shapes operation performed by OpCombineShapes
OpAddWebFolders
OpAddWebLibrary
OpAffectFontChangeAn operation to update all text stories in all documents
OpAlignUndo-able Op to Align objects
OpAnimationProperties
OpApplyAttribVirtual base class for ops that apply attibutes
OpApplyAttribsToSelectedThis class represents the OpApplyAttribsToSelected operation. It applies the specified set of attributes to all selected objects
OpApplyAttribToNodeThis class represents the OpApplyAttribsToSelected operation. It applies the attribute to a specified object
OpApplyAttribToSelectedThis class represents the OpApplyAttribToSelected operation. It applies the specified attribute to all selected objects
OpApplyAttrInteractive
OpApplyCentreJustifyToStoryThis operation is the centre justify option on the TextStory pop-up menu
OpApplyClipViewOperation to apply ClipView to the selection. See also:
OpApplyFeatherEffectOperation to apply Bitmap Effect to the selection. See also:
OpApplyFullJustifyToStoryThis operation is the full justify option on the TextStory pop-up menu
OpApplyGlobalAffectAn operation to scan all objects in all documents, calling a user defined function to perform a none undoable operation on them
OpApplyJustificationToStoryThis operation is the base class of the operations that sit on the TextStory pop-up menu
OpApplyLeftJustifyToStoryThis operation is the left justify option on the TextStory pop-up menu
OpApplyLiveEffectOperation to apply Bitmap Effect to the selection. See also:
OpApplyNamesToOne
OpApplyNamesToSel
OpApplyNameToNone
OpApplyRightJustifyToStoryThis operation is the right justify option on the TextStory pop-up menu
OpAsynchBitmapImportThis operation will attempt to download and import a bitmap located on a web server
OpAsynchClipartImportThis class represents the Undo-able operation to import and open clipart files over the Internet
OpAsynchFontInstallThis operation will attempt to download and install fonts from a web server to the local machine
OpBackgroundAllows the background layer to be set up and changed
OpBackgroundParamParam passed to OpBackground::DoWithParams()
OpBarCreationThis class makes several copies of the selection, putting them onto particular named layers. Each copy is named button1, button2, etc.. Each layer is created and named Default, Mouse, Clicked or Selected. The copy can be 'mutated' to appear slightly different on each layer. The selection is deleted
OpBaseConvertPathSegmentThis is the base class for the two operations that convert curve segments into line segments and vice-versa
OpBevel
OpBitmapDownload
OpBitmapImport
OpBlendAntialiasThis changes the one-to-one flag of all selected blends
OpBlendNodes
OpBlendOneToOneThis changes the one-to-one flag of all selected blends
OpBlendTangentialThis changes the Tangential flag of all selected blends
OpBreakAtPointsThis class will break paths at selected points. The effect of this will be to either open a closed path or split a open path into two subpaths, or both dependent on the number of selected points in the path. There must be at least one selected point for this operation to complete correctly
OpBreakShapesThis class will break compound paths into two or more simple paths. It will work when there are one or more compound paths selected
OpBringToFrontThis class represents the BringToFront operation
OpBrowserPreviewPerforms an operation to preview the animation in a browser
OpCentredDragBoxThis is a base class for drag operations that would like a drag box to be centred on the initial click point, such as (optionally) the zoom tool. Apart from providing a new default CalcDragBox function, it is used the same way as OpDragBox
OpChangeBarExtends
OpChangeBarProperty
OpChangeBarPropParam
OpChangeBlendThis changes aspects of all selected blends
OpChangeBlendDistanceThis changes the distance between steps of the selected blends
OpChangeBlendStepsThis changes the number of steps of the selected blends
OpChangeBrushBase class for operations to change various features of the brush
OpChangeBrushDefinitionThis operation exists so that we can make undoable edits to the brush definitions stored in the brush component
OpChangeContourAttributeProfileThis changes the number of steps of the selected blends
OpChangeContourColourTypeThis changes the number of steps of the selected blends
OpChangeContourObjectProfileThis changes the number of steps of the selected blends
OpChangeContourStepDistanceThis changes the step distance of the selected blends
OpChangeContourStepsThis changes the number of steps of the selected blends
OpChangeContourToInnerChanges all contours to inner - used by the button on the infobar
OpChangeContourToOuterChanges all contours to outer - used by the button on the infobar
OpChangeContourWidthForces a regeneration of the bevel in all nodes in the list Used by NodeBevelcontroller::OnChildChange to force redraws in undos/redos
OpChangeFeatherProfile
OpChangeFeatherSize
OpChangeFeatherSizeParam
OpChangeFillProfile
OpChangeLayerColourAllows layers to have their colour changed
OpChangeLayerColourParamParam used to change the colour of a layer
OpChangeLineAttribOpDescAbstract base-class OpDescriptor to allow the user to change a line-attribute of all selected objects, or to set the AttributeManager's current attribute if no objects are selected
OpChangeLineCapOpDescOpDescriptor to allow the user to change the join-type of all selected objects, or to set the AttributeManager's current join-type attribute if no objects are selected
OpChangeLineJoinOpDescOpDescriptor to allow the user to change the join-type of all selected objects, or to set the AttributeManager's current join-type attribute if no objects are selected
OpChangeLineWidthOpDescOpDescriptor to allow the user to change the line width of all selected objects, or to set the AttributeManager's Current line width attribute if no objects are selected
OpChangeSetProperty
OpChangeTranspFillProfile
OpClearCacheTo allow comparitive timing of window redraws Notes: In the OIL
OpClipartImport
OpClipboardExport
OpClipboardImport
OpCloneThis class represents the Clone operation. When executed this operation makes a copy of all selected objects, leaving the new objects on top of the existing objects
OpCloseNodePathsThis operation is for closing all the open selected paths
OpClosePathWithPathThis op deals with a destination path being edited, and a source path which may be the result of a drag edit operation. The idea is that the op will take the components of the source path and add them in a deterministic way to the destination path, resulting in a closed destination path. The source path is assumed to have either 1 or 2 elements in it. The first element will be added to the end of the destination path and act as a closing piece. The second element of the source path will affect the first element in the destination path. If both elements match in type, ie are two curves, then the none end control handles of the source will be copied to the destination. This op as can be seen is rather specific, and is used by the pen tool to close an open path. Imagine clicking on the first control point of a path and draging out control handles. The handles will affect the previous and next elements of the path. The previous being a close element and the next being the first element of the path. Hence the need for this strange op
OpColEditCommandA polymorphic Op which is used for all generic colour editor "commands"
OpColourChange
OpCombineLayersToFrameLayer
OpCombineShapesBase class op that does all the shape combining ops, like add, subtract and intersect,etc
OpContourNodesCopy of the blend nodes operation in blndtool.h
OpConvertFileFormatsThe "Convert File Formats" debug command
OpConvertPathToShapesThis creates objects out of the paths of the selected objects
OpConvertToBitmapConverts objects into a bitmap
OpCopyThis class represents the Copy operation. When executed this operation makes a copy of all selected objects and places them on the internal clipboard
OpCopyAndTransformThis operation creates a transformed copy of the selected objects
OpCopyFrame
OpCopyMouldShapeAn undoable operation to copy the mould shape to the clipboard
OpCreateContourCreates contours on the selection
OpCreateFillAn operation to add a Linear Graduated Fill to the selected Object(s)
OpCreateFontThumbnails
OpCreateNewFrame
OpCreateNewMouldCreates a new mould object and all its various children to form a valid mould structure. The operation will execute only when there is one or more selected objects to work on. These selected objects will to all intense and purpose dissappear from the tree. They will move from their current positions and move inside the new mould node
OpCreateNodeBitmapCreates a new Node Bitmap, at a specific position on the page
OpCreateTextObjectThis operation is invoked to allow the user to insert a TextStory into the document. Currently the only way the user can create a TextStory is to click on a spread
OpCutThis class represents the Cut operation. When executed this operation hides all selected objects and places a copy of them on the Internal clipboard
OpDeactivateBrushThis operation takes a brush handle as a parameter, locates the appropriate brush definition and sets the flag indicating that it has been deactivated. Also removes the item from the line gallery and freehand combo
OpDelBarWill cut down the size of a bar to the number of buttons requested by deleting the last buttons in the bar
OpDeleteThis class represents the Delete operation. When executed this operation hides all selected objects
OpDeleteAllGuidelinesAllows guides to be Deleted
OpDeleteAllLiveEffectOperation to delete all Bitmap Effects on the selection. See also:
OpDeleteBitmapRemoves all references to a bitmap, and deletes it from memory
OpDeleteFrame
OpDeleteGuidelineAllows guides to be Deleted
OpDeleteLiveEffectOperation to apply Bitmap Effect to the selection. See also:
OpDeleteNamesFromAll
OpDeletePageBackground
OpDeletePointsThis class will delete any selected points from selected paths
OpDeleteTextStoryThis operation should be used to hide a particular TextStory
OpDescControlCreateMsgThis message is sent to an OpDescriptor after its controls have been created. It gives you a chance to perform control initialisation. eg. Set scrollbar ranges, fill listboxes ..
OpDescControlDestroyMsgThis message is sent to an OpDescriptor after its controls have been destroyed, It gives the OpDescriptor a chance to cleanup
OpDescControlMsgThis message is the OpDescriptor equivelant of a DialogMsg. It is sent when an OpDescriptor's control sends a message
OpDescMsgBase class for all OpDescriptor messages
OpDescriptor
OpDeSelectAllPathPointsThis operation is used to deselect all endpoints in a path
OpDetachBlendPathDetached the blend path from each of the selected blends
OpDetachMouldAn operation to attach and detach a mould manifold from its object This allows the manifold to be edited on its own without the moulded objects following. Handy for quick edits
OpDisplayBitmapGalleryDisplays the bitmap gallery. This op can be attached to a menu, button or keypress
OpDisplayColourGallery
OpDisplayFontsGalleryDisplays the fonts gallery. This op can be attached to a menu, button or keypress
OpDisplayFrameGalleryDisplays the frame gallery. This op can be attached to a menu, button or keypress
OpDisplayLayerGalleryDisplays the layers gallery. This op can be attached to a menu, button or keypress
OpDisplayLibClipartGallery
OpDisplayLibFillsGallery
OpDisplayLineGallery
OpDisplayNameGallery
OpDisplayTEMPLATEGallery
OpDragBoxThis is a base class for operations that use a drag box to select an area within a view, such as the selector and the zoom tools. This class looks after the chore of correctly drawing and updating the xored drag box
OpDragOriginDefines an operation for dragging perspective mould vanishing points around
OpDragRegularShapeThis operation is started by a NodeRegularShape when someone drags on one of its control points. As the control point is dragged about the new version of the shape, corosponding to the new blob positions, will be EOR rendered to the window
OpDragRotateCentreAllows you to drag the selector tool's centre of rotattion around
OpDragStoryIndentThis is the operation that is used to drag the indent position along the path the text story is on
OpDragStoryNonPathIndentBase class for dragging indents for stories not on a path
OpDragStoryNonPathLeftIndentThis is the operation that is used to drag the left hand path indent
OpDragStoryNonPathRightIndentThis is the operation that is used to drag the right hand path indent
OpDragStoryPathIndentBase class for dragging indents for stories on a path
OpDragStoryPathLeftIndentThis is the operation that is used to drag the left hand path indent
OpDragStoryPathRightIndentThis is the operation that is used to drag the right hand path indent
OpDrawBrushDraws a freehand stroke, smooths it and applies a nice brush effect
OpDroppedFile
OpDuplicate
OpDuplicateBarMake a complete copy of the bar. Only the buttons names are made unique and there is a new bar name. It is positioned next to the original bar
OpEditBlendEndObjectThe operation to edit the position of the end objects of a blend on a path
OpEditFillThis operation edits an AttrLinearFill already in the tree. It is normally started when the Tool detects a drag on one of its selected blobs
OpEditLegacyEffectHold all class for passing on requests to "edit" a legacy effect See also:
OpEditLiveEffectOperation to apply Bitmap Effect to the selection. See also:
OpEditRectangleThis operation edits a NodeRect already in the tree. It is normally started when the Rect detects a drag on one of its selected blobs
OpEditRegularShapeThis operation can be used to change the internal data members of NodeRegularShapes in an undoable way. It either changes one particular shape or all selected shapes. The data members are changed to those supplied by the parameter object
OpEffectLockOperation to change effect locked state. See also:
OpEffectLockAllOperation to change effect locked state. See also:
OpEffectResOperation to change effect resolution. See also:
OpenFileDialogBrings up an Open file dialog that goes to the correct directory etc
OPENFILENAMEEX
OperationThis abstract class represents an operation which is a single job initiated by the user. You should derive all non undoable operations directly from this base class
OperationHistoryThis class represents the operation history for a camelot document. It is a repository for all undoable operations performed in Camelot. It stores operations in chronological order and provides methods to undo and redo them
OpException
OpExitThis class represents the Exit Application operation
OpExportSets
OpExportSets::ExportHighlightedIterIterates over highlighted set items, re-exporting any that are export targets
OpFeatherEffectParamContain all the info transferred from the UI to the OpApplyLiveEffect operation
OpFillNudgeThe underlying nudge op that does a nudge on the selected points in a path
OpFitTextToCurveThis class is the operation used to fit a line of text to a path
OpFlgs
OpFlgsStr
OpFlipTransThis operation allows you to flip the selection either vertically or horizontally. It only has an immediate version and no interactive version
OpFrameProperties
OpFreeHandThis is the FreeHand Operation that builds a smoothed curve
OpGalleryCommandA polymorphic Op which is used for all generic gallery "commands"
OpGBrushOperation to toggle GBrush setting Notes: Will be on a dialog somewhere eventually
OpGDrawOperation to toggle gdraw setting Notes: Will be on a dialog somewhere eventually
OpGenericDownload
OpGrabAllFramesPerforms an operation to grab all of the frame layers and preview them
OpGrabFramePerforms an operation to grab the selected frame layer and preview it
OpGridBase class all grid operations are derived from
OpGridChange
OpGridCopyThis class represents the grid Copy operation. Currently, it just greys out the menu/button/keypress associated with the op
OpGridCutThis class represents the grid Cut operation. Currently, it just greys out the menu/button/keypress associated with the op
OpGridDeleteThis class represents the grid Delete operation
OpGridDuplicateThis class represents the grid Duplicate operation. Currently, it just greys out the menu/button/keypress associated with the op
OpGridNewResize
OpGridPasteThis class represents the grid Paste operation. Currently, it just greys out the menu/button/keypress associated with the op
OpGridResize
OpGridSelection
OpGroupThis class represents the Group operation
OpGuidelineAllows guidelines to be dragged around
OpGuidelineParamParam passed to OpGuideline::DoWithParams()
OpHelpTuple
OpHideColours
OpInsertFloaterThis is the operation that the line tool uses to insert the floating endpoint in an undoable kind of way
OpIntersectShapesOp that invokes the Add Shapes operation performed by OpCombineShapes
OpJoinShapesThis class takes two or more selected paths and combines them into one path
OpLayerChangeThis class represents the LayerChange operation which is created by the LayerManager to make changes to the layers of the current spread
OpLayerGalChange
OpLayerGalParam
OpLibGalClipTheme
OpListItemThe reason we need to store OpDescriptors in OpListItems is that OpDescriptors are MessageHandler objects and so are already potentially stored on a list
OpLiveEffectBase class for all LiveEffect ops See also:
OpLiveEffectParamContain all the info transferred from the UI to the OpApplyLiveEffect operation
OpMakeColourLocalToFrameOperation to create copy of a colour (and its descendants) for the current frame
OpMakeNodesShapesThis undoable operation converts a given list of nodes to editable shapes (paths), each new node retaining the selection status of the original
OpMakeSegmentsCurvesThis class will change all the selected segments in all selected paths from lines into curves (ignoring segments that are already curves!)
OpMakeSegmentsLinesThis class will change all the selected segments in all selected paths from curves into lines (ignoring segments that are already lines!)
OpMakeShapesThis class represents the MakeShapes operation
OpMakeStrokeThis class represents the MakeStroke operation
OpMenuExport
OpMenuImport
OpMenuLoadImports the specified file as NativeEPS
OpMenuParamContain all the info transferred from the menu UI to Ops
OpMenuSaveSaves the document to the file specified in the params to the disk using the NativeEPS format
OpMenuSelectPathPointsThis operation is the base of select/deselect all endpoints in a path
OpMouldLibProvides a library of undoable functions for moulding objects
OpMouldLibSelProvides a library of undoable functions for moulding objects
OpMoveBackwardsThis class represents the MoveBackwards operation
OpMoveForwardsThis class represents the OpMoveForwards operation
OpMovePathPointThis operation allows the exact positioning of elements in a path
OpMoveToLayerAn op to move the selection from where-ever it is to the active layer
OpMoveToLyrBehindThis class represents the move to layer behind operation
OpMoveToLyrInFrontThis class represents the move to layer in front operation
OpMsgThis message is sent whenever something happens to an operation
OpNameGalleryPropIndexDesc
OpNewGuidelineOp to create a new guideline immendiately
OpNewPathThis operation will create a new path of a single line or curve and put it in the tree
OpNewRegShapeProvides an operation for the regular shape tool to use to create and insert a new shape into the document tree (with undo etc...)
OpNodePathAddEndpointThis operation is started by the bezier editing tool when it wants to add a point to the start or end of a particular path. It uses the normal dragging of the base operation, but the action when the operation finishes is different. This class is derived from OpNodePathEditBlob which drags the normal selected points around
OpNodePathEditBlobThis operation is started by the NodePath when it receives a drag message from one of the tools. It uses it to drag one (or many) of the paths control points around the screen to edit the path. As the control points are dragged about the new version of the path, corosponding to the new blob positions, will be EOR rendered to the window
OpNodePathEditControlBlobThis operation is started by the NodePath when it receives a drag message from one of the tools. It uses it to drag one of the paths Bezier control points around the screen to edit the path. As the control points are dragged about the new version of the path, corosponding to the new blob positions, will be EOR rendered to the window. This class is derived from OpNodePathEditBlob which drags the normal selected points around. This drags the Bezier control points around of one of the selected points on the curve. Most of the functions are not needed as it uses the base class versions
OpNudgeThe underlying nudge op that does a nudge on the selection. Note: Mark initially implemented the twelve different types of nudge as twelve seperate ops. Simon changed this (07/11/94) so that it now uses only one operation, but has 12 OpDescriptors all of which map to the same operation. We determine the type of nudge we are after from the runtime class of the OpDescriptor in the Do function
OpOverprintFillAn Op for toggling the AttrOverprintFill attribute
OpOverprintLineAn Op for toggling the AttrOverprintLine attribute
OpPageResize
OpPalettePopupCommand
OpParamOperation parameter structure. The meaning of the structure's fields are defined by each operation. Note that sensible Operations will derive a special OpParam for their own specific needs, so you should use the derived class where it is available
OpParamBarCreation
OpParamBarCreationDlg
OpParamBarDuplication
OpParamBarRedefineStateDlg
OpParamBarStatesDlg
OpParamDelBar
OpParamExtendSetsDlgA parameter class for creating the ExtendSetsDlg with. See also: ExtendSetsDlg
OpParamMakeNodesShapesOpParam structure required to use the OpMakeNodesShapes undoable operation. See also: OpMakeNodesShapes
OpParamPasteAtPositionHolds information allowing the paste op to paste objects at a specific position
OpParamShortenBar
OpPasteThis class represents the Paste operation. When executed this takes a copy of all objects on the internal clipboard and adds them to the visible spread
OpPasteAttributesThis class represents the PasteAttributes operation. The operation applies all attributes common to the objects on the clipboard. This operation is not in itself undoable. It invokes another UndoableOperation to actually apply the attributes
OpPasteEnvelopeAn undoable operation to paste the contents of the clipboard as a mould shape
OpPasteMouldShapeAn undoable operation to paste the contents of the clipboard as a mould shape
OpPastePerspectiveAn undoable operation to paste the contents of the clipboard as a mould shape
OpPathNudgeThe underlying nudge op that does a nudge on the selected points in a path
OpPenAddElementGiven a path in the tree with a selected end point, this operation will control the creation of a new element (through clicks and drags), at the end of the path. It is derived from OpPenEditPath which controls all the eoring of path elements such as blobs and lines
OpPenClosePathThis op controls the closing of an open path. It performs the eoring of path elements a blobs during a click or drag action. It is primarily used by the pen tool an is brought into being when a click occurs over the startpoint of a path, having a selected endpoint
OpPenCreateInternalThis operation is started by the pen tool when it receives a click on the document with no previous internal or external state set. ie the pen tool is not holding a moveto element inside iteslf from a previous click and there are no selected endpoints to add to
OpPenCreatePathThis op is concerned with creating a new path in the tree. It is derived from OpPenEditPath, which handles all the dragging and redraw of a new path element. This op will use
OpPenDragBlobsThis op class is defined as a base class only. It provides common dragging functionality which is inherited by create and edit pen classes
OpPenEditInternalThis operation is started by the pen tool when it receives a click over its internal moveto point. The point will be converted into a dragto if a drag occurs
OpPenEditPathThis operation is started by the pen tool when it receives a click on a document and needs to create a new path. The idea is, it will drag edit a path until such time as the user lets go of the mouse. and then add the path to the tree. The operation handles the internals of rendering the eor path
OpPenHandlesThis operation simply provides functions for other operations to use. It is not intended to be used as an operation in its own right. Most useful pen classes are derived from this
OpPreviewPopupCommandThe context menu handling for the bitmap preview dialog
OpPrintThis class represents all the Printing operations
OpPrintOnAllPlatesAn Op for toggling the AttrPrintOnAllPlates attribute
OpPullOntoGridTranslate the selection so that one of it's corners lies on the grid
OpPushThis is the Push operation that slides the document about
OpPutToBackThis class represents the PutToBack operation
OpQualityOperation to set quality level on a DocView Notes: Will be on a dialog somewhere eventually
OpRectangularEnvelopeSimple operations to handle the creation of default envelope and perspective shapes
OpRectangularPerspectiveSimple operations to handle the creation of default envelope and perspective shapes
OpRedefineNamesAsSel
OpRedoThis class represents the Redo operation
OpRedrawColours
OpRedrawColoursInfoThis non-undoable operation is used by the colour manager to redraw all nodes of the document which have been affected by changes to a colour or colours
OpReformShapeEdgeThis operation is started by a NodeRegularShape when someone drags on one of its edges. It is used to interactively reform the path used to form the edge of the shape
OpRegisterManage registration of CD
OpRemoveAttributeFromSelectionDelete a Node from the tree
OpRemoveBlendThis removes the selected blend objects, leaving the original objects in the tree
OpRemoveClipViewOperation to take apart the selected ClipView object
OpRemoveContourRemoves contours on the selection
OpRemoveFloaterThis is the operation that the line tool uses to remove the floating endpoint in an undoable kind of way
OpRemoveMouldAn undoable operation to remove the mould shape from a mould object
OpRemoveNamesFromSel
OpRenameAll
OpRepeatApplyAttribToSelectedThis class represents the OpApplyAttribToSelected operation. It applies the specified attribute to all selected objects
OpReplaceAttributesThis class represents the OpReplaceAttributes operation. It replaces specific attributes with a new one
OpResetSpreadOriginOp to reset the spread (user and grid) origin
OpReshapeOrAddPointThis operation serves two purposes - while dragging, it will reshape a bezier segment, changing the path on ending the drag. However, if the drag is released immediately after it is initiated, a point is added to the bezier curve (or line) at the click point
OpRetroFitThis operation handles the updating of a freehand path after it has been retro fitted
OpRetroSmooth
OpReversePath
OpReverseStoryPathThis operation should be used to hide a particular TextStory
OpRotateMouldAn operation to rotate a set of objects within a mould manifold. The op simply changes the start point of a mould path object by rotating it around one logical element. The result is simply to spin the orientation of the moulded objects within the mould shape
OpRotateTransThe operation that performs the interactive EORed dragging during a rotation
OpSaveAnimatedGIFPops up a common dialog to allow the user to export an animated GIF from Camelot. This is for the special frame related export so we have all the options set up
OpSaveAsNativeV1Saves the document to the file specified in the params to the disk using the Version 1 Native format i.e. Native EPS
OpSaveAsNativeV2Saves the document to the file specified in the params to the disk using the Version 2 Native format
OpSaveAsWebSaves the document to the file specified in the params to the disk using the Web format
OpScaleTransThis is the interactive and immediate scale operation
OpSelectAllPathPointsThis operation is used to select all endpoints in a path
OpSelectBrushThis operation can take place only in the Freehand tool. If there is a single selected brush then it makes that brush selected in the combo so that the user can draw with it straight away rather than having to select it in the combo themselves. Note that it is not undoable because a) it makes no change to anything in the document and b) it can only be called whilst in the Freehand tool (and what would happen if it were undone outside of the Freehand tool is rather hard to define)
OpSelectEndFrame
OpSelectIntersectSets
OpSelectNextFrame
OpSelectorDragBoxThis operation is started when the user does a drag over the document, that started in empty space. A drag box will be drawn out over the document as the user moves the mouse about and when the drag ends, all the objects wholly inside the box will be selected
OpSelectPathPointsThis is the operation that marquee selects points in paths
OpSelectPrevFrame
OpSelectSet
OpSelectStartFrame
OpSelectUnionSets
OpShapeMakeRegularThis is an operation that makes one QuickShape regular
OpShapeToggleBaseThis is a base class for operations that toggle certain states of a QuickShape
OpShapeToggleCurvatureThis class is an operation that toggles the curvature state of all selected QuickShapes
OpShapeToggleElipPolyThis class is an operation that toggles the ellipse/polygon state of all selected QuickShapes
OpShapeToggleSetNumSidesThis class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides10This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides3This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides4This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides5This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides6This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides7This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides8This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleSetNumSides9This class is an operation that sets the number of sides of all selected QuickShapes
OpShapeToggleStellationThis class is an operation that toggles the stellation state of all selected QuickShapes
OpShearTransThe operation that performs the interactive EORed dragging during a shear
OpShortenBarWill cut down the size of a bar to the number of buttons requested by deleting the last buttons in the bar
OpShowGridAllows the user to toggle the visible state of all grids. Notes: -
OpShowGuidesAllows the user to toggle the visible state of all guides. Notes: -
OpShowPrintBordersAllows the user to toggle the visible state of the print borders Notes: -
OpShowPrinterColoursAn Op for toggling composite print preview on and off
OpShowStateWill cut down the size of a bar to the number of buttons requested by deleting the last buttons in the bar
OpSliceThe "Image Slice" menu item
OpSliceDragBoxDrag box class for the SliceTool. Allows the user to select a number of named sets, by dragging a box around some objects on the document. All objects sharing the same names as those inside the box will then be selected
OpSliceShapesOp that invokes the Add Shapes operation performed by OpCombineShapes
OpSliceTranslateThis is the Slice tool's Translate operation, which is similar in behaviour to OpTranslateTrans, except that we inform the user during the drag if the current selection's bounds overlap those of an unselected named set (button). When doing an immediate transform the params to DoWithParams() are :- Param1 - All the standard transform data Param2 - A pointer to a DocCoord that holds to offset translate by
OpSmoothSelectionThis class will smooth paths between selected control point regions. It processes all selected objects within the current document
OpSnapToGridAllows the user to toggle snap-to-grid on and off. Notes: -
OpSnapToGuidesAllows the user to toggle snap-to-guides on and off. Notes: -
OpSnapToObjectsAllows the user to toggle snap-to-objects on and off. Notes: -
OpSpreadOriginAllows you to drag the origin to another place
OpSquashTransThe operation that performs the interactive EORed dragging during a Squash
OpState
OpSubtractShapesOp that invokes the Add Shapes operation performed by OpCombineShapes
OpTextAutoKernThis Operation applies autokern to the FocusStory
OpTextCaretOpTextCaret groups together all caret moving ops
OpTextFormatThis class implements many of the 'operations' which will cause the TextStory to be reformated
OpTextKernThis Operation applies a kern to the FocusStory
OpTextPasteAn undoable operation to paste the contents of the clipboard into a text story
OpTextSelectionThis is the operation that positions the caret after a click, and then does a drag to select characters. It also provides other functions for selecting groups of characters
OpTextUndoableAll undoable text operations are derived from this base class. It provides useful functions required by all Undoable Text Operations
OpThrottleCacheTo allow comparitive timing of window redraws Notes: In the OIL
OpThumbDownloadThumbnail download operation
OptimalBitmapRenderCallback
OptimalPrintRenderCallback
OpTimeDrawTo allow easier timing of window redraws Notes: In the OIL
OptionsChangingMsgThis message is sent when a user has changed the options on a document or a global application based option. At present the messages include:-
OptionsTabsThese encompass all the tabs available for the options dialog box to use
OpToggleCompositePreviewAn Op for toggling composite print preview on and off
OpToggleContourInsetPathToggles the inset path states of all selected contours
OpToggleCyanPreviewAn Op for toggling cyan plate print preview on and off
OpToggleDoubleBufferThis class represents the OpToggleDoubleBuffer operation. Creating an instance of this class and calling its "Do" function will toggle the state of the flag controlling whether double buffering is used for rendering on GTK
OpToggleForeThis class represents the ToggleFore operation. Creating an instance of this class and calling its "Do" function will toggle the state of the flag controlling whether any RenderRegions created by the current DocView will be submitted to the background rendering system or not
OpToggleKeyPreviewAn Op for toggling Key plate print preview on and off
OpToggleMagentaPreviewAn Op for toggling Magenta plate print preview on and off
OpToggleMonoPlatePreviewAn Op for toggling mono plate print preview on and off
OpToggleMouldGridAn operation to turn a particular moulds grid on and off
OpTogglePressure
OpTogglePrintTextAsShapesThis operation toggles the state of the "print text as shapes flag" in selected TextStories
OpToggleScrollThis class represents the ToggleScroll operation. Creating an instance of this class and calling its "Do" function will change the state of the BOOL which determines whether standard Window scroll bars or RISCOS-like proportional scroll bars are used
OpToggleSmoothWhen a path point is double-clicked on, this operation is invoked to toggle the smoothness of the point. This works much like the equivalent feature in ArtWorks except that making a smooth point into a cusp will change the position of the control points
OpToggleSolidDragThis class represents the OpToggleSolidDrag operation. Creating an instance of this class and calling its "Do" function will toggle the state of the flag controlling whether double buffering is used for rendering on GTK
OpToggleSpotPreviewAn Op for toggling Spot plate print preview on and off
OpToggleYellowPreviewAn Op for toggling Yellow plate print preview on and off
OpToolSelectThis class is used for Tool Selection
OpTranslateTransThis is the interactive and immediate Translate operation. When doing an immediate transform the params to DoWithParams() are as follows :- Param1 - All the standard transform data Param2 - A pointer to a DocCoord that holds to offset translate by
OpUndoThis class represents the Undo operation
OpUngroupThis class represents the UnGroup operation
OpUngroupSpecialThis class represents the UnGroup Special operation
OpUpdateThis class represents the Update operation
OpURLImport
OpWhatsThisThis class represents the global "What's This?" operation
OpZoomThis operation can perform zooms in and out of the current DocView, either by an immediate call to the ZoomIn/ZoomOut/ZoomInOnRect/ZoomAtPoint functions, or by a call to the DoDrag function, which starts a mouse drag to define a zoom box
OpZoomComboDescriptorOpDescriptor for the zoom tool's combo-box containing scale factors
OpZoomDescriptorBase class to the two zoom tool OpDescriptors, OpZoomComboDescriptor and OpZoomButtonDescriptor. Simplifies the parameters required by a constructor call, and provides default GetState and message handlers
OpZoomFitDrawingDescriptorOpDescriptor for the zoom tool's "Fit to drawing" button
OpZoomFitRectDescriptorOpDescriptor used to zoom to a specific rectangle
OpZoomFitSelectedDescriptorOpDescriptor for the zoom tool's "Fit to selected" button
OpZoomFitSpreadDescriptorOpDescriptor for the zoom tool's "Fit to spread" button
OpZoomInThis op has been written so that we can use the NumPad Plus key to fire off a zoom in operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OpZoomOutThis op has been written so that we can use the NumPad Minus key to fire off a zoom out operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OpZoomPrevZoomDescriptorOpDescriptor for the zoom tool's "Previous Zoom" button
OpZoomTo100This op has been written so that we can use the NumPad Plus key to fire off a zoom in operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OpZoomTo200This op has been written so that we can use the NumPad Plus key to fire off a zoom in operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OpZoomTo300This op has been written so that we can use the NumPad Plus key to fire off a zoom in operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OpZoomTo400This op has been written so that we can use the NumPad Plus key to fire off a zoom in operation. We can`t use the zoom op directly as the hotkey code calls the Do() function instead of the DoWithParam(). What this class does is basically call the ZoomOps DoWithParam() from it`s Do() function
OriginalBitmapRefA reference to the original bitmap, before it was decompressed
OriginContextMenuImplements the Ruler context sensitive menu
OriginGadgetThis is the class for the "set origin" gadget,
OSRenderBitmapSpecial version of a RenderRegion that can render into a bitmap. For now it is monochrome only. It can also be asked if it is 'blank' - this can be used for proper click detection. If USE_GDRAW_BITMAP is defined then this class is much reduced, its functionality being subsumed by GRenderClick
OSRenderRegionEncapsulates rendering using the OS. (GDI, RiscOS, etc). This object is created when something needs rendering using the OS calls instead of Gavins routines. This will be ALL THE TIME for the moment. See RenderRegion notes for more general details of this class
OSRRFontInfo
OutlineDecompositionState
OUTLINETEXTMETRIC
OutputDIBContains functions to write a DIB to a Windows BMP in segments, optionally with compression, optionally converting from one depth to another. To use: Open a CCFile for write. Call StartFile to write out the header. Call WriteBlock to write out each block of the bitmap, starting from low memory. When you're done, call TidyUp
OutputGIFContains functions to write a DIB to a GIF in segments, optionally with compression, optionally converting from one depth to another. To use: Open a CCLexFile for write. Call StartFile to write out the header. Call WriteBlock to write out each block of the bitmap, starting from low memory. When you're done, call TidyUp. Similar to OutputDIB but strangely enough writes the data as a GIF instead of a BMP or via the AccusoftFilters
OutputPNGContains functions to write a DIB to a PNG in segments, optionally with compression, optionally converting from one depth to another. To use: Open a CCFile for write. Call StartFile to write out the header. Call WriteBlock to write out each block of the bitmap, starting from low memory. When you're done, call TidyUp. Similar to OutputDIB and OutputGIF but strangely enough writes the data as a PNG instead of a BMP or via the AccusoftFilters
OverprintFillAttrValueAttribute value indicating if overprint-Fill is enabled or disabled
OverprintLineAttrValueAttribute value indicating if overprint-line is enabled or disabled
OverrideListAn override list contains items that can override each other
OverrideListItemAn item in an OverrideList. See class OverrideList for an explanation
p
PageRepresents the actual bits of paper on which the document will be printed
PageDropInfoGives info about where an drag has, or is going to be, dropped on a page
PageMarkRegionHolds the position and orientation of a page mark region. ie the region a page mark will be formatted in. There are current 16 regions around a typical page each having a vertical or horizontal orientation
PageMarkRegionsA simple structure holding the positions of all 16 page mark regions around a typical page. The constructor of this class creates the regions given the bounding rect of a page
PageRectStores a rectangle and thats it. When printing, the print manager adds rectangles to this list
PageRectListKeeps a list of page rectanges in order to service the crop mark renderer
PageResizeInfo
PageSizeEncapsulates all the page size information and functionality in one class. The class knows what size an A4 page is and what its textual name is
PageSizesListEncapsulates all the page size information and functionality in one class. The class knows what size an A4 page is and what its textual name is
PageTabAllows the user to set any options which are normally associated with the document's page. This includes such things as:- The size of the page as either a predefined page size or A custom page with explicit width/height control. Choice of Portrait or Landscape. Bleed size. Show page shadow switch
PageTabAppPrefsDlgTo open up the application preference's dialog box with the page tab selected. This is used by the pop up menu when on the page
PaintShopProPaletteFilterMicrosoft Windows palette filter
PAINTSTRUCT
PaletteSomething that should have been done long ago..
PaletteContextMenu
PALETTEENTRY
PaletteFilterBase class for all palette filters
PaletteFilterFamilyA filter for all palette files
PaletteIteratorSomething that should have been done long ago..
PaletteManager
PaletteOptimiser
PaletteOptimiser::Box
PaletteOptimiser::Clr
PaletteOptimiser::PalEntry
PaletteOptimiser::Stats
PANOSEKernel Panose related class and functions
PaperRenderRegionProvide a fast way of rendering paper. One of these regions is used to render paper on screen, to avoid any lag we might get from using a bitmap type render region (e.g. GRenderRegion)
PaperSizesType
ParamOpDescriptorNew ParamOpDescriptor class whose purpose in life is to allow an OpDescriptor to be created which instead of using a resource id to get the menu item/operation item text, uses a string resource. This then means we can use the name from the plug-in instead of having to resource all names!
ParserThis parser is in fact a lexical analyzer for ScaleUnit's It matches Numbers (IsNumeric) & Qualifiers (IsCharUnitType). Anything else is considered Unknown. This is just a fill in while I consider how to provide something more generic. The code is blardy awful, partly because of lack of support in the StringBase class. To use it (not that you would), do something like: MonoOn: Parser myParser(stringToParse); if (PrepareForParse() == FALSE) ... if (GetToken() == Parser::TK_QUALIFIER)... myQualifier = GetSemanticValue(); MonoOff: Repeated calls to GetToken() will move along the stringToParse until the end of the string is reached when TK_EOS is returned
PassThruBufferA simple structure for passing data to PostScript devices under Windows. It holds the number of bytes in the buffer followed by the data. (See SDK/MFC docs for Escape() function)
PasteSpecialDlgAllows the user to choose the clipbaord format to be pasted
PathCreation, manipulation and use of Paths. A path is an arbitary collection of MoveTo, LineTo and CurveTo segments Public Member variables :- BOOL IsFilled - TRUE if this path if filled, FALSE otherwise
PathBecomeAConverts nodes to paths
PathEditedMsgThis message is sent whenever a single control point or an endpoint on a path is edited. A client of this message is the Line tool, which uses the data in this message to update the edit fields in its infobar
PathExtraInfoCreation, manipulation and use of extra information on paths, eg. Pressure. A path will have a pointer to an instance of this class if it has some extra information associated with it. The extra info is stored as a number of channels, each of which is an array of 'PathExtraElements' (currently UINTs). These channels can then be mapped to one of the known 'provider data' types, eg, Line Width, Colour etc
PathFlags
PathFlagsRecordHandlerHandles the reading of the path flag record in the v2 file format
PathNameRepresents a simple path and filename
PathNameExExtended pathname class, having some extra features we needed in Webster:
  • allows access to the drivename
  • it can create a directory path on the storage medium if not present
PathNameListItem
PathProcessorThis is the abstract base class for all PathProcessors
PathProcessorBrushThis path processor renders the new brush objects in place of the paths that are passed to it. It contains many variant members which can affect the placing, scaling and other aspects of the objects that are rendered. The ink objects that are actually rendered come from a BrushDefinition object. The path processor maintains a pointer to an AttrBrushType which is the attribute node that 'owns' the processor
PathProcessorStrokeThis is the abstract base class for all PathProcessors
PathProcessorStrokeAirbrushA path processor which renders paths as airbrushed strokes
PathProcessorStrokeVectorA path processor which "moulds" vector clipart along a path
PathRecordHandlerHandles the reading of all fill attribute records in the v2 file format
PathStrokerAbstract Base class Converts a Trapezoid (See ProcessPathToTrapezoids, pathtrap.h) stroke definition into an output path
PathStrokerVectorPath stroker Converts a Trapezoid (See ProcessPathToTrapezoids, pathtrap.h) stroke definition into an output path
PathUtilBase class for path utility static functions. These functions operate on sections of paths, ie lists of doc coords, but do not process complete paths and hence cannot be included as member functions of the paths class. The class contains no member variables, just static member functions which would otherwise be global if not for the fabby idea of encompasing them together under a class structure
PBMFilterEncapsulates a Unix PBM import filter
PBMOILFilterProvide the OIL parts of the PBM filter which loads in the file as a BMP
PColourCIET
PColourCMYK
PColourGeneric
PColourGreyT
PColourHSVT
PColourIndexed
PColourRGBT
PCXOILFilterProvide the OIL parts of the PCX filter which loads in the file as a BMP
PendingRedrawsEncapsulates a set of regions in a DocView, which must be accumulated in order for them to be redrawn at some point, possibly all in one go. This class chooses the most efficient invalidation method, according to the number and nature of regions added
PenToolThis class handles the Pen Tool that is used to draw lines and curves via clicking and draging on the workarea
PenToolInfoBarOpClass for handling the pen tool's information bar
PenToolInfoBarOpCreateClass for creating PenToolInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
PerspectiveShapesThe default perspective shapes class. This class provides a bunch of static functions to create some default shapes. All shapes are defined on a (0,0),(72000,72000) coordinate system
PGMFilterEncapsulates a Unix PGM import filter
PGMOILFilterProvide the OIL parts of the PGM filter which loads in the file as a BMP
PhotoCDDlg
PhotoCDDlgParamAllows data to be passed into the photocd options dialog box and then returned to the caller
PhotoCDOILFilterProvide the OIL parts of the PHOTOCD filter which loads in the file as a BMP
PhotoShopEPSFilterA filter that imports EPS files in Adobe Photoshop EPS format. Well, actually it doesn't as it's just a stub to stop Photoshop files from being loaded in (as they stuff up)
PhotoShopEPSOILFilterProvide the OIL parts of the PhotoShop EPS filter
PhotoShopOILFilterProvide the OIL parts of the PhotoShop filter which loads in the file as a BMP
PICTOILFilterProvide the OIL parts of the PICT filter which loads in the file as a BMP
Pixel32bppThis structure defines the layout of a 32bpp RGB pixel value, in a nice kernel compatible way. They should be used for kernel access to bitmaps so that pixels are treated in a platform independent manner
PlasmaFractalFillA fractal fill class. Static fns only
PluginFilterProcess
PlugInHandlerProvides specific characteristics of a type of plug-in. This includes the type of file which the plug-in in usually stored in. This provides the basis of which a handler is derived from
PlugInItemProvides the minimum requirement to store details on a plug-in
PlugInManagerProvide general handling facilities for plug-ins in Camelot
PluginNativeFilterThis is the plugin import/export filter that passes Xar format data to an external object for further processing
PluginOILFilterThis class is used to encapsulate the platform specific features of a filter. Every Filter object has a pointer to an OILFilter object. For example, under Windows, it holds the file extensions that this file understands
PlugInOp
PlugInOpDescriptorNew PlugInOpDescriptor class whose purpose in life is to allow an OpDescriptor to be created which instead of using a resource id to get the menu item/operation item text, uses a string resource. This then means we can use the name from the plug-in instead of having to resource all names!
PlugInPathRepresents a pathname object that the user has requested that all plug-ins be loaded in from
PlugInPathListHolds a list of Pathnames that the PlugInManager will use to search for plug-ins. The list is set up by the user in the plug-ins options tab
PlugInsContextMenuImplements the plug-ins context sensitive menus
PlugInsTabAllows the user to define options assocaited with plug-ins. At present this covers:-
  • setting up the pathnames to use
  • a switch to say whether to parse the plug-ins at start up or not
PlugInUndoOpUndoable Operation so that a plug-ins can be invoked and used
PlugsTabAppPrefsDlgTo open up the document preference's dialog box with the plug-ins tab selected. This is used by the plug-ins menu item (under 'Bitmap Effects & Plug-Ins')
PNGExportOptionsBase class for storing information about the bitmap we're exporting
PNGFilterEncapsulates a PNG export filter. Derives off the masked filter which provides funcitonality for doing masked bitmap export and import
PNGOILFilterThe PNG File format Oil Filter (Extension etc)
PNGProgressBarControls the status bar while loading / saving png files
PNGUtilContains functions to read in a PNG file as a DIB
POINT
Point2
PointersTabAllows the user to set any options which are normally associated with Pointers. This includes such things as:- Magnetic snap radii Actions for the different mouse buttons
PolygonRecordHandlerHandles rectangle type records from the new file formatRecord handler for polygons, used when importing polygons from the new file format. Derived from the regular shape record handler, so we use all the functions in that class to complete the regular shape
POLYPOLYGON_INFO16
PositionCaretActionThis action is used to position a caret within a TextStory. Its execute function inserts another PositionCaretAction into the undo record to return the caret to its current position and then moves it to the stored position
PPMFilterEncapsulates a Unix PPM import filter
PPMOILFilterProvide the OIL parts of the PPM filter which loads in the file as a BMP
PPStackLevel
PreDelFactorOutInfoItemPreDelFactorOutInfoItems are used by the GetPreDelFactorOutInfo and DoFactorOutAfterDeletion functions. See these for a description of its purpose
PrefData
PreferenceChunkObjects of this class hold a chunk of preferences for a particular section of the preferences. There may be more than one chunk for a given section, depending on how accurate the initial declaration of the section's size was
PreferenceEntryInstances of this class hold information about a single preference. This is a very simple public class with no member functions
PreferencesMaintains a list of PreferenceSection objects, and allows clients to declare new sections, and add new preferences to the sections
PreferenceSectionHolds all the preferences for a particular section of the preference file. These preferences are stored in one or more instances of the PreferenceChunk class. These instances are linked together as a List by this class
PrefixQualifierA prefix qualifier is one of the form <QualifierToken><...>, e.g. 5.00
PrePostTextActionThis action will be generated at the start and end of an OpTextUndoable operation. It will perform the following tasks
PressureItemTo store information about brush objects, including pressure
PressureSmootherGiven a bunch of pressure samples (from a graphics tablet, or simulated from mouse movements) this class provides methods to produce a ValueFunction object representing the variable-pressure information. The pressure information is smoothed to reduce the amount of data that needs to be saved, and to improve the quality of the pressure information (e.g. to get smooth pressure-pen strokes)
PreviewContextMenuThe context menu for the bitmap preview dialog
PreviewDialog
PreviewDialog::PreviewTimer
PreviewFilterThe filter's sole purpose is to hold the PreviewBitmapSize static. It can not import, export or appear on a menu. Notes: 20/01/97 This class used to be derived from AccusoftFilters (but prob never should have been). All other preview filters were derived from this, but are now derived from their respectively similar file filter i.e. PreviewFilterBMP is derived from BMPFilter. This causes a problem with FILTERIDs cos FILTERID_PREVIEW_TIFF is defined to be the same as FILTERID_PREVIEW obviously this won't work now that the filters are not all derived from PreviewFilter
PreviewFilterBMPThe filter will save out the BMP Preview Bitmap. Overrides GetExportOptions so dialogs are not put up but returns preview export options
PreviewFilterGIFThe filter will save out the GIF Preview Bitmap. Overrides GetExportOptions so dialogs are not put up but returns preview export options
PreviewFilterJPEGThe filter will save out the JPEG Preview Bitmap. Overrides GetExportOptions so dialogs are not put up but returns preview export options. Note: 22/01/97 Preview filters can generally import as well now (if their base class can) but obviously this one can't - use JPEGImportFilter instead
PreviewFilterPNGThe filter will save out the PNG Preview Bitmap. Overrides GetExportOptions so dialogs are not put up but returns preview export options
PreviewInBrowserTabAllows the user to set various Animation Colours
PrintBaseTabAllows the user to set any options which are associated with general document printing
PrintComponentProvide a component that contains a ptr to the document's PrintControl object
PrintComponentClassProvide a class that will add print components to new documents
PrintControlThis class encapsulates all the print settings for a document, and controls how the document pages are printed on the paper
PrintGeneralTabAllows the user to set any options which are associated with general document printing
PrintImagesetterTabAllows the user to set various imagesetting options
PrintingMaskedRenderRegionThis is a simplified version of the MaskedRenderRegion. It does not have to cope with a mix of complex and simple shapes to be rendered, but knows that there will be a run of complex shapes and then all the rest will be simple
PrintingRecordHandlerHandles importing of the print options records: TAG_PRINTERSETTINGS TAG_IMAGESETTING TAG_COLOURPLATE
PrintLayoutTabAllows the user to set any options which are associated with general document printing
PrintMarkThis class contains all the information pertaining to a mark. ie the type of mark it is, its menu text, icon id and a list of all the regions and formatting rules it uses
PrintMarkComponentClassThe class that gets a print mark doc component going on start up We need to register our class as a document component and this is where we do it all
PrintMarkItemThe PrintMarkItem contains details about this print mark. It holds the mark type, formatting information and a pointer to a subtree of objects which represent the mark. It also contains various bits of information used by Camelots UI to present the mark to the user
PrintMarksCacheThe print marks cache. This class contains a list of cached printmarks kept by the print marks manager. It is split into its own class here to avoid complications will the mark managers handling of cache marks and document component marks
PrintMarksComponentAn actual print mark document component. This component contains a list of handles which refer to print marks cached by the print marks manager. On saving, the mark handles will be resolved into physical marks which will be exported and subsequently imported and registered
PrintMarksManThe 'Print Marks Manager'. This manager handles the installation, formatting and rendering of printer marks. It liaises with the print box to provide a UI to enable and disable print marks
PrintMonitorMonitors print jobs to ensure that we don't try to start more than one simulataneously, and to ensure that print jobs are released when we suffer a serious error (CPU exception). Also repository for printing preferences
PrintMsgThis is sent when something to do with the printer has happend
PrintOnAllPlatesAttrValueAttribute value indicating if "print on all plates" is enabled or disabled
PrintPatchInfoThis class encapsulates all the info required to print the next patch on the current piece of paper
PrintPrefsDlg
PrintProgressDlgMaintains the print progress dialog which shows the user how the print is going and also allows them to cancel the print at any time
PrintPSRenderRegionProvide a render region for rendering to PostScript devices (usually via a PostScript printer driver)
PrintRenderCallbackHandling callbacks from RenderTree Notes: RenderTree function calls the main function in this class when it's about to render any Node
PrintSepsTabAllows the user to set options which are associated with printing colour separations
PrintTabPrintPrefsDlgTo open up the print preference's dialog box with the print tab selected. This is used by the units button on the tool bars
PrintView
ProcessBitmapStateHolds the state of a bitmap during processing and implements functions to push the bitmap through the processing pipeline
ProcessDistanceIf a platonic piece of string whose length l and endpoints (p0,p1) is laid along a path [e0,e1,e2,....en], this class calculates the index of the element ei, which contains p1 and the parameter mu (0<=mu<1) which can be used to calculate the actual coordinate value of p1
ProcessFlags
ProcessFlattenFlattens a path to the user specified output buffer using a given flatness
ProcessGridAn abstract class used for processing a grid
ProcessGridForceRedrawForces a redraw on the given grid
ProcessGridUnitMsgSomething has happened to the units system
ProcessLengthCalculates the length of a path
ProcessPath
ProcessPathDistanceProcess path to find Coord and Tangent at specified distance along path
ProcessPathToTrapezoidsProcess a path to produce a trapezoid list suitable for variable- width or vector-brushed stroke generation
Progress
ProgressDisplayEncapsulates various bits of information required to provide a progress display while printing/exporting via View::RenderSimpleView()
PropertyTabsThese encompass some useful functionality which is required to get a property dialog tab up and running. This is the baseclass and should always be derived off from. Tabs currently available are:-
  • layer properties dialog box
PropMapEntry
PSDCFontInfo
PSPPaletteOILFilterProvide the OIL parts of the paint shop pro palette file filter
PSPrintDCProvide a device context for printing to a PostScript printer
PtCoefs
PushModule
PushToolThis class handles the Push Tool that is used to slide the document about in a more convienient way than using the scroll bars. Most of the hard work is done in the OpPush (The push operation)
QualifierA ScaleUnit is defined by: A range for which the scaled value is between 0 & 1 A scaler which converts any value in its range to between 0 & 1 A qualifier which may be prefixed or suffixed onto the value NB: There are no base units as such
QualityEncapsulates the 'quality' of rendering, which in ArtWorks-speak was the WYSIWYG value. It is really a numeric value, but this fact should be hidden from everyone who should ask specific things of it, not use its value
QualityAttributeAttribute for quality of display/rendering
QualitySliderDescriptor
QuantisationCell
QuickRenderer
QuickShapeBaseThe base class for the Quick shape tool family. Not actually a tool itself but the QuickShape, Ellipse and Rectangle tool are derived from it
QuickShapeBaseInfoBarOpClass for handling the Regular Shape tool's information bar
QuickShapeBaseInfoBarOpCreateClass for creating RegShapeInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
QuickShapeToolThe QuickShape tool
RadialFillAttributeSpecifies a radial fill attribute for an object, including the two vectors that define the ellipse
RadialTranspFillAttributeSpecifies a radial fill attribute for an object, including the two vectors that define the ellipse
RadioGroupAllows user interface gadgets (GadgetID) to be associated with objects (CCObject), which can then respond to messages sent to the gadgets
RalphDocumentThe RalphDocument COM object
RampItemDefines whats common to all ramp items, i.e. their position and selection state
RandomSelection
Range
RangeControl
RangeEnumeratorIterates through a series of NodeRenderable nodes
RangeListHolds a list of ranges. This is used to keep track when importing a file and preserving the layer information, and the import was initiated via drag and drop. When the import has finished, the bounding box of all the nodes on all the ranges is found, and then the all the nodes in all the ranges are centred on the drop point
RangeListItemHold a range that
RangeSourceConcretisation of NodeScan::Source for all NodeRenderableInks in a Range (generally), or in the Application's SelRange object (specifically)
RealLogPalette
RecalcBoundsActionAn action which records the bounding box of a node, and replaces it on Undo, invalidating that area. This action should be added to the action list before modifying the object's bounding box. Please note that for undo and redo to work correctly, after you have modified the bounding box, you should create a RecordBoundsAction object and append that to the action list. This action is the opposite action to Recalc, and the two should always be used in tandem
RecordBoundsActionAn action which simply marks the fact that, when undone, it has to create a RecalcBoundsAction, and invalidate the existing bounds. It is the opposite action to RecalcBounds and should be used after creating a Recalc object and modifying the bounding box. Even when executed, all the action does is invalidate the screen and create a Recalc action
RecordChangeCodesActionThis class records undo/redo information for the Perspective shape object
RecordEnvelopeActionThis class records undo/redo information for the Envelope shape object
RecordGeometryActionThis action records the current mould geometry being used by a particular mould node. Once recorded this allows the geometry to be changed. During undo the old geometry will be replaced but not initialised
RecordPerspectiveActionThis class records undo/redo information for the Perspective shape object
RecordReferenceItemWhen importing & exporting we want to hang on to references of the records we've written or read and the objects they represent, so that referencing records can pick up the associated item. This abstract class provides just the record reference (XFileRef). Derived classes should provide the object
RecordReferencingExporter
RECT
RectThis class is used to represent a rectangular region. It uses a union to enable the client to access the rectangle as two Coords (lo and hi) or as four INT32s (lox, loy, hix, hiy). An anonymous union is used, which is a defined C++ feature and so portable
RectangleRecordHandlerHandles rectangle type records from the new file format Record handler for rectangles, used when importing rectangles from the new file format. Derived from the regular shape record handler, so we use all the functions in that class to complete the regular shape
RectangleToolThe QuickShape Rectangle tool
RectListItem
RedoAction2Dummy BlobbyOp REDO action. Does nothing when it executes
RedoAction3Dummy BlobbyOp REDO action. Does nothing when it executes
RedoColActionSimple BlobbyOp action which restores the colour of a documents page to the colour it was prior to the operation being undone
RedrawBoundsActionAn action to record the bounds of the mould. This op differs from RecordBoundsAction in that it does not use GetUnionBlobBounds() which is really bad for perspectives as this includes the vanishing points which results in a vast area of the document being redrawn. So we have to do everything separately
ReDrawInfoType
RefItemItem class for the Reference sorting system
RegenerateContourActionForces a regeneration of the bevel in all nodes in the list Used by NodeBevelcontroller::OnChildChange to force redraws in undos/redos
RegenerateFeatherContourAction
REGION
RegionThe class defines an area of the screen. At the moment it is a DocRect, but eventually it will be decribed by a path or something
Registry
RegistryEntryRepresents an entry in the registry consisting of a key, subkeys, and some values
RegularShapeRecordHandlerBase class record handler for regular shapesBase record handler for regular shapes, used when importing regular shapes from the new file format
ReleaseInfo
RemapBlendActionAn action which undoes the remapping of a blend
RemoveAttributeParamParameter for OpRemoveAttributeFromSelection, giving the ClassID of the attributes to remove from the selection
RemoveFloaterActionAn action to provide the Line tool with an undoable way of removing the floating endpoint. This isn't stored in the document, which makes life tricky
RemovePathElementActionAn action which undoes the insertion of an element into path data (hence removing that element from the path)
RemovePressurePointsActionAn action which removes points from the pressure data list of a BrushAttValue
RemoveTimeStampPointsActionAn action which removes points from the timestamping list of a BrushAttValue
RenameObjectsDlg
RenderableNodeEnumeratorIterates through a series of NodeRenderable nodes
RenderCallbackProvide a base class for handling callbacks from RenderTree Notes: RenderTree function calls the BeforeNode function in this class when it's about to render any Node. Derive from this class and implement Callback to provide specialised processing of nodes during rendering Derived versions of Callback can: Prevent the node being rendered Set attributes Set subrender contexts Accumulate their own info about the render sequence
RenderControlA RenderControl object is created to control the interruption of rendering. It provides a Stop function which can be called by a rendering routine to determine whether or not it should stop
RenderDemoDlgA Sample dialog that renders stuff into itself using render regions
RenderDialogOpActs as a base class for all Dialogs that want to render using render regions in them
RenderRegionTHIS IS AN ABSTRACT CLASS. Don't try to create a RenderRegion itself, but rather create one of it's derived classes. A RenderRegion object is created when an area of the screen/printer (or any destination) has become invalid and needs to be redrawn. It 'lives' for as long as that region is still invalid. It is also used for e.g. exporting files or in smart click detection. Background rendering and region merging is achieved by using a List of Render Region objects. When a new region becomes invalid, a RenderRegion is created and added to that list. If the rendering is interrupted before it is complete, then it will continue again when the OnIdle routine scans through the list of RenderRegions. RenderRegions can also be created at other times for Immediate rendering. To use a RenderRegion, create an OSRenderRegion or a GRenderRegion depending on the method of rendering required, then Attach a DC and CWnd to the region to specify the Render destination. Next call InitRender which will return the RenderRegions previous render state if it had been interrupted or Null if it has just been created. You can then set attributes, Save/Restore them, and Render objects. When rendering is complete, call ExitRender passing the current render state
RenderRegion::_FillFlags
RenderRegion::_StrokeFlags
RenderRegion::_TextFlags
RenderRegion::FlagBlock
RenderRegionListHolds a list of RenderRegion objects for the application to process. It should be used to add or remove render regions, or to initiate background rendering on idle events
RenderStackTo provide a stack on which to save attribute values while rendering the Camelot tree. The stack is optimised to minimise the amount of pushing and popping actually done
ReplaceAttributesParamThe parameter for the OpReplaceAttributes operation
RequiredAttributeItemThis ListItem holds an attribute's runtime class, plus a flag indicating if we have found the attribute. It is used by NodeRenderable::MakeAttributeComplete
ResourceIDWithFlagsEqual
ResourceIDWithFlagsHash
RestoreFillRampActionAn action which undoes the modification of Grad Fill data. This action can be used for undoing changing control points. This operation Changes the Colour of a Fill already in the tree. This operation Changes the Colour of a Fill already in the tree. An action which undoes the modification of Grad Fill data. This action can be used for undoing changing colours. Action for restoring fill ramps after changes have been made
RestoreSelectionsActionWhen executed this action will restore the selection state of the document. It will also spawn another identical RestoreSelectionsAction adding and add it to the opposite action list
RetroSmoothA new class to control retro smoothing of path regions
ReversePathActionThis action is used to reverse (change direction of) the path inside a TextStory
RGBQUAD
RGBT
RGBTRIPLE
RGNDATA
RIFFck
RIFFFileNice class for reading RIFF files, takes a CCFile in the Init() routine to get it's data from. This doesn't view a RIFF file quite how they're actually stored on the disc. It's viewed as a series of Objects. These objects can be Chunks Start of lists End of lists End of file An object inside a list has a higher level than the list and chunks just before the list. You ask for the next object with NextObject(). This reads in the details about the next object in the file, which you can then read with the Get functions. You can get at the data with GetChunkData - this will error if the last object is not a chunk. This function reads the data into a block you give it. Alternatively, use AquireChunkData which will read it into a block maintained by this class. Data is not read unless it has to be. RepeatCurrent() will repeat the current object, giving one level of rewind. Useful for reading files with naff structures. SkipToListEnd() will skip to the end of the list of the level given
RIFFFile_Header
RIFFFile_List
RIFFFileLevel
RolloverState
RotateToolImplementation of the Rotate Tool
RRCapsThis class has been designed to hold all the different things that a render region may or may not be able to render. eg. Some render regions can render transparency, while others can not. This class is used to record what your render region can do. It does this by having a flag for all the area of rendering that some regions can do and other can not. By default this class assumes that you can do nothing, so it is up to you to set the flags for the things you can do to TRUE. TRUE means you can render that type of thing, FALSE means that you can not. The flags to date are :-
RulerBaseCommon base class for a ruler (X and Y derived)
RulerContextMenuImplements the Ruler context sensitive menu
RulerPairEncapsulates a horizontal and vertical ruler pair
RulerRedrawDataStructure containing semi-permenent redraw data
SafeRenderPointerA object to handle the current 'safe' rendering pointer within the document. This is used for 'Progressive Rendering' (see kernel.h/cpp), during the loading of a document
SaveDetachActionThis action saves and restores the detach flags inside a mould object
SaveFileDialogThis is the Save Dialog that is brought up in responce to the saveas option. It will select the last used directory etc and is generally very fabby
SavePathArraysActionGiven a path, save the paths array data, ie all its verbs, coords and flags on the undo. Use DoRecord(Operation*, ActionList*,Path*) to save the path
SaveRegistryEntriesThis class can be used for saving a list of items into the registry
SaveTemplateDialogThe Save Template dialog. It saves templates, basically
ScaleTabAllows the user to set any options which are normally associated with a documents scaling
ScaleTabAppPrefsDlgTo open up the application preference's dialog box with the scale tab selected. This is used by the scale button on the tool bars
ScaleUnitA ScaleUnit is defined by: A range for which the scaled value is between 0 & 1 A scaler which converts any value in its range to between 0 & 1 A qualifier which may be prefixed or suffixed onto the value NB: There are no base units as such
ScaleUnitReference
ScannerRenderCallbackHandling callbacks from RenderTree Notes: RenderTree function calls the main function in this class when it's about to render any Node
ScanningRenderRegionThe Scanning Render Region is a special sort of render region that simply scans the document and works out where abouts there are complex shapes that can not be rendered by a normal OSRenderRegion. Complex shapes are shapes that are transparant or any other attribute that we are unable to render to normally. The Scanning Render Region is used to help with things like printing, Renderable EPS export etc where transparancy is not available
ScopedFlagSetterFor counting "rendered" objects without actually rendering them
ScreenCamViewA subclass of CCamView which is the class actually used for screen display
ScreenCamView::ScreenCamCanvas
ScreenChangeMsgA message to be broadcast whenever what is on the screen changes. This can be a dialog closing, or scrollbar moving or object being moved. It is vital to the brush that it be informed whenever something like this happens
ScreenViewA subclass of CCamView which is the class actually used for screen display
ScreenView::ScreenCanvas
ScrollPageIncScrollPageInc records the number of units a scroll bars thumb should move for a page up or down scrollbar action. A ScrollPageInc is created and added to the DialogManager's ScrollPageIncList whenever the DialogManager::SetGadgetRange is called for a scrollbar or trackbar control
SelChangingMsgThis message is sent at the end of all operations which have changed the selection
SelectAllOpThe Select All operation
SelectDeselectActionWhen executed this action will render node's selection blobs (which could remove them) and set it's selection state. If the node is currently selected then the node is deselected. If the node is currently deselected it is selected. It creates a second SelectDeselectAction for the node and adds it to the opposite action list
SelectDocSource
SelectedAttrs
SelectIntersectScanSelects objects which are in all of the highlighted set items
SelectionStateUsed to record and restore all selections in the Camelot tree
SelectNoneOpThe Clear Selection operation
SelectObjSource
SelectorInfoBarOpClass for handling the Selector tool's information bar
SelectorInfoBarOpCreateClass for creating SelectorInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
SelectorToolThe Selector tool is used to change the selection, edit objects and transform them. The Selector tool now derives from the DragTool, so that TransOperation may refer to a general DragTool when an object drag is in progress. At a later date, drag functionality may be pulled up into DragTool, to allow future tools to implement dragging of objects more easily
SelectorTool::IterateFlags
SelectScanSelects objects which are in the set item whose selection toggle has been clicked
SelectUnionScanSelects objects which are in any of the highlighted set items
SelectUnionScan::Test
SelEditRecord
SelMediaDlg
SelMediaDlgParam
SelNdRngSelNdRng objects are stored in an array within SelectionState objects, they record a range of upto 255 contiguous nodes as being selected
SelObjPathListThis class encapsulates all the data needed for each selected object
SelObjPathListItemThis class encapsulates all the data needed for each path generated by the objects that are being combined. A list of all the paths that each of the selected object generates is made, and each path generated creates an instance of this class
SelOperationA SelOperation
SelRangeThis class represents a range of selected nodes directly under the Selection Surface. The Selection Surface is the highest surface in the tree at which the user can select nodes. It is usually the child list of Layers but the user can push the Selection Surface lower, into groups, using Select Inside
SelRangeMessageHandlerIntercepts messages for the SelRange. (Basically sits there and flushes the Selection's information cache whenever it thinks the selection cache has become invalid)
SentryOperationA SentryOperation is a non-undoable operation which hangs around on the live operations list (receiving message broadcasts) for the lifetime of the system
SepsDlg
SepsDlgParam
Set
SetSentinelSource
SetTimeStampUpdateTypeActionThe purpose of this action is to set a flag that determines what happens when the brushed nodepath calls its timestamping brush attribute to update itself. Setting this flag to TRUE indicates that our path has changed so that our timestamping list coordinates are no longer on the line. Therefore we will reposition these points on the new line. Setting it to FALSE indicates that we have added or removed points from the timestamping list and should sort and reorder it to make sure it is ok
SGalleryLinePropertiesDlg
SGalleryOptionsDlg
SGallerySearchDlg
SGallerySortDlg
SGATMItemA DisplayTree node for ATM fonts in the Fonts SuperGallery
SGBitmapDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGClaimPointInfo
SGClipartDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGClipartItemA clipart gallery item
SGColourDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGDisplayColourThis DisplayTree node is used by the Colour SuperGallery It is responsible for providing the ability to handle/redraw one IndexedColour displayed in said gallery
SGDisplayColourGroupA derived SGDisplayColourGroup class for the Colour gallery groups
SGDisplayDATATYPEThis DisplayTree node is used by the TEMPLATE SuperGallery It is responsible for providing the ability to handle/redraw one DATATYPE displayed in said gallery
SGDisplayFlags
SGDisplayFrameThis DisplayTree node is used by the Layer SuperGallery It is responsible for providing the ability to handle/redraw one Layer displayed in said gallery
SGDisplayGroupThis DisplayTree node type is used by the SuperGallery The top level(s) of the DisplayTree are made up of a number of SGDisplayGroup nodes, which divide the tree up into categories (and, potentially hierarchical groups within categories)
SGDisplayItemThis DisplayTree node is used by the SuperGallery It is responsible for providing the ability to redraw one item displayed in the gallery, and remembering information on that item (such as its selection state, etc)
SGDisplayKernelBitmapThis DisplayTree node is used by the Bitmap SuperGallery It is responsible for providing the ability to handle/redraw one KernelBitmap displayed in said gallery
SGDisplayLayerThis DisplayTree node is used by the Layer SuperGallery It is responsible for providing the ability to handle/redraw one Layer displayed in said gallery
SGDisplayLibColGroupA derived SGDisplayLibColGroup class for Colour gallery libraries
SGDisplayLibColour
SGDisplayNodeThis DisplayTree node type is used by the SuperGallery This is a virtual class from which all nodes in the DisplayTree are derived
SGDisplayPreviewFontsThis is the base-class for the installed font items in the fonts gallery. An instance of this class should never be created, instead SGTTFItem and SGATMItem's should be used
SGDisplayRootThis DisplayTree node type is used by the SuperGallery The top (root) level of the DisplayTree is made up of a single SGDisplayRoot node. This node is used as a single entry-point for all tree-wide actions which the SuperGallery applies to it (redraw, reformatting, etc)
SGDisplayRootScrollThis DisplayTree node type is used by the SuperGallery
SGFieldCache
SGFillsDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGFillsItemA fills gallery item
SGFontsDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGFontsGroupThis is a display tree group specifically for the fonts gallery - it disables various documenty things, and provides overrides for the group text
SGFormatInfo
SGFrameGroupThis is a display tree group specifically for the layer gallery - it disables group things like folding, and provides column headings for the layers display
SGInitProvides static functions for initialisation/deinitialisation of the SuperGallery system, plus useful internal SuperGallery work functions
SGLayerGroupThis is a display tree group specifically for the layer gallery - it disables group things like folding, and provides column headings for the layers display
SGLibDisplayItem
SGLibFontItemA library font gallery item
SGLibGroupThis is a display tree group specifically for library galleries The main reason for implementing it was to receive library group messages
SGLibOilInitially, general OILy utilities for the library, but then the Add Library dialog code was added in..
SGLineDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGListDragInfoDescribes a generic supergallery item drag
SGListDragTarget
SGMiscInfo
SGMouseInfo
SGNameDragA Wix ObjectName attribute drag, which was started from the Name gallery
SGNameDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. This particular target is used for handling drags of NameGalllery items within their displayed list. It automatically handles drags with draginfo derived from BitmapDragInformation. Notes: Drag targets are destroyed automatically when a drag finishes by the drag manager with which they were registered. To remove a drag target at any time, destroy it - it automatically deregisters and cleans up
SGNameGroupA SuperGallery group of SGNameItems. Records whether this group's display needs to be updated on the next idle event because of a change to its Document's named objects
SGNameItemRepresents an item in the Name gallery's display
SGNamePropAbstract base class for the various kinds of properties associated with SGNameItems
SGOilClipartDragTargetDrag Target for the mainframe, so dragging clipart into a null document situation (behind all the docs) will load a new document
SGOptsSortInfo
SGRedrawInfo
SGScrollDragInfoDescribes a supergallery scroll drag
SGScrollDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag
SGSortKey
SGTTFItemA DisplayTree node for TrueType fonts in the Fonts SuperGallery
SGUsedBitmaps
SGUsedColourItem
SGUsedColours
SGUsedFonts
SGUsedNamesNameGallery groups and items to manage the various types of attribute sets
ShadowRecordHandlerHandles the reading of all shadow records in the v2 file format
ShapeEditedMsgThis message is sent whenever a shape is edited
ShowNodeActionWhen executed this action will show a node. It will also generate a HideNodeAction action adding it to the opposite Action list
SimpleBarControlContains all info about the control, plus a ptr to a message handler to pump all the messages to
SimpleBecomeAA simple becomeA object that retrieves paths from nodes and makes them available to you, the user without messing around with MakeNodePathFromAttributes or any of that rubbish
SimpleBitmapRenderCallback
SimpleCCObjectOverride new and delete, so that new returns NULL when no more memory is available, rather than throwing an exception
SimplePrintRenderCallback
SingleBitmapSelection
SingleNodeSourceConcretisation of NodeScan::Source for a "scan" over a single node (generally), and over the 'selected' document's NodeSetSentinel sentinel (specifically)
SingletonAppliedAttributeRepresents an applied attribute of which there is only one for the objects given by the iterator
SliceHelper
SliceInfoBarOp
SliceInfoBarOpCreateClass for creating SliceInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
SliceSaveFileDlg
SliceToolSliceTool is actually a misnomer. This tool is used for creating rollover buttons and bars for web pages
SnapShotItemDefines what is saved during a current attribute snap shot
SnapShotListDefines what is saved during a current attribute snap shot
SpanListItem
SpecialEntry
Spread
SpreadMsgThis is sent when a spread event is happening that may be of interest to all you message handlers out there
SpreadRedrawsEncapsulates a set of regions on a spread, which must be accumulated in order for them to be redrawn at some point, possibly all in one go. This class chooses the most efficient invalidation method, according to the number and nature of regions added
SpreadSelection
SpriteOILFilterProvide the OIL parts of the Acorn Sprite filter which loads in the file as a BMP
SquareFillAttributeSpecifies a Square graduated fill for an object, including the start and end points
SquareTranspFillAttributeSpecifies a Square graduated fill for an object, including the start and end points
StackA general purpose stack for storing ListItems
StackT< Object >Generic StackT
StandardBarA class implementing "fixed content" bars Notes: In the OIL See Also:
StandardBarMsgA tiny message local to the standard bar class
StandardDefaultRecordHandler
StandardUnitA class utility defining standard units for use as you please, although corrupting them may cause some annoyance. Notes: Contains only static members. See Also: class UnitGroup, class ScaleUnit
StartArrowAttributeAttribute for start arrow type of paths
StartCapAttributeAttribute for start cap style of paths
StartDocument
StartRebuildMouldActionWhen executed this action will get the mould to rebuild itself
static_tree_desc_s
StaticTextControlRepresents a Static Text Control (Label) in a DialogOp
STATISTICS
StatusBarPaneData
StatusLineEncapsulate the status line
StatusLine::StatusTimer
StoreCharCodeActionThis action is used to restore a character's UniCode value on undo. Using this an op can chage the character code of a TextChar without having to hide the old char and create a new one
StoreKernCodeActionThis action is used to restore a kern value on undo. Using this an op can change the kern value without having to hide the old KernCode and create a new one
StorePathIndentActionThis action is used to store a text stories path indent value
String_128Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
String_16Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
String_256Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
String_32Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
String_64Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
String_8Extends its String base class to become fixed-length and atomically allocatable, ie. a failed constructor call for this class will never leave the object in an illegal state
StringBase
StringListItemA String_256 in a list item
StringToBitmapGeneration of anti-aliased font-string bitmaps for the font installer / de-installer
StringVarExtends its String base class to become self-sizing. This means that we need to override only functions in StringBase that try to create or extend the text allocation
Strip
StripSubTreeRecordHandlerThis is the class is used to strip a subtree of records from the file
StrokeAttrRecordHandler
StrokeColourAttributeRepresent a colour for a stroke, as opposed to a fill. Implementation is very similar (identical!) to the FillColourAttribute class
StrokeComponentA document component for handling Stroke definitions
StrokeComponentClassThe class that gets a Stroke doc component going on start up We need to register our class as a document component and this is where we do it all
StrokeDefinitionStores a vector stroke definition A static list of these items is held in the StrokeComponent
StrokeMsgA message broadcast by a Stroke when it becomes selected as the default Stroke
StrokeTranspAttributeRepresent the transparency of a stroke, as opposed to a fill. Implementation is very similar (identical!) to the FillTranspAttribute class
StrokeTypeAttrValueStrokeType attribute value StrokeType attributes describe the stroking characteristics for a path
StrokeTypeItemRepresents a stroke type user-interface item within the line gallery
Style
StyleContainerProvides a container for a load of Style's
StyleContainerItemProvides an item for the container of a load of Style's
StyleIteratorReturns entries in a visible list
StyleRecordReferenceRepresents an association twixt Style and Record reference
StyleReferenceAttributeThis represents a TemplateOp/Argument/user-changable from the template file attribute. It will probably be superceded, but for now it's derived from AttrUser with a value of the form <InternalName>[/][;<Question>] Bring on the plug-in attributes I say
StylesThis DocComponent is an abstract class for styles. I put it in 'cos someone's bound to come along and want the functionality of the derived class WizOpStyleComponent
StylesExporter
StylesMessageInforms us that a Styles component has changed
SubRenderContextProvide a base class for pointing to when storing sub-rendering contexts. These are needed when a node takes a long time to render, such as a NodeBlender object which interrupts itself before all the blended objects have finished rendering. This class is essentially empty - derive your own specific context class from it
SubTreeRenderContextRepresents the rendering state where tree rendering has been suspended but the current node is the root of a subtree that has ALREADY BEEN RENDERED
SuffixQualifierA suffix qualifier is one of the form <...><QualifierToken>, e.g. 5.00%
SumAllPathsElemElement for the list in SumAllPathsPathProcessor
SumAllPathsPathProcessorAll paths are placed in the linked list, with their associated attribute maps
SUNOILFilterProvide the OIL parts of the SUN filter which loads in the file as a BMP
SuperGallery
SystemBarOp
TabStopDragOpOperation to handle tab stop dragging
TabStopDragOpParamParameters for TabStopDragOp operation class
tagAssociationsA structure for use by the RadioGroup class Scope: public
tagCaptureFlags
tagCaptureInfo
TagDescriptionListKeeps a list of all the tag descriptions present in the imported file
TagDescriptionListItemAn item that appears in the TagDescriptionList
tagDOWNLOADINFO
tagGIFAPPLICATIONBLOCK
tagGIFCOMMENTBLOCK
tagGIFIMAGEBLOCK
tagGIFINFOHEADER
tagGIFRGBTRIPLE
tagGIFTRANSBLOCK
TARGAOILFilterProvide the OIL parts of the TARGA filter which loads in the file as a BMP
TemplateAttributeThis represents a TemplateOp/Argument/user-changable from the template file attribute. It will probably be superceded, but for now it's derived from AttrUser with a value of the form <InternalName>[/][;<Question>] Bring on the plug-in attributes I say
TemplateAttrRecordHandlerHandles the reading of WizOp records in the v2 file format
TemplateDialogAllows intelligent users to make attributes changeable via templates
TEMPLATESGalleryThe TEMPLATE SuperGallery class
TempToolItemItem that represent a temp tool selection
TestBitmapEffectTest class
TextAttrRecordHandlerRecord handler for text attribute records
TextCharSimplest type of TextStory character. The only data stored is a Unicode value
TextControlRepresents an Edit Box in a DialogOp
TextInfoBarDataTo encapsulate all the data required to interface with the text infobar
TextInfoBarEnumFontClass for creating TextInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
TextInfoBarOpA class used for caching Font data.Class for handling the tool's information bar
TextInfoBarOpCreateClass for creating TextInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
TextLineA TextLine gathers together all characters on a single line in a text story. The TextLine object is responsible for rendering all its character node children. It needs to do this because TextChars have no associated bounds and so they can only render themselves relative to other chars
TextLineInfoPassing line level info to/from functions
TextManagerYou name it and its assocaited with text then this probably isn't it
TextObjRecordHandlerRecord handler for text objects See also: class TextAttrRecordHandler
TextRulerBarDataKeep the current ruler bar display state
TextStoryThe root of the TextObject hierarchy
TextStoryInfoHold story level information
TextToolA template tool class
TextToolBlobPosItemThe class of objects stored in the TextToolBlobPosList. These items store the blobs position and associated story
TextToolBlobPosListA list the positions of blobs that the text tool is rendering as tool blobs. This class is just a wrapper arouind the list class, providing common handling functions
TGMItemAssociate the TransparencyGeometry enum with the resource id of the text that gets displayed on the menu
ThreeColFillAttributeSpecifies a Square graduated fill for an object, including the start and end points
ThreeColTranspFillAttributeSpecifies a Three colour graduated transparency for an object including the start and end points
ThumbDownloadParam
ThumbMessageThis message is sent to inform the system of important global thumbnail events. Currently the only such event is CACHESIZECHANGED, sent whenever the thumbnail cache wants its size changing
ThumbnailFilterPNGThe filter will save out the PNG Thumbnail Bitmap. Overrides DoExport so dialogs are not put up but returns preview export options
TI_GIFFilterEncapsulates a Windows GIF export and import filter. Derives off the masked filter which provides funcitonality for doing masked bitmap export and import
TIFFOILFilterProvide the OIL parts of the TIFF filter which loads in the file as a BMP
TimerMsgThis message is sent whenever something happens with a timer
TimeSpan
TimeStampBrushPointTo store information about brush objects generated by the timestamping method
TipsDlgProvides a Tip of the Day dialog showing useful and inspirational tips for users young and old
ToggleAutoKerningActionToggle a story's auto kerning value
ToggleInsetPathActionToggles the inset path flag on the given node
ToolThe 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
Tool_v1Specifies the interface between tools and the Kernel/OIL
ToolbarDlg
ToolInfoProvide 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
ToolInfo_v1Provide information on a tool
ToolListUsed by the kernel to hold information on all the tools it currently knows about. It has an overloaded Add function which will only add tools if their ID has not already been used by another tool
ToolListItemUsed by the kernel to hold information on a particular tool. Contains a link to the OilTool object associated with the Tool
ToolnameDlg
ToolOpDescriptorDescribes a Tool Selection operation. It contains pointers to the literal token describing the operation (used by the macro language, among other things) and pointers to some static member functions of the operation which allow dynamic creation of the operation
ToolsCurrentAttrGroupChangedMsgThis message is broadcast by the Tools whenever the Current Attribute Group associated with a tool changes. This presently means that we have switched to or from the Text Tool
ToolSwitchHolds a key press that will temporarily switch to another tool
TraceBoundaryPointImplements the TraceRegion class
TraceControlDialog for tracer
TraceDlgDialog for tracer
TraceMsgThis is a foolish message to bring up a tracer dialog
TraceOpHandles insertion of bitmap effect nodes into the tree
TraceOpParam
TraceRegion
Trans2DMatrixThis transformation will perform any 2D matrix transformations such as :- Translate, Rotate, Scale and Shear
TransformBaseThe Transformation Base Class. This is an abstract class - you can only create instances of its derived classes. The Transformation classes are used to give a transparent interface to arbitary transformations on objects. Nodes do not need to be aware of what type of transformation is being applied or how is should be undone. This class contains two virtual function :- MonoOn virtual void Transform(DocCoord* Coords, INT32 NumCoords) MonoOff MonoOn virtual BOOL IsInvertable() MonoOff It also contains the following public member vars MonoOn BOOL TransLines; // TRUE if Line Widths are to be transformed MonoOff MonoOn BOOL TransFills; // TRUE if Fills are to be transformed MonoOff
TransformBoundingDataThis structure holds information about the position of the selection as well as the current scale and angles MonoOn Position and size INT32 x; INT32 y; INT32 Width; INT32 Height;
TransformDataHolds the flags and additional data for the transform operations that are started by the Selector Tool. MonoOn DocCoord CentreOfTrans; // The centre of the transform INT32 StartBlob; // The blob that the transform was started from BOOL LockAspect; // Should the aspect ratio be locked BOOL LeaveCopy; // Should we leave a copy of the selection BOOL ScaleLines; // Should line widths be scaled as well BOOL TransFills; // Should fills be transformed as well Range* pRange; // range to transform; if NULL, use the selection MonoOff
TransformNodeActionWhen executed this action will transform a range of NodeRenderableInk nodes. It also creates another TransformNodeAction to 'undo' the transformation just performed. It adds this action to the opposite action list
TransInvertableOne of the transformation base classes. All Transformations derived from this class can be inverted directly. ie Transforms that make use of a matrix can be inverted by inverting the matrix. This class adds the following virtual functions :- MonoOn virtual void Invert() MonoOff
TransNonInvertableOne of the Transformation base classes. All the transformations derived from this class can not be inverted. Transforms of this kind are considered to be one way mappings from the original coords. There is no way of getting the original coords back after they have been transformed by a class derived from this one. Examples include the Envelope transformation
TransOperationThe base class for all the Transform Operations. This class should provide most of the functionality for all the transform operations such as handling the eored drag events etc. At the end of the day it will transform the selection is some way (depending on the derived class)
TransparencyRampThis class holds a list of transparency records, each of which describe a specific entry in the transparency ramp
TransparentGradTable
TranspFillAttributeThe base class for a fill geometry attribute, such as flat, linear, radial, conical, etc. This provides the basic interface for fill rendering
TranspFillMappingAttributeSpecifies how a fill graduation behaves, e.g. linear, sinusoidal and so on
TranspFillMappingLinearAttributeSpecifies a linear fill mapping for a filled object. This is used for normal graduated fills
TranspFillMappingSinAttributeSpecifies a sinusoidal fill mapping for a filled object. i.e. the graduation sort of wibbles from one colour to another in a sort of whirly sinusoidal fashion
TranspFillProfileOpParamServes as our param passing stuff for undo/redo of transp fill profile changing
TranspGradTableA kernel representation of a transparent graduation table
TranspInfoBarOpClass for handling the gradfill tool's information bar
TranspInfoBarOpCreateClass for creating TranspInfoBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
TranspModeMsgA "transparency mode-change" message class
TranspRampItemDefines a single entry in a transparency ramp. An entry is simply made up of a single long definition
TranspToolThe transparency tool
TrapEdgeStructure defining a trapezoid edge definition. A TrapEdge records the following information:
TrapEdgeListSimple class to store a list of trapezoid edges (TrapEdge structures) Each source sub-path will be converted to a separate TrapEdgeList
TrapsListSimple class containing a list of TrapEdgeLists representing a complex path Each TrapEdgeList represents a sub-path of the overall source path
tree_desc_s
TriggerSetClass to manage the UI and execution of stretch/extend properties
TTFontA class description of a true type font
TTFontManA static class to allow acces to TrueType fonts
TunedMemoryThis is a shell around the CCMalloc and CCFree memory allocator. If you use this class to get the memory, the total alloc'ed memory will not exceed the amount set in this class. This is used to allow the user to say how much memory they are prepared to commit to the off-screen bitmap used in rendering. If there is not enough, GRenderRegions will band thier output to use up less ram
TuneTabAllows the user to set various tuning parameters, such as:-
  • Gdraw memory for rendering
  • Undo buffer size for the current document
TxtAspectRatioAttributeThis text attribute specifies the aspect ratio of characters
TxtBaseClassAttributeThe base class from which all text attributes are derived
TxtBaseLineAttributeThis text attribute specifies the aspect ratio of characters
TxtBoldAttributeThis text attribute specifies the BOLD state (on/off)
TxtFirstIndentAttributeThis text attribute specifies the first line indent
TxtFontSizeAttributeSpecifies the size of a font
TxtFontTypefaceAttributeSpecifies a FontTypeface. Note that only a handle to the Typeface is stored in the attribute, not the full string description
TxtItalicAttributeThis text attribute specifies the ITALIC state (on/off)
TxtJustificationAttributeThis text attribute specifies the current text justification
TxtLeftMarginAttributeThis text attribute specifies the left margin
TxtLineSpaceAttributeThis text attribute specifies the aspect ratio of characters
TxtRightMarginAttributeThis text attribute specifies the right margin
TxtRulerAttributeThis text attribute specifies the ruler (i.e., tab stops) Conceptually, a ruler is just a pointer to a sorted list of tab stops
TxtScriptAttributeThis text attribute specifies the superscript/subscript value of a char
TxtTabStopThis type represents a tab stop (part of a ruler attribute)
TxtTrackingAttributeThis text attribute specifies a spacing between characters, it can be positive or negative
TxtUnderlineAttributeThis text attribute specifies if text is underlined or not
TypesetInfoA class to encapsulate all the bits of typesetting we provide. The main entry in the class is a list of colour plate objects. When printing separations, the list is used to (a) determin which separations require printing and (b) to set each printable colour plate in the active print view. The main print loop will use the access functions in this class to cycle through each printable plate. This will result in a set of separated representations of a page being produced. Other information held in this class pertain to Postscript functionality. The class contains the prefered screening values for the entire document
UnApplyActionWhen executed this action will hide a node. It will also generate a ShowNodeAction action adding it to the opposite Action list
UndoableNodeScanBase class for NodeScans which are used by UndoableOperations
UndoableOpDescriptorAll undoable operations should be registered using an UndoableOpDescriptor. The only difference between an UndoableOpDescriptor and an OpDescriptor is that the Operation Flags are set to different default values
UndoableOperationAll Undoable operations should be derived from this class
UndoAction2Dummy BlobbyOp UNDO action. Does nothing when it executes
UndoAction3Dummy BlobbyOp UNDO action. Does nothing when it executes
UndoColActionSimple BlobbyOp action which restores the colour of a documents page to the colour it was prior to the operation being performed
UndoTabAllows the user to set any options which are normally associated with a documents undo. This includes such things as:- Unlimited undo setting OR maximum memory to be allocated to the undo system
UnicodeManagerClass for containing all Unicode related methods
UnitEncapsulates units within Camelot. All units (i.e. default and user-defined ones) are an instance of this class. Each document has its own list of units controlled by an instance of DocUnitList within the Document class. Therefore you should get hold of the DocUnitList within the current doc when you want to add/delete/edit/find a unit
UnitFlagsType
UnitGroupA UnitGroup is a set of ScaleUnits that are interconvertible Notes: It is possible to violate the integrity of the UnitGroup by changing ScaleUnits included in the group. Kindly use the UpdateUnit method provided
UnitListComponentProvide a component that allows us to save out the units for this document using the serialisation facilities of the DocComponent base class
UnitListComponentClassProvide a class that will add Unit List components to new documents
UnitMsgThis message is sent whenever something happens to a unit
UnitPropertiesDlg
UnitsRecordHandlerProvide a units record handler for the new native and web file formats. This asks the units document component to import the unit definitions for us
UnitsTabAllows the user to define the default units that are used for displaying size information, font size information and general display information. Also, alllows them to define their own units and edit the scaling factor applied to the spread, layer, or whatever. Based on the old UnitsDlg code
UnitsTabAppPrefsDlgTo open up the document preference's dialog box with the units tab selected. This is used by the units button on the tool bars
UpdateBrushActionAn action which signals to a brush attribute that its ink node hsa changed. It is appropriate to call this action when serious adjustments have been made to the timestamping points list of the attrbrushtype, for instance adding or removing subsets of the list. It is not appropriate to call it when the coordinates of the path have changed but you do not wish to add or remove any points from the list
UpdateCachedKeyholePathActionCause a NodeClipViewController node to update it cached keyhole path when an operation is undone or redone. Notes: Invoking this action via its Init() method has no _direct_ effect, save to set the action to trigger on undo/redo
URLImportDlg
UsedPropertiesListProvides a visible list of user attributes
UserAttributeRepresent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator. (I'd say it stores a "key" string and an associated "value" string for implementation of URLs and other such stuff, but if you say it stores a line width, who am I to argue? ;-)
UserAttributeAgglomeratorAn AttributeAgglomerator finds the Common Attributes among the nodes provided by an RenderableNodeEnumerator. This allows us to derive classes to retrieve more specialized attributes, namely AttrUser's
UserCoordEncapsulate coord system relative to a user specified origin on a spread by spread basis
UserInterfaceAllows a user to edit a list of items
UserRectThis class is used to represent a rectangular region. It uses a union to enable the client to access the rectangle as two UserCoords (lo and hi) or as four INT32s (lox, loy, hix, hiy). An anonymous union is used, which is a defined C++ feature and so portable
ValueFunctionAbstract Base class Provides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionBevelEnds
ValueFunctionBlipProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionConstantProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionDecay
ValueFunctionDoubleRampS
ValueFunctionEllipseProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionIntestine
ValueFunctionPressure
ValueFunctionPressureS
ValueFunctionPropeller
ValueFunctionRampProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionRampL
ValueFunctionRampL2
ValueFunctionRampLinear
ValueFunctionRampS
ValueFunctionRampS2
ValueFunctionRandom
ValueFunctionSawTooth
ValueFunctionSmoothStrokeProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionSS_Barb
ValueFunctionSS_Cigar
ValueFunctionSS_Cigar2
ValueFunctionSS_Cigar3
ValueFunctionSS_Comet
ValueFunctionSS_Concave
ValueFunctionSS_Convex
ValueFunctionSS_Fallout
ValueFunctionSS_Goldfish
ValueFunctionSS_Iron
ValueFunctionSS_Meteor
ValueFunctionSS_Missile
ValueFunctionSS_OceanLiner
ValueFunctionSS_Petal
ValueFunctionSS_Reed
ValueFunctionSS_SlimBlip
ValueFunctionSS_Torpedo
ValueFunctionSS_Yacht
ValueFunctionTeardropProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionTeardropCurvedEndProvides an interface by which the caller can obtain the value of a given function at a given "position"
ValueFunctionThumbtackProvides an interface by which the caller can obtain the value of a given function at a given "position"
VariableWidthAttrValueVariableWidth attribute value VariableWidth attributes describe the width characteristics for a path
VarWidthItemRepresents a stroke type user-interface item within the line gallery
Vector3< T >Provides a 3D templated vector class Presently used as support for Path::IsIsometric()
stl::Vector3< T >Provides a 3D templated vector class Presently used as support for Path::IsIsometric()
Vector3DDefine all 3 vector operations we need
VectorFileRenderRegionEncapsulates the functions shared by the CMX, EPS, and Flash render regions. This class is never itself instantiated
VectorFilterAllows filter families to contain all vector formats. All filters that load vector-based files (EPS, metafiles, and so on), should be derived from this class. Vector files often contain bitmaps - if in doubt, derive from the VectorFilter
VectorFilterFamilyA filter for all vector file types. e.g. EPS, WMF, Draw, etc
VectorStrokeSubRenderContextUsed during rendering to store the render context of a repeating vector stroke if it has taken too long to render so far
VersionIndependentProgIDRepresents the VersionIndependentProgID key in a registry. Saves us some typing really
VerticalInsetStore
VerticalRulerEncapsulates vertical ruler
VFPressureRecordStores Pressure-sensitive pen values (as used for variable-width strokes) and allows the caller to retrieve values from such recorded information
ViewThe basic kernel view item. This class contains minimal functionality to maintain the 'current' view, and the connection from a kernel view object to an OIL view object. DocView and PrintView are derived from this class
ViewComponentProvide a component that handles the saving of view information to the v2 file format
ViewComponentClassProvide a class that will add view components to new documents
ViewContextMenuImplements the DocView context sensitive menu
ViewDragTargetAn instantiation of this class is created by each entity which wishes to provide a 'destination' to which the mouse can go to complete a drag. WinoilDragTargets are used as a base class from which to derive drag targets for WINOIL entities (an optional HWND)
ViewItemWhen optimising redraw for a particular View, we try to join all the render regions of a View into one if they cover more than 70% of the resulting union. This class is used to remember which DocViews we have already tried to optimise as we step through the render region list
ViewListWhen optimising redraw for a particular View, we try to join all the render regions of a DocView into one if they cover more than 70% of the resulting union. This class is used to remember which Views we have already tried to optimise as we step through the render region list
ViewModule
ViewOpsThis class is used for all the View operations found on the View Menu
ViewRecordHandlerHandles the reading of all view records in the v2 file format
ViewState
ViewTabAllows the user to set any options which are normally associated with the applications View. This includes such things as:- Colour bar display mode Showing percentage hourglasses and/or progress bars
VisibleAttributeProvides a user editable attribute (of sorts)
VisibleLabelAllows a user to edit a list of items
VisibleLabel::Observer
VisibleListAllows a user to edit a list of items
VisibleListItemAllows a user to edit a list of items
VisibleListItemPtrProvides a container element for a visible list
VisibleListIteratorReturns entries in a visible list
VisibleListWithEditableEntriesThis rendition of a VisibleList has VisibleListItems that are editable The functionality should be in the base class but that TemplateDialog parameter ruins things a bit
VisibleStyleReferenceProvides a user editable style reference
VisibleTemplateAttributeProvides a user editable template attribute
VisibleTemplateHandlerProvides the user with something tangible in the way of WizOp's. They can appear in a list control via this class
VisibleTextNodeThe VisibleTextNode is an abstract base class. All visible objects which appear on text lines such as characters, kerns, carets, etc. will be instances of derived classes of VisibleTextNode
VisibleUserAttributeProvides a user editable user attribute
VisibleWizOpStyleProvides the user with a style to play with. They can appear in a list control via this class
WebAddressRepresents a URL
WebAddressAttributeThe new Web Address attribute. It's distinct from the old Web Address attribute, which was a type of UserAttribute
WebAddressDlgThe new Web Address dialog
WebCorrectFlagsA set of flags that define how a URL should be corrected
WebFontInstallParam
WebOILFilterThe Web File format Oil Filter (Extension etc)
WebPrefsDlg
WebPrefsDlgParamAllows data to be passed into the export web preference dialog box and then returned to the caller
WinCoordStructure holding a 16-bit/32-bit (Win16/Win32) cartesian coordinate. Its main use is to hold the coordinates supplied to and from the operating system. The origin for this coordinate system is the top-left of the screen or window
WindingRuleAttributeAttribute for the winding rule of a path
WindowOpsThis class is used for all the Window operations found on the Window Menu
WinRectA Windows rectangle
WinTabPressurePenOverrides the base pressure-sensitive pen class to provide support for WinTab pressure-sensitive tablet devices. When such a device is unavailable, this class returns control to the base-class to allow joysticks and mice to be used to simulate pens based on speed and/or direction of travel rather than real applied pressure
WizOpThe Camelot Text file format supports templating. Each argument to a template is processed by a WizOp. The WizOp's extracted from the registry, which this class represents, are then Available Properties in the Wizard Properties dialog
WizOpProbeSearches through the (local) registry returning entries in the WizOp category
WizOpRegistryEntryWhen the WizOpProbe returns a ClassRegistryEntry it returns one of these which can then be used to extract WizOp specific bits from the registry
WizOpsThis collection of WizOps is used by the Wizard Properties dialog
WizOpStyleA WizOpStyle is a style solely for the purpose of naming WizOps
WizOpStyleComponentClassProvide a class that will add document information components to new documents
WizOpStyleRecordHandlerAllows WizOpStyleComponent's to be read from the .xar/.web file formats
WizOpStyleRefRecordHandlerHandles the reading of WizOpStyleRef records in the v2 file format
WizOpStylesProvide a component that allows us to save out the information for this document using the serialisation facilities of the DocComponent base class
WobbleFlagsUsed to determin what to wobble when recalculating curve control points during a drag. The flags affect which handles around a curve endpoint are repositioned
WorkCoord
WorkRectThis class is used to represent a rectangular region. It uses a union to enable the client to access the rectangle as two WorkCoords (lo and hi) or as four XLONGs (lox, loy, hix, hiy). An anonymous union is used, which is a defined C++ feature and so portable
WPGOILFilterProvide the OIL parts of the WPG filter which loads in the file as a BMP
wxAdvSplashScreen
wxAdvSplashScreenWindow
wxAuiDefaultDockArt
wxAuiDockArt
wxAuiDockInfo
wxAuiDockUIPart
wxAuiFloatingFrame
wxAuiManager
wxAuiManagerEvent
wxAuiPaneButton
wxAuiPaneInfo
wxCamArtControlA base class for controls using the CamArtProvider to paint themselves Notes: In the OIL See Also:
wxCamArtControlEventA derived event to allow for postprocessing of autorepeat on buttons Notes: In the OIL See Also:
wxCamArtControlXmlHandlerA resource handler to enable wxCamArtControl items to be loaded from XML Notes: In the OIL See Also:
wxCamArtProviderEventA derived event to allow for postprocessing of dialog events Notes: In the OIL See Also:
wxCamBitmapDropdownPopup
wxCamDialogEventA derived event to allow for postprocessing of dialog events Notes: In the OIL See Also:
wxCamDrawControlA base class for controls using the CamDrawProvider to paint themselves Notes: In the OIL See Also:
wxCamDrawControlEventA derived event to allow for postprocessing of autorepeat on buttons Notes: In the OIL See Also:
wxCamDrawControlXmlHandlerA resource handler to enable wxCamDrawControl items to be loaded from XML Notes: In the OIL See Also:
wxCamGridPopup
wxCamMenuBar
wxCamTreeCtrl
wxCamVListBoxComboPopup
wxComboBoxExtraInputHandler
wxComboCtrl
wxComboCtrlBase
wxComboCtrlFeatures
wxComboPopup
wxComboPopupExtraEventHandler
wxComboPopupWindow
wxDynamicPropertySheetDialogThe create method creates a Dialog box and positions it
wxGenericComboControl
wxGridCombo
wxGridComboPopup
wxGridComboXmlHandler
wxKeyMapMaps the string representation of a wx key (i.e. "WXK_F1"), into it's enum value
wxOwnerDrawnComboBox
wxOwnerDrawnComboBoxXmlHandler
wxPlatformDependent
wxPseudoTransparentFrame
wxSliderCombo
wxSliderComboPopup
wxSliderComboXmlHandler
wxTextValidatorFixed
wxTreebook
wxTreebookEvent
wxTreebookXmlHandler
wxVListBoxComboPopup
wxWindowDeletionWatcher
xlong
XMatrix
XOROutlineInfoStrContains information used by the XOR Outline rendering functions in the Range. THis includes a pointer to the "Prime Object" (which is the object that the user clicked on to start their drag), a rectangle which is used when comparing object sizes to determine how significant they are in the current drag (more significant objects are drawn first) and a couple of flags indicating if the significance region is based on the entire screen size or not, and whether the information is currently cached correctly
XPFCapabilityThis is the baseclass for the various nodes in the capability tree
XPFCBevelThis is the class for Bevel capabilities
XPFCBitmapThis is the class for Bitmap capabilities
XPFCBitmapEffectThis is the class for BitmapEffect capabilities
XPFCBlendThis is the class for Blend capabilities
XPFCClipViewThis is the class for ClipView capabilities
XPFCColourThis is the class for Colour capabilities
XPFCComplexClassThis is a general class that just uses the runtime class of the node It can be used directly to handle those complex objects that just support a simple on/off style of conversion or it can be used as the baseclass for more complex classes
XPFCContourThis is the class for Contour capabilities
XPFCEllipseThis is the class for Ellipse capabilities
XPFCFeatherThis is the class for Feather capabilities
XPFCFillThis is the class for Fill capabilities
XPFCFillTransThis is the class for FillTrans capabilities
XPFCLayerThis is the class for layer capabilities
XPFCLineThis is the class for Line capabilities
XPFCLineTransThis is the class for LineTrans capabilities
XPFCMouldThis is the class for Mould capabilities
XPFCPolygonThis is the class for Polygon capabilities
XPFCRectangleThis is the class for Rectangle capabilities
XPFCShadowThis is the class for Shadow capabilities
XPFCTextThis is the class for Text capabilities
XPFRenderCallbackThis is the custom render callback class for the capabilities conversion
XPFRenderRegionThis is the custom render region for the capabilities conversion
XPFSpanRenderCallback
XPFViewSimple view class for use when converting for plugin filters
XSEPSExportOptionsThis gets options relevant to the export of XS EPS
XWindowsOILFilterProvide the OIL parts of the XWindows filter which loads in the file as a BMP
z_streamA file stream compressor and decompressor. Allows the CCDiskFile to offer compression of files. At present just used to compress the native file format
z_stream_s
ZipDeflateThe deflater for the file compressor and decompressor. Allows the CCDiskFile to offer compression of files. At present just used to compress the native file format
ZipInflateThe inflater for the file compressor and decompressor. Allows the CCDiskFile to offer compression of files. At present just used to compress the native file format
ZoomInfoBarOpHandles creation/destruction and message handling for the zoom tool info-bar
ZoomInfoBarOpCreateClass for creating (dummy) InformationBarOps. Derived classes of BarCreate are used by DialogBarOp::ReadBarsFromFile()
ZoomToolThis class is to allow the user to Zoom in and out of the document at will. It provides an interface to the tool system for the zoom mouse-drag Operation

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