ColourSGallery Class Reference

The Colour SuperGallery class. More...

#include <sgcolour.h>

Inheritance diagram for ColourSGallery:

List of all members.

Public Member Functions
	ColourSGallery ()
	ColourSGallery default constructor.
	~ColourSGallery ()
	ColourSGallery destructor.
virtual MsgResult	Message (Msg *Message)
	A standard message handler, really.
virtual SGDisplayItem *	CopyDisplayItem (SGDisplayItem *SourceItem, SGDisplayGroup *DestGroup, SGDisplayItem *TargetPosition=NULL)
	"Copies" the existing node in the tree in an appropriate fashion.
virtual void	AllItemsCopied (SGDisplayGroup *DestGroup)
	This upcall method is called after one or more items have been copied or moved by a gallery drag. It allows the gallery to do update things like broadcasting a message or getting a related window (eg colour line) to redraw at the end of a move/copy operation. This allows thousands of items to be moved/copied with only a single redraw/message-broadcast, etc at the very end.
virtual BOOL	InitMenuCommands (void)
	Initialises any menu commands that this gallery needs.
virtual BOOL	BuildCommandMenu (GalleryContextMenu *TheMenu, SGMenuID MenuID)
	To build a menu of commands to be popped up over the gallery.
virtual OpState	GetCommandState (StringBase *CommandID, String_256 *ShadeReason)
	To determine the state of a given menu item. This method is an exact parallel to an Op's GetState method (in fact, it is called by an Op's GetState).
virtual void	DoCommand (StringBase *CommandID)
	To apply a given command when it is chosen from the menu.
void	SetCurrentImportGroup (SGDisplayLibColGroup *TheGroup)
SGDisplayLibColGroup *	GetCurrentImportGroup (void)
BOOL	MakeSureGroupsHaveBeenCreated ()
	This will create the gallery groups (unless they're already there) and return TRUE if ok.
SGDisplayLibColGroup *	GetFirstLibGroup ()
	Gets the first colour library group node in the colour gallery.
SGDisplayLibColGroup *	GetNextLibGroup (SGDisplayLibColGroup *pLibGroup)
	Gets the next colour library group node in the colour gallery.
BOOL	ApplySelectedAsBackground ()
	Takes the selected item in the gallery and tries to apply this as a new background to the spread.
BOOL	GetDocColourToApply (SGDisplayColour *pFirstSelected, DocColour *pColourToApply, Document **pDoc)
	To create a doc colour which can then be used to apply the colour in the currently selected document. Copes with the simple case of the colour being a document colour and the more complex case of teh colour being a library colour. Whereapon, a new colour must be added to the selected document which is this selected library colour.
Static Public Member Functions
static BOOL	Init (void)
	ColourSGallery initialisation - declares preferences etc.
static ColourSGallery *	GetInstance ()
	Public access function to the colour gallery.
static BOOL	CanAddColourToGallery (IndexedColour *pCol, ColourList *pColList)
	Central point where it decides whether the colour should be displayed in the gallery.
Static Public Attributes
static INT32	AutoScrollSelection = TRUE
	If TRUE, the colour gallery will automatically scroll its display list to show the currently selected line and fill colours whenever the selection changes. If FALSE, these colours will still become selected, but the gallery will not be scrolled.
static INT32	DefaultDisplayMode = 0
	Memory of the current colour gallery display mode, saved between sessions for convenience. Not shown in the options dialogue.
static String_256	PalettePath = TEXT("")
	The path to load the palettes from. Defaults to blank which means alongside the exe.
static BOOL	ShowDocumentColours = TRUE
	Memory of the current state of showing document colours in the colour line.
static BOOL	ShowNetscapeColours = TRUE
	Memory of the current state of showing Netscape colours in the colour line. Webster needs to default to True.
Protected Member Functions
virtual BOOL	PreCreate (void)
	The ColourSGallery PreCreate handler. This overrides the base class PreCreate function. It is called at the very start of the SuperGallery::Create method, before the window has been created.
virtual BOOL	ApplyAction (SGActionType Action)
	Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc).
virtual void	HandleDragStart (DragMessage *DragMsg)
	Checks a DragMessage to see if it is a colour drag. If it is, then it creates a drag target for this gallerys listbox.
virtual void	SelectionHasChanged (void)
	To inform the gallery that the selection has changed in some way.
virtual void	DoShadeGallery (BOOL ShadeIt)
	Called by the base class whenever the shaded status of the gallery is changed, to allow derived galleries to shade/unshade any extra controls that they provide in the window. ONLY called if the gallery is actually open/visible.
virtual RenderRegion *	CreateRenderRegion (DocRect *VirtualSize, ReDrawInfoType *DlgRedrawInfo)
	An overridable veneer to the DialogOp CreateOSRenderRegion method. This can be overriden to use a different type of renderregion for all of your rendering.
virtual void	DestroyRenderRegion (RenderRegion *pRender)
	An overridable veneer to the DialogOp DestroyOSRenderRegion method. This can be overriden to use a different type of renderregion for all of your rendering.
void	CreateNewSubtree (Document *ParentDoc, SGDisplayColourGroup *ExistingGroup=NULL)
	Internal call. This takes the colour list of the given document and creates a DisplayTree subtree from it. This subtree is then added to the DisplayTree. Note that this does not force a redraw of the list - after making this call, you should also call ForceRedrawOfList.
void	RedrawColourDisplay (Document *TheDocument, IndexedColour *TheColour)
	Redraws the display item for one specific colour, and all of its linked descendants (liked/tint colours) (if any) in a given document.
void	EditColour (ColourList *ParentList, IndexedColour *TheColour)
	Opens the colour editor, and sets it to edit the given colour.
BOOL	OKToDeleteSelection (SGDisplayGroup *DocumentGroup)
	To determine if it is OK to go ahead and delete the selected colours, and to possibly modify the selection if some colours should not be deleted.
BOOL	DeleteSelection (SGDisplayGroup *DocumentGroup, ColourList *ParentList)
	Forcibly deletes all selected colours Should be used after OKToDeleteSelection (which confirms the action).
void	SetSelectionFromDocument (BOOL AlwaysScroll=FALSE)
	Sets the colour gallery listbox selection state based upon the currently selected object(s) in the document (to show the current fill/stroke colours).
Protected Attributes
BOOL	ISentTheMessage
ColourListComponent *	CurrentColComp
SGDisplayNode *	CurrentTarget
Static Protected Attributes
static ColourSGallery *	m_pTheGallery = NULL
Private Attributes
SGDisplayLibColGroup *	CurrentImportGroup
Friends
class	SGDisplayColour

---

Detailed Description

The Colour SuperGallery class.

Author:

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

Date:

27/10/94

Notes: SuperGalleries are specced in a number of docs including specs.doc ("super" gallery extensions) specs.doc (gallery basic ui)

See also:

SuperGallery; SGDisplayColour

Definition at line 466 of file sgcolour.h.

---

Constructor & Destructor Documentation

ColourSGallery::ColourSGallery (   )

ColourSGallery default constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/94 Definition at line 2369 of file sgcolour.cpp. { DlgResID = _R(IDD_COLOURSGALLERY); ISentTheMessage = FALSE; CurrentColComp = NULL; CurrentTarget = NULL; // Set the display mode up from the default setting DisplayMode = DefaultDisplayMode; if (DisplayMode < 0 || DisplayMode > 2) DisplayMode = 0; CurrentImportGroup = NULL; // WEBSTER - markn 9/12/96 - Martin 16/07/97 same as Camelot now // Default gallery size //CSize Size(256, 256); //SetGallerySize(Size); // Remember a pointer to the global instance of this gallery. ERROR3IF(m_pTheGallery != NULL, "Gallery already exists in ColourSGallery::ColourSGallery?"); m_pTheGallery = this; }

ColourSGallery::~ColourSGallery (   )

ColourSGallery destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/94 Definition at line 2406 of file sgcolour.cpp. { ERROR3IF(CurrentColComp != NULL, "Destructed colour gallery is still doing a component copy?!"); // Remember the display mode as the default setting for next time we're created (preference) DefaultDisplayMode = DisplayMode; // Make sure nothing is seriously screwed-up. ERROR3IF(m_pTheGallery == NULL, "No gallery in ColourSGallery::~ColourSGallery?"); m_pTheGallery = NULL; }

---

Member Function Documentation

void ColourSGallery::AllItemsCopied (  SGDisplayGroup *  DestGroup  )  [virtual]

This upcall method is called after one or more items have been copied or moved by a gallery drag. It allows the gallery to do update things like broadcasting a message or getting a related window (eg colour line) to redraw at the end of a move/copy operation. This allows thousands of items to be moved/copied with only a single redraw/message-broadcast, etc at the very end. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/95 Notes: The caller automatically causes the appropriate things to be redrawn, so we just need to update other things. e.g. The colour gallery broadcasts a ColourChangingMsg to make sure that the colour line and other interested parties all update appropriately. See also: SuperGallery::CopyDisplayItem; SGDisplayItem::MoveBefore; SGDisplayItem::MoveAfter; ColourSGallery::AllItemsCopied Reimplemented from SuperGallery. Definition at line 4078 of file sgcolour.cpp. { ERROR3IF(DestGroup == NULL, "Illegal NULL param"); BOOL OldSentState = ISentTheMessage; // Make me ignore any messages triggered by this code ISentTheMessage = TRUE; // This can be called after MoveItems as well as CopyDisplayItem calls // We only have to do something if the CopyDisplayItem call has started a component copy... if (CurrentColComp != NULL) { // Merge colours, add undo record, etc. Any new colours will be inserted after the // given target position, and if any colours were merged, the user is informed IndexedColour *Target = NULL; if (CurrentTarget != NULL) Target = ((SGDisplayColour *)CurrentTarget)->GetDisplayedColour()-> FindParentIndexedColour(); CurrentColComp->EndComponentCopy(Target, TRUE); CurrentColComp = NULL; CurrentTarget = NULL; Document *ParentDoc = DestGroup->GetParentDocument(); if (ParentDoc != NULL) { CreateNewSubtree(ParentDoc, (SGDisplayColourGroup*)DisplayTree->FindSubtree(this, ParentDoc, NULL)); InvalidateCachedFormat(); ReformatAndRedrawIfNecessary(); } } else { // Inform the rest of the world that this colour list order has been modified Document *ParentDoc = DestGroup->GetParentDocument(); if (ParentDoc != NULL) ColourManager::ColourListHasChanged(ParentDoc->GetIndexedColours()); } ISentTheMessage = OldSentState; }

BOOL ColourSGallery::ApplyAction (  SGActionType  Action  )  [protected, virtual]

Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/1/95 Parameters: Action  - Indicates what action to apply [INPUTS] Returns: TRUE to indicate successful handling of the action, or FALSE to indicate failure See also: SGActionType Reimplemented from SuperGallery. Definition at line 3088 of file sgcolour.cpp. { // No display tree? Or worse, no active docuemnts? Better forget about it then! if (DisplayTree == NULL || Document::GetSelected() == NULL) return(FALSE); SGDisplayColour *FirstSelected = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(NULL); SGDisplayGroup *DocumentGroup = NULL; Document *ScopeDoc = NULL; ColourList *ColList = NULL; IndexedColour *SelectedColour = NULL; DocColour *TheColour = NULL; if (FirstSelected != NULL) { DocumentGroup = (SGDisplayGroup *) FirstSelected->GetParent(); ERROR3IF(DocumentGroup == NULL, "SGallery DisplayTree linkage corruption detected"); ScopeDoc = DocumentGroup->GetParentDocument(); if (ScopeDoc == NULL) // Must be a library item, so it will affect the selected doc ScopeDoc = Document::GetSelected(); ERROR3IF(ScopeDoc == NULL, "No scope document for colour gallery operation!"); ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list? Now I've seen it all"); TheColour = FirstSelected->GetDisplayedColour(); ERROR3IF(TheColour == NULL, "SGDisplayColour has no colour in it?"); SelectedColour = TheColour->FindParentIndexedColour(); } BOOL Adjust = FALSE; // Now, process the action switch(Action) { case SGACTION_CREATE: ColList = Document::GetSelected()->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list? Now I've seen it all"); if (ColList != NULL) { BOOL OldSentState = ISentTheMessage; ISentTheMessage = TRUE; IndexedColour *NewCol = NULL; if (FirstSelected == NULL || !FirstSelected->IsALibraryColour() || TheColour == NULL) NewCol = ColourManager::GenerateNewNamedColour(ColList, SelectedColour); else { // A library doccolour - we must copy it into the document before trying to apply it // Make a temporary IndexedColour from the library colour NewCol = new IndexedColour(*TheColour); if (NewCol != NULL) { SGDisplayLibColour *LibCol = (SGDisplayLibColour *) FirstSelected; // Set the colour's name to the same as the library item (but make sure it's unique) String_256 Buffer; LibCol->GetNameText(&Buffer); NewCol->SetName(Buffer); if (ColList->GenerateUniqueColourName(NewCol->GetName(), (String_64 *) &Buffer)) NewCol->SetName(Buffer); // If it's a spot colour, make it so if (LibCol->IsASpotColour()) NewCol->SetLinkedParent(NULL, COLOURTYPE_SPOT); // Copy the colour into the destination document (merging it with existing // colours so we won't keep creating new copies of the same colour as it's applied) DocColour ColourToApply; ColourToApply.MakeRefToIndexedColour(NewCol); ColourManager::EnsureColourIsInDocument(NULL, Document::GetSelected(), &ColourToApply); // Delete the temporary IndexedColour we used delete NewCol; // And remember the new colour we've just made NewCol = ColourToApply.FindParentIndexedColour(); } } // If NewCol == NULL, either an error occured, or more likely, the user cancelled ISentTheMessage = OldSentState; if (NewCol != NULL) { // Bring up the colour editor on the new colour EditColour(ColList, NewCol); // And make the new item the selected one in the list SelectItems(FALSE); // Deselect everything else // Find the item and select it SGDisplayGroup *DocGroup = DisplayTree->FindSubtree(this, Document::GetSelected(), NULL); if (DocGroup != NULL) { // We've found the group for the selected document SGDisplayColour *Ptr = new SGDisplayColour(NewCol); if (Ptr != NULL) { // Add the item to the group using the last applied sort mode DocGroup->AddItem(Ptr, SortKeys); // And rearrange the real colour item to the same position by inserting // it after the colour which is previous in the display list. If there // is no display-list-previous-item, then we insert at the head. ColourList *ColList = ColourManager::GetColourList(); ColList->RemoveItem(NewCol); if (ColList->GetHead() == NULL) { // Thanks, Mario. If you try to add an item when the list is empty // he just ignores you (no ensure, no useful default behaviour) ColList->AddItem(NewCol); } else { if (Ptr->GetPrevious() == NULL) ColList->InsertBefore(ColList->GetHead(), NewCol); else ColList->InsertAfter(((SGDisplayColour *)Ptr->GetPrevious())-> GetDisplayedColour()->FindParentIndexedColour(), NewCol); } ForceGroupFolded(DocGroup, FALSE); // Ensure group is unfolded and tree reformatted // Select the new node, and remember it as the new selection anchor Ptr->SetSelected(TRUE); SetLastSelectedNode(Ptr); // Ensure the format is recalculated as a result of adding the new item ReformatAndRedrawIfNecessary(); // And now we can get its format rect, and scroll to show it DocRect ItemFormatRect; Ptr->GetFormatRect(&ItemFormatRect); ScrollToShow(&ItemFormatRect); } } else { ERROR3("Colour DisplayGroup not found for Selected Document!"); } SelectionHasChanged(); } } break; case SGACTION_APPLYADJUST: Adjust = TRUE; // Drop through to SGACTION_APPLY handler case SGACTION_APPLY: if (TheColour != NULL && (SelectedColour != NULL || FirstSelected->IsALibraryColour())) { DocColour ColourToApply; if (!FirstSelected->IsALibraryColour()) { // Normal IndexedColour item - just apply it ColourToApply.MakeRefToIndexedColour(SelectedColour); // Ensure this colour (or an equivalent) is available in the selected doc // (which is where the apply will take place), and modify ColourToApply // (if necessary) to reference the safe colour for the dest doc. ColourManager::EnsureColourIsInDocument(ScopeDoc, Document::GetSelected(), &ColourToApply); } else { // A library doccolour - we must copy it into the document before trying to apply it // Make a temporary IndexedColour from the library colour IndexedColour *NewCol = new IndexedColour(*TheColour); if (NewCol != NULL) { SGDisplayLibColour *LibCol = (SGDisplayLibColour *) FirstSelected; // Set the colour's name to the same as the library item String_256 Buffer; LibCol->GetNameText(&Buffer); NewCol->SetName(Buffer); // If it's a spot colour, make it so if (LibCol->IsASpotColour()) NewCol->SetLinkedParent(NULL, COLOURTYPE_SPOT); // Copy the colour into the destination document (merging it with existing // colours so we won't keep creating new copies of the same colour as it's applied) ColourToApply.MakeRefToIndexedColour(NewCol); ColourManager::EnsureColourIsInDocument(NULL, Document::GetSelected(), &ColourToApply); // And delete the temporary IndexedColour we used delete NewCol; NewCol = NULL; } } if (ColourToApply.FindParentIndexedColour() != NULL) { // We've got a colour to apply, so apply it NodeAttribute *Attrib; if (Adjust) { // Adjust-ed, so set the line colour Attrib = new AttrStrokeColourChange; if (Attrib == NULL) { InformError(); return(FALSE); } ((AttrStrokeColourChange *)Attrib)->SetStartColour(&ColourToApply); } else { // Select-ed so set the fill colour Attrib = new AttrColourChange; if (Attrib == NULL) { InformError(); return(FALSE); } ((AttrColourChange *)Attrib)->SetStartColour(&ColourToApply); } // AttributeSelected knows what to do with a selected attribute AttributeManager::AttributeSelected(NULL, Attrib); } } break; case SGACTION_REDEFINE: if (SelectedColour != NULL && TheColour != NULL) { // First, try to find an interesting colour to redefine from DocColour SourceColour; ColourList *SrcColList; ColourManager::FindColourOfInterestToUser(&SourceColour, &SrcColList); if (SourceColour.FindParentIndexedColour() == SelectedColour) { // You can't redefine a colour from itself! Don't be daft! InformError(_R(IDE_COLGAL_SAMEITEM)); return(FALSE); } // Copy the colour IndexedColour *NewCol = new IndexedColour(SourceColour); if (NewCol == NULL) return(FALSE); if (SrcColList != ColList || NewCol->IsADescendantOf(SelectedColour)) { // We're redefining from a colour in a different document, or attempting to make a // recursive parent-pointer loop. Remove the parent linkage to make NewCol a standalone // copy of its previous parent. NewCol->SetLinkedParent(NULL, (NewCol->GetType() == COLOURTYPE_SPOT) ? COLOURTYPE_SPOT : COLOURTYPE_NORMAL); } // Compose a new, unique, name for it - e.g. "Red (Redefined)" String_128 NewName(_R(IDS_UNNAMEDCOLOUR)); if (SelectedColour->IsNamed()) NewName.MakeMsg(_R(IDS_REDEFINEDCOLOUR), (TCHAR *) (*(SelectedColour->GetName())) ); // Ensure the new name is unique within the destination colour list String_64 UniqueNewName; ColList->GenerateUniqueColourName(&NewName, &UniqueNewName); NewCol->SetName(UniqueNewName); // And finally, apply the colour change, with UNDO // (Note that NewCol is put into the undo system, so we must not delete it) return(ColourManager::ChangeColour(ColList, NewCol, SelectedColour)); } break; case SGACTION_EDIT: if (ScopeDoc != Document::GetSelected()) { // **** BODGE! TO DO !!!! // This should make the appropriate document selected by chucking its window to the front, and // then invoke the colour editor on the selected colour InformMessage(_R(IDS_COLGAL_NOTSELDOC), _R(IDS_CANCEL)); break; } // Always show the editor, and if there is a selection, edit the // first selected colour EditColour(ColList, SelectedColour); break; case SGACTION_DELETE: { while (DocumentGroup != NULL) { // For each document, if there are selected items in the document, then // delete them (after asking the user for each document) TODO : Clean up!!!! ScopeDoc = DocumentGroup->GetParentDocument(); if (ScopeDoc != NULL) { ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list? Now I've seen it all"); if (DocumentGroup->GetSelectedItemCount() > 0) { if (OKToDeleteSelection(DocumentGroup)) { if (!DeleteSelection(DocumentGroup, ColList)) return(FALSE); } } } DocumentGroup = (SGDisplayGroup *) DocumentGroup->GetNext(); } SelectionHasChanged(); } break; case SGACTION_SETOPTIONS: // Set values in the options/sort dialogue as it is opened if (CurrentOptionsDlg != NULL) { // Display Modes CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_SMALL)); // 0 CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_FULLINFO)); // 1 CurrentOptionsDlg->AddDisplayModeName(_R(IDS_GALLERYDM_ICONONLY)); // 2 } break; case SGACTION_SETSORTMODE: if (CurrentSortDlg != NULL) { // Sort Modes (0 = none) CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_NAME)); // 1 (sort by name) CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_HUE)); // 2 CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_INTENSITY)); // 3 CurrentSortDlg->AddSortKeyName(_R(IDS_SORTBY_MODEL)); // 4 } break; case SGACTION_DISPLAYMODECHANGED: // Ensure that the display mode is one of the supported values if (DisplayMode < 0 || DisplayMode > 2) DisplayMode = 0; break; default: return(FALSE); } return(TRUE); }

BOOL ColourSGallery::ApplySelectedAsBackground (   )

Takes the selected item in the gallery and tries to apply this as a new background to the spread. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: True if worked correctly, False otherwise. Definition at line 4507 of file sgcolour.cpp. { SGDisplayColour *pFirstSelected = (SGDisplayColour *)DisplayTree->FindNextSelectedItem(NULL); if (pFirstSelected != NULL) { // Use the first selected colour and ask a page background to be made // using this. TRACEUSER( "NEVILLE", _T("SGCmd_SetBackground")); Document * pScopeDoc = NULL; DocColour ColourToApply; BOOL ok = GetDocColourToApply(pFirstSelected, &ColourToApply, &pScopeDoc); // Only apply if we found a valid document and the colour was ok if (ok && pScopeDoc) { OpBackgroundParam Param; Param.pDocColour = &ColourToApply; Param.pDoc = pScopeDoc; // Obtain a pointer to the op descriptor for the create operation OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_BACKGROUND); // Invoke the operation, passing DocView and Pos as parameters pOpDesc->Invoke(&Param); return TRUE; } return FALSE; } return FALSE; }

BOOL ColourSGallery::BuildCommandMenu (  GalleryContextMenu *  TheMenu, SGMenuID  MenuID )  [virtual]

To build a menu of commands to be popped up over the gallery. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: TheMenu  - The menu to add commands to [INPUTS] MenuID - The type of menu (over-list or from-options-button) to create Returns: TRUE if it succeeded Notes: Override this method to stop the default menus being built Reimplemented from SuperGallery. Definition at line 4253 of file sgcolour.cpp. { BOOL ok = TRUE; // Edits to the pop-up menu on the colour gallery if (MenuID == SGMENU_OPTIONS) { // Options menu ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Find); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Sort); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Properties); } else { // Over-list menu ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_New); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Edit); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Delete); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Redefine); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Rename, TRUE); // With separator SGDisplayGroup *TheGroup = FindCommandGroup(); // Fold or unfold as appropriate if (TheGroup == NULL || !TheGroup->Flags.Folded) ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_FoldGroup); else ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_UnfoldGroup); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_PrevGroup); // add 'Show in colour line' menu item in Camelot ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_NextGroup, TRUE); // With separator ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_ShowInColourLine); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_SetBackground); } return(ok); }

BOOL ColourSGallery::CanAddColourToGallery (  IndexedColour *  pCol, ColourList *  pColList )  [static]

Central point where it decides whether the colour should be displayed in the gallery. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 5/12/96 Parameters: pCol  = ptr to the index colour in question [INPUTS] pColList = ptr to the Colour List for the document Returns: TRUE if the colour should be displayed in the gallery FALSE otherwise Added for WEBSTER Definition at line 2619 of file sgcolour.cpp. { ERROR2IF(pCol == NULL,FALSE,"NULL colour ptr"); ERROR2IF(pColList == NULL,FALSE,"NULL colour list ptr"); //#ifndef WEBSTER return (!pCol->IsDeleted() && pCol->IsNamed()); // v1.5 implementation //#else // if (!pCol->IsDeleted() && pCol->IsNamed()) // { // if (pCol->HasLinkedChildren() && pCol->FindLinkedParent() == NULL) // { // // OK, the colour has a child yet no parent, so it must be a top-level parent colour? // // Well, not quite. // // // // If the colour editor has been opened, it may have created an editing colour // // and linked it to one of the colours in the colour list *just in case* you wish to link // // it to another colour // // // // This linking is done so that it can make an intelligent choice on which colour you wish // // to link to. // // // // The following loop checks to see if there is another *real* colour (i.e. one in the document) // // that is linked to this colour // // IndexedColour *pColInList = (IndexedColour *) pColList->GetUndeletedHead(); // while (pColInList != NULL) // { // if (pColInList != pCol && pColInList->IsADescendantOf(pCol)) // return TRUE; // // pColInList = pColList->GetUndeletedNext(pColInList); // } // } // } // // return FALSE; //#endif // WEBSTER }

SGDisplayItem * ColourSGallery::CopyDisplayItem (  SGDisplayItem *  SourceItem, SGDisplayGroup *  DestGroup, SGDisplayItem *  TargetPosition = NULL )  [virtual]

"Copies" the existing node in the tree in an appropriate fashion. Parameters: SourceItem  - The item to copy elsewhere in the tree (see below) [INPUTS] DestGroup - The group into which the item should be inserted TargetPosition - NULL (to insert at the end of the sibling list), or points to an item BEFORE which SourceItem will be copied. Returns: NULL (failed) or a pointer to the new (copied) display item This method is normally called when a gallery-organising drag completes, and it is discovered that the dragged item(s) have been dragged to a different display group. Notes: This derived class override copies colours between documents. Currently, this just errors to the user, as copying between docs is not possible, due to undo going into the selected doc. **** !!!! See also: ColourSGallery::InsertCopiedItem; SGDisplayItem::MoveBefore; SGDisplayItem::MoveAfter; SGColour::CopyDisplayItem Reimplemented from SuperGallery. Definition at line 3923 of file sgcolour.cpp. { ERROR3IF(SourceItem == NULL || DestGroup == NULL, "Illegal NULL param"); if (DestGroup->Flags.ReadOnly) { ERROR2RAW("Trying to copy a colour into a read-only (library) group"); InformError(); return(NULL); // Sanity check - disallow copy into a library group! } Document *DestDoc = DestGroup->GetParentDocument(); if (DestDoc == NULL) { ERROR2RAW("No dest doc?!"); InformError(); return(NULL); } // Normal colour drag between 2 documents DocColour *DocColToCopy = ((SGDisplayColour *) SourceItem)->GetDisplayedColour(); ERROR3IF(DocColToCopy == NULL, "NULL displayed colour?!"); IndexedColour *ColToCopy = NULL; BOOL ColIsTemporary = FALSE; if (((SGDisplayColour *) SourceItem)->IsALibraryColour()) { // The dragged item is not resident in any document - it's in a library // Create a temporary IndexedColour to be copied into the doc ColToCopy = new IndexedColour(*DocColToCopy); ColIsTemporary = TRUE; if (ColToCopy != NULL) { // Set the colour's name to the same as the library item String_256 Buffer; ((SGDisplayLibColour *) SourceItem)->GetNameText(&Buffer); ColToCopy->SetName(Buffer); if (((SGDisplayLibColour *) SourceItem)->IsASpotColour()) ColToCopy->SetLinkedParent(NULL, COLOURTYPE_SPOT); } else { ERROR3("No memory for copied colour"); } } else { ColToCopy = DocColToCopy->FindParentIndexedColour(); ERROR3IF(ColToCopy == NULL, "NULL displayed colour?!"); } if (ColToCopy == NULL) return(NULL); // If we haven't already started a component copy, set one up if (CurrentColComp == NULL) { CurrentColComp = (ColourListComponent *) DestDoc->GetDocComponent(CC_RUNTIME_CLASS(ColourListComponent)); if (CurrentColComp == NULL) { if (ColIsTemporary) delete ColToCopy; ERROR2RAW("Couldn't find a colour list component for the destination document!"); InformError(); return(NULL); } if (!CurrentColComp->StartComponentCopy()) // If this fails, it reports the error itself { if (ColIsTemporary) delete ColToCopy; return(NULL); } CurrentTarget = TargetPosition; } // Create a new display item, referencing the colour to be copied SGDisplayColour *NewDisplayItem = new SGDisplayColour(ColToCopy); if (NewDisplayItem == NULL) { if (ColIsTemporary) delete ColToCopy; InformError(); return(NULL); } // Remap the display item to reference a safe colour for the destination document // NOTE that we use a special TRUE flag here to indicate that we know the colour // is always unique - this stops the ColComp from caching a pointer to our temporary // colour (which then is reallocated for the next colour, which then causes // all the colour mapping to get very very confused). if (CurrentColComp->CopyColourAcross(NewDisplayItem->GetDisplayedColour(), TRUE) != CCCOPY_NEWCOLOUR) { // Either the copy failed (we have no colour to display), or it was merged with // an existing colour (in which case there will already be a display item for it) delete NewDisplayItem; if (ColIsTemporary) delete ColToCopy; return(NULL); } SuperGallery::InsertCopiedItem(NewDisplayItem, DestGroup, TargetPosition); // If we copied a library item, then delete the temporary IndexedColour we created if (ColIsTemporary) { delete ColToCopy; ColToCopy = NULL; } // And update the item selection states, so that the copied item is the selected one // We poke directly at the selected flag to avoid it trying to redraw itself when we know // it hasn't had a chance to format itself yet. // SourceItem->SetSelected(FALSE); // NewDisplayItem->Flags.Selected = TRUE; return(NewDisplayItem); }

void ColourSGallery::CreateNewSubtree (  Document *  ParentDoc, SGDisplayColourGroup *  ExistingGroup = NULL )  [protected]

Internal call. This takes the colour list of the given document and creates a DisplayTree subtree from it. This subtree is then added to the DisplayTree. Note that this does not force a redraw of the list - after making this call, you should also call ForceRedrawOfList. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/10/94 Parameters: ParentDoc  - The document to create a display subtree for [INPUTS] ExistingGroup - NULL (creates a new group for this document), or a pointer to the existing group-node for this document (in which case it clears all displayitems from the group and rebuilds it in place - this stops the display group moving around the tree at random!) Notes: Passing in a NULL parent document pointer results in an ERROR3 - the function returns without doing anything in retail builds It now scans the existinggroup (if any), and takes no action if it exactly matches the parent colour list. See also: SuperGallery::ForceRedrawOfList Definition at line 2498 of file sgcolour.cpp. { ERROR3IF(ParentDoc == NULL, "ColourSGallery::CreateNewSubtree - illegal NULL parameter"); if (ParentDoc == NULL || DisplayTree == NULL) return; // Don't add subtrees for clipboards! if (ParentDoc->IsAClipboard() || ParentDoc->IsAHiddenDoc()) return; SGDisplayColourGroup *DisplayDocument = NULL; SGDisplayColour *DisplayColour = NULL; if (ExistingGroup != NULL) { ERROR3IF(ExistingGroup->GetParentDocument() != ParentDoc, "This group is not for that document! What's going down, dude?"); DisplayDocument = ExistingGroup; // Use existing group // Scan the ExistingGroup, to see if we really need to do anything BOOL DisplayCorrect = TRUE; ColourList *ColList = ParentDoc->GetIndexedColours(); IndexedColour *TheCol = ColList->GetUndeletedHead(); DisplayColour = (SGDisplayColour *) DisplayDocument->GetChild(); while (TheCol != NULL && DisplayColour != NULL && DisplayCorrect) { if (TheCol != DisplayColour->GetDisplayedColour()->FindParentIndexedColour()) DisplayCorrect = FALSE; TheCol = ColList->GetUndeletedNext(TheCol); DisplayColour = (SGDisplayColour *) DisplayColour->GetNext(); } if (DisplayCorrect && TheCol == NULL && DisplayColour == NULL) { // The display is exactly right- we don't need to do anything return; } DisplayDocument->DestroySubtree(FALSE); // Wipe any existing colour display items } else { DisplayDocument = new SGDisplayColourGroup(this, ParentDoc, NULL);// Create new Group if (DisplayDocument == NULL) // Total failure - abort { InformError(); return; } DisplayDocument->Flags.CanSelect = TRUE; // Group is selectable // Make sure that any library groups stay at the bottom of the gallery SGDisplayNode *InsertionPos = DisplayTree->GetChild(); while (InsertionPos != NULL) { if (InsertionPos->IsKindOf(CC_RUNTIME_CLASS(SGDisplayLibColGroup))) break; InsertionPos = InsertionPos->GetNext(); } // And add the group to the tree if (InsertionPos != NULL) InsertionPos->InsertBefore(DisplayDocument); // Insert in front of libraries else DisplayTree->AddItem(DisplayDocument); // No libraries - just AddTail // And ensure it is folded/unfolded as appropriate (but don't bother redrawing) DisplayDocument->SetFoldedState((ParentDoc != Document::GetSelected()), FALSE); } ColourList *ColList = ParentDoc->GetIndexedColours(); IndexedColour *CurColour = (ColList == N