SGDisplayLibColour Class Reference

#include <sgcolour.h>

Inheritance diagram for SGDisplayLibColour:

List of all members.

Public Member Functions
	SGDisplayLibColour ()
	SGDisplayLibColour constructor DON'T call this constructor. It ERROR3's. Call the other constructor.
	SGDisplayLibColour (DocColour *ColourToDisplay, StringBase *Name, PalettePrefix Prefix=PalettePrefix_None, BOOL NewlineAfter=FALSE, BOOL IsSpotColour=FALSE)
	SGDisplayLibColour constructor.
virtual BOOL	HandleEvent (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo)
	Handles a SuperGallery DisplayTree event.
virtual void	GetNameText (String_256 *Result)
	To determine a name string for this node. Generally, this is used for a simple mechanism which searches for display items whose names match given search parameters in some way. It is also used in libraries to provide default redraw methods.
virtual INT32	CompareTo (SGDisplayNode *Other, INT32 SortKey)
	Compares this Colour to the 'other' Colour, to determine their relative positions in the display tree. Returns a value which usually indicates that the other Colour should be inserted before (-1, or 0) or after (+1) this item.
virtual BOOL	IsALibraryColour (void) const
	Proper virtual-function method for differentiating between IndexedColour and library DocColour gallery display items.
virtual BOOL	IsASpotColour (void)
	Determine if the display colour is a normal or spot colour.
Private Member Functions
	CC_DECLARE_DYNAMIC (SGDisplayLibColour)
Private Attributes
StringBase	ColourName
LibColourFlags	Flags

---

Detailed Description

Definition at line 331 of file sgcolour.h.

---

Constructor & Destructor Documentation

SGDisplayLibColour::SGDisplayLibColour (   )

SGDisplayLibColour constructor DON'T call this constructor. It ERROR3's. Call the other constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Definition at line 1640 of file sgcolour.cpp. { ERROR3("Illegal call on default SGDisplayLibColour constructor - call the other one!"); Flags.Prefix = 0; Flags.NewlineAfter = FALSE; Flags.SpotColour = FALSE; }

SGDisplayLibColour::SGDisplayLibColour (  DocColour *  ColourToDisplay, StringBase *  Name, PalettePrefix  Prefix = PalettePrefix_None, BOOL  NewlineAfter = FALSE, BOOL  IsSpotColour = FALSE )

SGDisplayLibColour constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: ColourToDisplay  - The definition of the colour this item will display [INPUTS] Name - The name (suffix) of this colour Prefix - ID of a prefix to be prepended to the name NewlineAfter - TRUE if this item is the last in a "run" of colours and should cause a new-line in the displayed list to produce a tidier on screen display. This is only used in "icons only" mode. IsSpotColour - FALSE for a normal colour, TRUE if this is a spot colour Definition at line 1671 of file sgcolour.cpp. { ERROR3IF((INT32)Prefix < 0 || (INT32)Prefix > 0x3f, "Out of range prefix value"); Flags.Prefix = ((UINT32) Prefix) & 0x3f; Flags.NewlineAfter = NewlineAfter; Flags.SpotColour = IsSpotColour; ERROR3IF(ColourToDisplay == NULL || Name == NULL, "Illegal NULL params"); TheColour = *ColourToDisplay; // Copy the colour name. Note that we use a StringBase object an explicitly // allocate exactly the right number of characters, in order to minimise // memory usage (libraries hold thousands of colours, so even one byte less // saves kilobytes of storage over an entire library) // INT32 Length = Name->Length(); ColourName.Alloc(Name->Length()); ColourName = *Name; }

---

Member Function Documentation

SGDisplayLibColour::CC_DECLARE_DYNAMIC (  SGDisplayLibColour   )  [private]

INT32 SGDisplayLibColour::CompareTo (  SGDisplayNode *  Other, INT32  SortKey )  [virtual]

Compares this Colour to the 'other' Colour, to determine their relative positions in the display tree. Returns a value which usually indicates that the other Colour should be inserted before (-1, or 0) or after (+1) this item. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: Other  - the Colour to compare this Colour to [INPUTS] SortKey - An integer identifying how to compare the items 0 = No sorting (always returns 0) 1 = Sort-by-name 2 = Sort-by-hue 3 = Sort-by-intensity 4 = Sort-by-model Returns: negative (I am lesser), 0 (we are equal), or positive (I am greater) Notes: Overrides the base Colour class compare for colour names, but otherwise relegates control back to the base class function. See also: SGDisplayNode::CompareTo; SGDisplayColour::CompareTo Reimplemented from SGDisplayColour. Definition at line 1902 of file sgcolour.cpp. { ERROR3IF(Other == NULL, "Illegal NULL parameter"); ERROR3IF(!Other->IsKindOf(CC_RUNTIME_CLASS(SGDisplayLibColour)), "SGDisplayLibColour::CompareTo - The other item's not a colour!"); switch (SortKey) { case SGSORTKEY_BYNAME: { // We override the base class version to use the specialised name strings that // Library colours hold in them SGDisplayLibColour *pOther = (SGDisplayLibColour *)Other; return(ColourName.CompareTo( (TCHAR *) pOther->ColourName) ); } break; } // Apart from sort-by-name, all sorting can be achieved by the base class code return(SGDisplayColour::CompareTo(Other, SortKey)); }

void SGDisplayLibColour::GetNameText (  String_256 *  Result  )  [virtual]

To determine a name string for this node. Generally, this is used for a simple mechanism which searches for display items whose names match given search parameters in some way. It is also used in libraries to provide default redraw methods. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: On  exit, the string pointed at by Result will contain either a blank [OUTPUTS] string, or the name text associated with this item (if any) See also: SGDisplayLibColour::GetFullInfoText Reimplemented from SGDisplayColour. Definition at line 1713 of file sgcolour.cpp. { ERROR3IF(Result == NULL, "Illegal NULL param"); switch((PalettePrefix) Flags.Prefix) { case PalettePrefix_Pantone: *Result = TEXT("PANTONE "); // NOTE - all these string constants are *Result += ColourName; // the same in all languages and changing the // *Result += TEXT(" PC"); // exact string used here could affect the return; // Pantone licence case PalettePrefix_PantoneSpot: *Result = TEXT("PANTONE "); // NOTE - all these string constants are *Result += ColourName; // the same in all languages and changing the *Result += TEXT(" PC"); // exact string used here could affect the return; // Pantone licence case PalettePrefix_Focoltone: *Result = TEXT("Focoltone "); break; case PalettePrefix_Trumatch: *Result = TEXT("Trumatch "); break; case PalettePrefix_RGB: *Result = TEXT("RGB "); break; default: *Result = TEXT(""); break; } *Result += ColourName; }

BOOL SGDisplayLibColour::HandleEvent (  SGEventType  EventType, void *  EventInfo, SGMiscInfo *  MiscInfo )  [virtual]

Handles a SuperGallery DisplayTree event. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: EventType  - An enumerated value describing what type of event is to be processed [INPUTS] EventInfo - A structure describing the event (may be NULL). The exact thing pointed at by this pointer depends upon the event type: MonoOn Event Thing EventInfo points at SGEVENT_FORMAT (SGFormatInfo *) SGEVENT_REDRAW (SGRedrawInfo *) SGEVENT_MOUSECLICK (SGMouseInfo *) MonoOff Use the provided SGDisplayNode::Get[Format]Info() inlines to retrieve this information - they provide useful error/type checking, and hide the cast MiscInfo - always provided. Contains a few useful bits of info that may be needed for all event types. Parameters: FormatInfo  is updated as appropriate [OUTPUTS] Returns: TRUE if the event was handled successfully FALSE if it was not Notes: This overrides the pure virtual SGDisplayNode::HandleEvent method A node need not handle a specific event - if it does not handle it, it should return FALSE. Redraw and Formatting handlers should never return TRUE, as this will prevent the event from continuing through the tree. Non-leaf-nodes must call SGDisplayNode::GiveEventToMyChildren in order to pass the event dow the tree. THIS node is a leaf-node, so it doesn't. See also: SGDisplayNode::HandleEvent Reimplemented from SGDisplayColour. Definition at line 1800 of file sgcolour.cpp. { switch (EventType) { case SGEVENT_FORMAT: { SGFormatInfo *FormatInfo = GetFormatInfo(EventType, EventInfo); CalculateMyRect(FormatInfo, MiscInfo); // Cache our FormatRect for later use // If in display mode 2, and this is the end of a pantone "page", then // we special case it to do a "newline" at the end of the line, to // keep pages together nicely if (!LibraryHasBeenSorted && MiscInfo->DisplayMode == 2) { if (Flags.NewlineAfter) NewLine(FormatInfo, MiscInfo); } } break; case SGEVENT_MOUSECLICK: { SGMouseInfo *Mouse = GetMouseInfo(EventType, EventInfo); if (FormatRect.ContainsCoord(Mouse->Position)) { // If the colour is in the selected document, then it is safe to // do a colour drag - for now, it will only allow drags for the // selected doc. // Otherwise, the normal click action takes place. // If the drag fails (turns into a click) then the normal click action // takes place, passed on by the GalleryColourDragInfo::OnClick handler // SGDisplayGroup *Parent = (SGDisplayGroup *) GetParent(); if (Mouse->DoubleClick) // || Parent->GetParentDocument() != Document::GetSelected()) { // Use the default click handler. // However, because we assign a very special meaning to adjust-double-click (apply // line colour) we don't want the default action (apply & close gallery) to take // effect, so we pass in FALSE as the last parameter. DefaultClickHandler(Mouse, MiscInfo, FALSE, FALSE); } else { DefaultPreDragHandler(Mouse, MiscInfo); // Don't start drags when there are no documents about if (Document::GetSelected() != NULL) { GalleryColourDragInfo *DragCol; DragCol = new GalleryColourDragInfo(this, Mouse, MiscInfo, Mouse->MenuClick); if (DragCol != NULL) DragManagerOp::StartDrag(DragCol, GetListWindow()); } } return(TRUE); // Claim this event - nobody else can own this click } } break; default: return(SGDisplayColour::HandleEvent(EventType, EventInfo, MiscInfo)); } // Default return value: We do not claim this event, so it will be passed on to others return(FALSE); }

BOOL SGDisplayLibColour::IsALibraryColour (  void   )  const [virtual]

Proper virtual-function method for differentiating between IndexedColour and library DocColour gallery display items. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 Parameters: -  [INPUTS] Returns: FALSE if this is a base-class SGDisplayColour (IndexedColour) TRUE if this is a derived class SGDisplayLibColour (library DocColour) Notes: Always returns TRUE Reimplemented from SGDisplayColour. Definition at line 1946 of file sgcolour.cpp. { return(TRUE); }

BOOL SGDisplayLibColour::IsASpotColour (  void   )  [virtual]

Determine if the display colour is a normal or spot colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 2/9/96 Returns: FALSE if this is a normal colour TRUE if this is a spot colour Reimplemented from SGDisplayColour. Definition at line 1967 of file sgcolour.cpp. { // If spot colours are all forced to be process, this colour is a process colour! if (IndexedColour::AreSpotsForcedToProcess()) return(FALSE); return(Flags.SpotColour); }

---

Member Data Documentation

StringBase SGDisplayLibColour::ColourName [private]

Definition at line 361 of file sgcolour.h.

LibColourFlags SGDisplayLibColour::Flags [private]

Reimplemented from SGDisplayNode. Definition at line 362 of file sgcolour.h.

---

The documentation for this class was generated from the following files:

• Kernel/sgcolour.h (r1785/r1282)
• Kernel/sgcolour.cpp (r1785/r1282)

---