SGDisplayColour Class Reference

This DisplayTree node is used by the Colour SuperGallery It is responsible for providing the ability to handle/redraw one IndexedColour displayed in said gallery. More...

#include <sgcolour.h>

Inheritance diagram for SGDisplayColour:

List of all members.

Public Member Functions
	SGDisplayColour ()
	SGDisplayColour constructor DON'T call this constructor. Call the other constructor.
	SGDisplayColour (IndexedColour *ColourToDisplay)
	SGDisplayColour constructor.
virtual BOOL	HandleEvent (SGEventType EventType, void *EventInfo, SGMiscInfo *MiscInfo)
	Handles a SuperGallery DisplayTree event.
virtual void	DragWasReallyAClick (SGMouseInfo *Mouse, SGMiscInfo *MiscInfo)
	Handles a mouse click event. This is a callback function - drags of colours from galleries will call this function back if the drag turns out to just be a click.
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 void	GetFullInfoText (String_256 *Result)
	To determine a full-info string for this node. Generally, this is used for a simple mechanism which searches for display items whose info matches given search parameters in some way. It is also used in libraries to provide default redraw methods.
virtual BOOL	GetBubbleHelp (DocCoord *MousePos, String_256 *Result)
	Called by the parent gallery when bubble help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help.
virtual BOOL	GetStatusLineHelp (DocCoord *MousePos, String_256 *Result)
	Called by the parent gallery when status line help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help.
virtual void	MoveAfter (SGDisplayNode *NodeToMove)
	MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted.
virtual void	MoveBefore (SGDisplayNode *NodeToMove)
	MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted.
virtual INT32	CompareTo (SGDisplayNode *Other, INT32 SortKey)
	Compares this node to the 'other' node, to determine their relative positions in the display tree. Returns a value which usually indicates that the other node 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 displayed colour is a normal or spot colour.
DocColour *	GetDisplayedColour (void)
	To find out the colour this object is responsible for displaying.
Protected Member Functions
virtual void	CalculateMyRect (SGFormatInfo *FormatInfo, SGMiscInfo *MiscInfo)
	Shared code for colour items to calculate where they will appear in the grand scheme of things.
virtual void	HandleRedraw (SGRedrawInfo *RedrawInfo, SGMiscInfo *MiscInfo)
	SGDisplayColour item redraw method - removed from the main HandleEvent method merely to make the code tidier.
Protected Attributes
DocColour	TheColour
Private Member Functions
	CC_DECLARE_DYNAMIC (SGDisplayColour)

---

Detailed Description

This DisplayTree node is used by the Colour SuperGallery It is responsible for providing the ability to handle/redraw one IndexedColour displayed in said gallery.

Author:

Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>

Date:

27/10/94

See also:

ColourSGallery; SuperGallery; SGDisplayItem

Definition at line 226 of file sgcolour.h.

---

Constructor & Destructor Documentation

SGDisplayColour::SGDisplayColour (   )

SGDisplayColour constructor DON'T call this constructor. Call the other constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 28/10/94 Definition at line 545 of file sgcolour.cpp. { // We don't like people calling this constructor, but we have to put up with it // now that we have a derived class. }

SGDisplayColour::SGDisplayColour (  IndexedColour *  ColourToDisplay  )

SGDisplayColour constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 28/10/94 Parameters: ColourToDisplay  - The colour this item will display [INPUTS] Definition at line 566 of file sgcolour.cpp. { TheColour.MakeRefToIndexedColour(ColourToDisplay); }

---

Member Function Documentation

void SGDisplayColour::CalculateMyRect (  SGFormatInfo *  FormatInfo, SGMiscInfo *  MiscInfo )  [protected, virtual]

Shared code for colour items to calculate where they will appear in the grand scheme of things. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/1/95 Parameters: FormatInfo  - The formatting info from which to calculate my position/size [INPUTS] MiscInfo - The MiscInfo, as usual member  variable FormatRect - is returned filled in with the size/position of [OUTPUTS] this colour item's display area. This is dependent upon the current display mode and format state Scope: private (to sgcolour.cpp, for use of SGDisplayColour class only) Definition at line 945 of file sgcolour.cpp. { const INT32 SGC_FullInfoWidth = SG_InfiniteWidth; //300000; INT32 XSize; INT32 YSize; // Note: The text is usually something like 9 point, so a minimum Y size to fit text // in is going to be around 12 point (12000 millipoints) switch (MiscInfo->DisplayMode) { case 1: // 1 - Full Info XSize = GridLock(MiscInfo, SGC_FullInfoWidth); YSize = GridLock(MiscInfo, SG_DefaultSmallIcon); break; case 2: // 2 - Icon only, no text at all XSize = YSize = GridLock(MiscInfo, SG_DefaultLargeIcon); break; default: // 0 (Default) - Small icon with name XSize = GridLock(MiscInfo, SG_ColourNameWidth); YSize = GridLock(MiscInfo, SG_DefaultSmallIcon); break; } CalculateFormatRect(FormatInfo, MiscInfo, XSize, YSize); }

SGDisplayColour::CC_DECLARE_DYNAMIC (  SGDisplayColour   )  [private]

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

Compares this node to the 'other' node, to determine their relative positions in the display tree. Returns a value which usually indicates that the other node should be inserted before (-1, or 0) or after (+1) this item. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: Other  - the node to compare this node to [INPUTS] SortKey - An integer identifying how to compare the items 0 = No sorting (always returns 0) 1 = Sort-by-name Other values will return 0, unless the derived class overrides this method in order to provide other sort modes. Returns: negative (I am lesser), 0 (we are equal), or positive (I am greater) See also: SGDisplayNode::AddItem Reimplemented from SGDisplayNode. Reimplemented in SGDisplayLibColour. Definition at line 602 of file sgcolour.cpp. { ERROR3IF(Other == NULL, "Illegal NULL parameter"); ERROR3IF(!Other->IsKindOf(CC_RUNTIME_CLASS(SGDisplayColour)), "SGDisplayColour::CompareTo - The other item's not a colour!"); DocColour *OtherCol = ((SGDisplayColour *)Other)->GetDisplayedColour(); DocColour *ThisCol = GetDisplayedColour(); switch (SortKey) { case SGSORTKEY_BYNAME: { IndexedColour *OtherColIx = OtherCol->FindParentIndexedColour(); IndexedColour *ThisColIx = ThisCol->FindParentIndexedColour(); // Safety check - if either colour is NULL, then return "equal" if (OtherColIx == NULL || ThisColIx == NULL) return(0); // We override the base class name comparison, because it is forced to // actually copy the names first! This one just compares them in-place return(ThisColIx->GetName()->CompareTo( (TCHAR *) (*(OtherColIx->GetName())) ) ); } break; case SGSORTKEY_BYHUE: { ColourContextHSVT *ColContext; ColourHSVT ResultCol; ColourValue Hue1; Document *ParentDoc = ((SGDisplayGroup *)GetParent())->GetParentDocument(); // Get a default context, or if ParentDoc != NULL, the current context for the doc. ColContext = (ColourContextHSVT *) ColourManager::GetColourContext(COLOURMODEL_HSVT, ParentDoc); if (ColContext == NULL) return(0); // Convert the 2 colours to HSV and compare their Hue values ColContext->ConvertColour(ThisCol, (ColourGeneric *) &ResultCol); Hue1 = ResultCol.Hue; ColContext->ConvertColour(OtherCol, (ColourGeneric *) &ResultCol); if (Hue1 < ResultCol.Hue) return(-1); return((Hue1 == ResultCol.Hue) ? 0 : 1); } case SGSORTKEY_BYINTENSITY: { ColourContextGreyT *ColContext; ColourGreyT ResultCol; ColourValue Intensity1; Document *ParentDoc = ((SGDisplayGroup *)GetParent())->GetParentDocument(); // Get a default context, or if ParentDoc != NULL, the current context for the doc. ColContext = (ColourContextGreyT *) ColourManager::GetColourContext(COLOURMODEL_GREYT, ParentDoc); if (ColContext == NULL) return(0); // Convert the 2 colours to Greyscale and compare their intensity values ColContext->ConvertColour(ThisCol, (ColourGeneric *) &ResultCol); Intensity1 = ResultCol.Intensity; ColContext->ConvertColour(OtherCol, (ColourGeneric *) &ResultCol); if (Intensity1 < ResultCol.Intensity) return(-1); return((Intensity1 == ResultCol.Intensity) ? 0 : 1); } case SGSORTKEY_BYMODEL: return((INT32)ThisCol->GetColourModel() - (INT32)OtherCol->GetColourModel()); } // No sorting (SGSORTKEY_NONE - 0), or unknown return(SGDisplayItem::CompareTo(Other, SortKey)); }

void SGDisplayColour::DragWasReallyAClick (  SGMouseInfo *  Mouse, SGMiscInfo *  MiscInfo )  [virtual]

Handles a mouse click event. This is a callback function - drags of colours from galleries will call this function back if the drag turns out to just be a click. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 16/2/95 Parameters: Mouse  - The mouse info passed to the original click handler [INPUTS] MiscInfo - The misc info passed to the original click handler See also: SGDisplayColour::HandleEvent; GalleryColourDragInfo::OnClick Reimplemented from SGDisplayNode. Definition at line 1218 of file sgcolour.cpp. { // Just get default selection action to be applied for this click. // The TRUE indicates that this is a drag-click, and we previously called // the DefaultPreDragHandler - we don't want it to do those same actions twice! DefaultClickHandler(Mouse, MiscInfo, TRUE); }

BOOL SGDisplayColour::GetBubbleHelp (  DocCoord *  MousePos, String_256 *  Result )  [virtual]

Called by the parent gallery when bubble help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 16/4/95 Parameters: MousePos  - The current mouse position. This will generally be expected [INPUTS] to lie inside this item's FormatRect. With it, this item can provide help on specific areas of an item. On  exit, if the return value is TRUE, the string pointed at by Result [OUTPUTS] will contain a bubble help string for this item Returns: TRUE if it filled in the string, FALSE if it did not Notes: The base class returns FALSE (i.e. provides no help) If you can provide help, then override the base class method to do so. See also: SGDisplayNode::GetStatusLineHelp Reimplemented from SGDisplayNode. Definition at line 1560 of file sgcolour.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); return(FALSE); }

DocColour * SGDisplayColour::GetDisplayedColour (  void   )  [inline]

To find out the colour this object is responsible for displaying. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/1/95 Returns: A pointer to the colour which this Display Item is used to display. Definition at line 301 of file sgcolour.h. { return(&TheColour); }

void SGDisplayColour::GetFullInfoText (  String_256 *  Result  )  [virtual]

To determine a full-info string for this node. Generally, this is used for a simple mechanism which searches for display items whose info matches 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: 9/3/95 Parameters: On  exit, the string pointed at by Result will contain either a blank [OUTPUTS] string, or the full-information text associated with this item (if any) See also: SGDisplayColour::GetNameText Reimplemented from SGDisplayNode. Definition at line 743 of file sgcolour.cpp. { ERROR3IF(Result == NULL, "Illegal NULL param"); *Result = TEXT(""); // Set a safe default // Generate an info string of the form: // <ColModel> (<components>) [, <tint/link/spot information>] [, not in use] // e.g. "HSV(324, 80, 75), Linked to Red" String_256 Info(TEXT("")); ColourContext *cc = ColourContext::GetGlobalDefault(TheColour.GetColourModel()); ERROR3IF(cc == NULL, "Default colour context is NULL!?"); ColourGeneric col; TheColour.GetSourceColour(&col); cc->GetModelName(&Info); String_128 TempStr(TEXT("(")); String_16 CompStr; if (cc->GetComponentName(1, NULL)) { double CompVal; if (TheColour.GetColourModel() == COLOURMODEL_HSVT) CompVal = (col.Component1.MakeDouble()) * 360.0; else CompVal = (col.Component1.MakeDouble()) * 100.0; // Convert it to a string rounded to 1 decimal place accuracy Convert::DoubleToString(CompVal, &CompStr, 1); TempStr += CompStr; } if (cc->GetComponentName(2, NULL)) { Convert::DoubleToString(col.Component2.MakeDouble() * 100.0, &CompStr, 1); TempStr += TEXT(", "); TempStr += CompStr; } if (cc->GetComponentName(3, NULL)) { Convert::DoubleToString(col.Component3.MakeDouble() * 100.0, &CompStr, 1); TempStr += TEXT(", "); TempStr += CompStr; } if (cc->GetComponentName(4, NULL)) { Convert::DoubleToString(col.Component4.MakeDouble() * 100.0, &CompStr, 1); TempStr += TEXT(", "); TempStr += CompStr; } TempStr += TEXT(")"); Info += TempStr; IndexedColour *ParentCol = TheColour.FindParentIndexedColour(); // If this refs an IndexedColour... if (ParentCol != NULL) { switch(ParentCol->GetType()) { case COLOURTYPE_SPOT: TempStr.MakeMsg(_R(IDS_COLGAL_ISPOT)); Info += TempStr; break; case COLOURTYPE_TINT: { ERROR3IF(ParentCol->FindLinkedParent() == NULL, "A tint without a parent colour? Oh bums!"); if (ParentCol->TintIsShade()) { TempStr.MakeMsg(_R(IDS_COLGAL_ISHADE), (TCHAR *) *(ParentCol->FindLinkedParent()->GetName())); } else { TempStr.MakeMsg(_R(IDS_COLGAL_ITINT), (INT32) ((ParentCol->GetTintValue().MakeDouble() + 0.005)*100), (TCHAR *) *(ParentCol->FindLinkedParent()->GetName())); } Info += TempStr; } break; case COLOURTYPE_LINKED: { ERROR3IF(ParentCol->FindLinkedParent() == NULL, "A linked colour without a parent colour? Oh bums!"); TempStr.MakeMsg(_R(IDS_COLGAL_ILINKED), (TCHAR *) *(ParentCol->FindLinkedParent()->GetName())); Info += TempStr; } break; default: break; } SGDisplayGroup *DocumentGroup = (SGDisplayGroup *) GetParent(); ERROR3IF(DocumentGroup == NULL, "SGallery DisplayTree linkage corruption detected"); Document *ScopeDoc = DocumentGroup->GetParentDocument(); ERROR3IF(ScopeDoc == NULL, "SGallery group is not for a document! Unimplemented! Eek!"); ColourList *ParentColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ParentColList == NULL, "A document with no colour list? Now I've seen it all"); if (!ParentColList->IsColourInUseInDoc(ParentCol, TRUE)) { // Add ' (not in use)' for any colour not currently used in the // document, or as a linked-colour parent TempStr.MakeMsg(_R(IDS_COLGAL_INOTUSED)); Info += TempStr; } } *Result = Info; }

void SGDisplayColour::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: 9/3/95 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: SGDisplayColour::GetFullInfoText Reimplemented from SGDisplayNode. Reimplemented in SGDisplayLibColour. Definition at line 711 of file sgcolour.cpp. { ERROR3IF(Result == NULL, "Illegal NULL param"); IndexedColour *ParentCol = TheColour.FindParentIndexedColour(); if (ParentCol != NULL) *Result = *(ParentCol->GetName()); else Result->MakeMsg(_R(IDS_UNNAMEDCOLOUR)); }

BOOL SGDisplayColour::GetStatusLineHelp (  DocCoord *  MousePos, String_256 *  Result )  [virtual]

Called by the parent gallery when status line help is needed. The parent gallery will do a hit test to determine which node contains the pointer, and will then ask that node to supply bubble/status-line help. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 16/4/95 Parameters: MousePos  - The current mouse position. This will generally be expected [INPUTS] to lie inside this item's FormatRect. With it, this item can provide help on specific areas of an item. On  exit, if the return value is TRUE, the string pointed at by Result [OUTPUTS] will contain a status line help string for this item Returns: TRUE if it filled in the string, FALSE if it did not Notes: The base class returns FALSE (i.e. provides no help) If you can provide help, then override the base class method to do so. See also: SGDisplayNode::GetBubbleHelp Reimplemented from SGDisplayNode. Definition at line 1596 of file sgcolour.cpp. { ERROR3IF(MousePos == NULL || Result == NULL, "Invalid NULL params"); *Result = TEXT(""); // Empty the string, just to be safe GetNameText(Result); // Start the string with the colour name *Result += TEXT("; "); String_64 Temp; if (IsSelected()) Temp = _R(IDS_SGCOLOUR_CTRL_CLICK); // TEXT("Ctrl-click to deselect;"); else Temp = _R(IDS_SGCOLOUR_CLICK); // TEXT("Click to select;"); *Result += Temp; *Result += String_64(_R(IDS_SGCOLOUR_DOUBLE_CLICK)); // TEXT(" Double-click to apply this colour; Or drag and drop"); return(TRUE); }

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

Handles a SuperGallery DisplayTree event. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/94 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 SGDisplayItem. Reimplemented in SGDisplayLibColour. Definition at line 1275 of file sgcolour.cpp. { switch (EventType) { case SGEVENT_FORMAT: { SGFormatInfo *FormatInfo = GetFormatInfo(EventType, EventInfo); CalculateMyRect(FormatInfo, MiscInfo); // Cache our FormatRect for later use } break; case SGEVENT_REDRAW: { DocRect MyRect(FormatRect); // Rely on FormatRect being cached from above SGRedrawInfo *RedrawInfo = GetRedrawInfo(EventType, EventInfo); if (IMustRedraw(RedrawInfo)) HandleRedraw(RedrawInfo, MiscInfo); } break; // exit and return FALSE to pass the redraw event on 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); // Start a drag, but only if there are selected documents around if (Document::GetSelected() != NULL) { GalleryColourDragInfo *DragCol; DragCol = new GalleryColourDragInfo(Parent->GetParentDocument(), 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(SGDisplayItem::HandleEvent(EventType, EventInfo, MiscInfo)); } // Default return value: We do not claim this event, so it will be passed on to others return(FALSE); }

void SGDisplayColour::HandleRedraw (  SGRedrawInfo *  RedrawInfo, SGMiscInfo *  MiscInfo )  [protected, virtual]

SGDisplayColour item redraw method - removed from the main HandleEvent method merely to make the code tidier. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 13/1/95 Parameters: RedrawInfo  - The information on the kernel-rendered redraw area [INPUTS] FormatInfo - The formatting information structure member variable FormatRect should be set up (before calling this method) to be the rectangle in which to draw this item Scope: private Definition at line 1052 of file sgcolour.cpp. { StartRendering(RedrawInfo, MiscInfo); DocRect MyRect(FormatRect); RenderRegion *Renderer = RedrawInfo->Renderer; INT32 OnePixel = (INT32) DevicePixels(MiscInfo, 1); INT32 TwoPixels = (INT32) DevicePixels(MiscInfo, 2); DocRect IconRect(MyRect); // Create a square icon at the left end of our rectangle IconRect.hi.x = IconRect.lo.x + IconRect.Height(); MyRect.lo.x = IconRect.hi.x + TwoPixels; // Redraw the icon GridLockRect(MiscInfo, &IconRect); Renderer->SetLineWidth(0); Renderer->SetLineColour(RedrawInfo->Transparent); // If selected, we have a 3-pixel-thick selection border // Otherwise (as is now the case) we have a single-pixel black border // We draw border "lines" using rectangle fills, else it screws pixel alignment if (!Flags.Selected) IconRect.Inflate(-TwoPixels); IndexedColour *IxCol = TheColour.FindParentIndexedColour(); // Draw (selection border and) border // The patch is normally a square (process colour), but for spot colours // is drawn as a circle, in order to make the distinction more obvious // // WEBSTER - markn 23/1/97 // No Circles required. // DocColour black(COLOUR_BLACK); Renderer->SetFillColour(black); #ifndef WEBSTER if (IsASpotColour()) { IconRect.Inflate(-OnePixel); DrawCircle(Renderer, IconRect); } else #endif // WEBSTER Renderer->DrawRect(&IconRect); // And draw it // Now deflate further, to get inside the selection & border... IconRect.Inflate((Flags.Selected) ? -(TwoPixels+OnePixel) : -OnePixel); // Draw the colour patch (icon) // Save and restore the context while using TheColour to fill with. This is so that // the renderer no longer references the IndexedColour, so that GetFullInfoText will // put the text '(not in use)' on the end of colours which aren't used in the document! Renderer->SaveContext(); Renderer->SetFillColour(TheColour); // Fill with colour to display // The patch is normally a square (process colour), but for spot colours // is drawn as a circle, in order to make the distinction more obvious // // WEBSTER - markn 23/1/97 // No Circles required. // #ifndef WEBSTER if (IsASpotColour()) DrawCircle(Renderer, IconRect); else #endif // WEBSTER Renderer->DrawRect(&IconRect); // And draw it Renderer->RestoreContext(); // Redraw the name text, if there is room to the right of the icon if (MyRect.lo.x < MyRect.hi.x) { GridLockRect(MiscInfo, &MyRect); // IndexedColour *ParentCol = TheColour.FindParentIndexedColour(); if (Flags.Selected) { // Fill the entire background with the 'selected' colour, so we don't // get gaps between bits of text or uneven rectangles in multiple selections Renderer->SetFillColour(RedrawInfo->SelBackground); Renderer->DrawRect(&MyRect); Renderer->SetFixedSystemTextColours(&RedrawInfo->SelForeground, &RedrawInfo->SelBackground); if (IxCol != NULL) // Only do this for IndexedColours (i.e. not derived class Library colours) { // If this item represents the current line colour, then place a vertical line between the icon // and the text to indicate this fact. DocColour *LineCol; ColourManager::GetCurrentLineAndFillColours(&LineCol, NULL); if (LineCol != NULL && LineCol->FindParentIndexedColour() == TheColour.FindParentIndexedColour()) { // This item is selected and is the current line colour. Put a mark in to indicate this DocColour black(COLOUR_BLACK); Renderer->SetLineColour(black); Renderer->SetLineWidth(TwoPixels); Renderer->DrawLine(MyRect.lo, DocCoord(MyRect.lo.x, MyRect.hi.y)); } } } else Renderer->SetFixedSystemTextColours(&RedrawInfo->Foreground, &RedrawInfo->Background); MyRect.lo.x += SG_GapBeforeText; // Leave a small gap before text begins String_256 Name; GetNameText(&Name); // Get the name string if (MiscInfo->DisplayMode == 1) // If in Full Info mode... { DocRect TextRect(MyRect); // Reserve space for the name (clip it if it won't fit) if (TextRect.hi.x - TextRect.lo.x > SG_ColourNameWidth) TextRect.hi.x = TextRect.lo.x + SG_ColourNameWidth; // Draw the name text next to the icon Renderer->DrawFixedSystemText(&Name, TextRect); // Move to the right, to fill the remaining space with information // (Leave a 6-pixel gap in case the name didn't all fit in the available space) TextRect.lo.x = TextRect.hi.x + DevicePixels(MiscInfo, 6); TextRect.hi.x = MyRect.hi.x; if (TextRect.lo.x < TextRect.hi.x) // If any room left for info... { // Get the full info description, and render it GetFullInfoText(&Name); Renderer->DrawFixedSystemText(&Name, TextRect); } } else { // Not full-info mode, so we only render the colour name next to the patch Renderer->DrawFixedSystemText(&Name, MyRect); } } StopRendering(RedrawInfo, MiscInfo); }

BOOL SGDisplayColour::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 FALSE Reimplemented in SGDisplayLibColour. Definition at line 889 of file sgcolour.cpp. { return(FALSE); }

BOOL SGDisplayColour::IsASpotColour (  void   )  [virtual]

Determine if the displayed colour is a normal or spot colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 2/9/96 Parameters: -  [INPUTS] Returns: FALSE if this is a normal colour TRUE if this is a spot colour Reimplemented in SGDisplayLibColour. Definition at line 911 of file sgcolour.cpp. { if (TheColour.FindParentIndexedColour() != NULL) { if (TheColour.FindParentIndexedColour()->IsSpotOrTintOfSpot()) return(TRUE); } return(FALSE); }

void SGDisplayColour::MoveAfter (  SGDisplayNode *  NodeToMove  )  [virtual]

MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: NodeToMove  - the node to move [INPUTS] Notes: This base class method simply delinks the item and relinks it elsewhere in the display tree. However, derived classes will override this method so that moving display items can have a further effect of also rearranging the displayed "real" items. Before/After moving the real item, the derived class can then call this baseclass method to complete the action. Take care when moving items between groups (e.g. if an item is "moved" from one docuemnt to another, it could be a bad thing, so be very careful in derived classes to take appropriate action) Any attempt to move an item after *itself* is queitly ignored Returns: Errors: ERROR3 and quiet exit if NodeToMove == NULL See also: SuperGallery; SGDisplayColour::InsertAfter; SGDisplayColour::AddItem Reimplemented from SGDisplayNode. Definition at line 1385 of file sgcolour.cpp. { ERROR3IF(NodeToMove == NULL, "Illegal NULL param"); if (NodeToMove == this) return; if (IsALibraryColour()) LibraryHasBeenSorted = TRUE; DocColour *DocColToMove = ((SGDisplayColour *) NodeToMove)->GetDisplayedColour(); ERROR3IF(DocColToMove == NULL, "NULL displayed colour?!"); IndexedColour *ColToMove = DocColToMove->FindParentIndexedColour(); IndexedColour *TargetColour = TheColour.FindParentIndexedColour(); if (ColToMove == NULL || TargetColour == NULL) { // If either colour is a library colour, then no need to move colours in the // document colour list, so just move the display nodes appropriately and return. SGDisplayNode::MoveAfter(NodeToMove); return; } Document *ScopeDoc = ((SGDisplayGroup *) GetParent())->GetParentDocument(); ERROR3IF(ScopeDoc == NULL, "No parent document?!"); if ( ((SGDisplayGroup *) ( ((SGDisplayColour *)NodeToMove)->GetParent() ) )->GetParentDocument() != ScopeDoc) { ERROR2RAW("Attempt to MOVE a colour between documents!"); InformError(); return; } ColourList *ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list?!"); ColList->RemoveItem(ColToMove); ColList->InsertAfter(TargetColour, ColToMove); SGDisplayNode::MoveAfter(NodeToMove); // We do not need to do the following - the parent gallery will do it when it is called // with SuperGallery::AllItemsCopied. This allows us to be called many times in a row // without generating more than one broadcast. // // Inform the world, and lock out changes in the colour gallery // ColourSGallery *ParentGallery = (ColourSGallery *)GetParentGallery(); // BOOL OldSentState = ParentGallery->ISentTheMessage; // ParentGallery->ISentTheMessage = TRUE; // // ColourManager::ColourListHasChanged(ColList); // // ParentGallery->ISentTheMessage = OldSentState; }

void SGDisplayColour::MoveBefore (  SGDisplayNode *  NodeToMove  )  [virtual]

MOVES the given node (to a different position in the DisplayTree) as the previous (left) sibling of this node. If the node is not linked into a tree, it is effectively just inserted. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: NodeToMove  - the node to move [INPUTS] Notes: This base class method simply delinks the item and relinks it elsewhere in the display tree. However, derived classes will override this method so that moving display items can have a further effect of also rearranging the displayed "real" items. Before/After moving the real item, the derived class can then call this baseclass method to complete the action. Take care when moving items between groups (e.g. if an item is "moved" from one docuemnt to another, it could be a bad thing, so be very careful in derived classes to take appropriate action) Any attempt to move an item before *itself* is queitly ignored Returns: Errors: ERROR3 and quiet exit if NodeToMove == NULL See also: SuperGallery; SGDisplayColour::InsertBefore; SGDisplayColour::AddItem Reimplemented from SGDisplayNode. Definition at line 1475 of file sgcolour.cpp. { ERROR3IF(NodeToMove == NULL, "Illegal NULL param"); if (NodeToMove == this) return; if (IsALibraryColour()) LibraryHasBeenSorted = TRUE; DocColour *DocColToMove = ((SGDisplayColour *) NodeToMove)->GetDisplayedColour(); ERROR3IF(DocColToMove == NULL, "NULL displayed colour?!"); IndexedColour *ColToMove = DocColToMove->FindParentIndexedColour(); IndexedColour *TargetColour = TheColour.FindParentIndexedColour(); if (ColToMove == NULL || TargetColour == NULL) { // If either colour is a library colour, then no need to move colours in the // document colour list, so just move the display nodes appropriately and return. SGDisplayNode::MoveBefore(NodeToMove); return; } Document *ScopeDoc = ((SGDisplayGroup *) GetParent())->GetParentDocument(); ERROR3IF(ScopeDoc == NULL, "No parent document?!"); if ( ((SGDisplayGroup *) ( ((SGDisplayColour *)NodeToMove)->GetParent() ) )->GetParentDocument() != ScopeDoc) { ERROR2RAW("Attempt to MOVE a colour between documents!"); InformError(); return; } ColourList *ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list?!"); ColList->RemoveItem(ColToMove); ColList->InsertBefore(TargetColour, ColToMove); SGDisplayNode::MoveBefore(NodeToMove); // We do not need to do the following - the parent gallery will do it when it is called // with SuperGallery::AllItemsCopied. This allows us to be called many times in a row // without generating more than one broadcast. // // Inform the world, and lock out changes in the colour gallery // ColourSGallery *ParentGallery = (ColourSGallery *)GetParentGallery(); // BOOL OldSentState = ParentGallery->ISentTheMessage; // ParentGallery->ISentTheMessage = TRUE; // // ColourManager::ColourListHasChanged(ColList); // // ParentGallery->ISentTheMessage = OldSentState; }

---

Member Data Documentation

DocColour SGDisplayColour::TheColour [protected]

Definition at line 283 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)

---