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 == NULL) ? NULL : (IndexedColour *) ColList->GetHead(); while (CurColour != NULL) // For each colour in the doc... { // if (!CurColour->IsDeleted() && CurColour->IsNamed()) // If alive & named... // WEBSTER - markn 5/12/96 // New func that decides weather the colour should be added to the gallery // called CanAddColourToGallery() if (CanAddColourToGallery(CurColour,ColList)) // If alive & named... { DisplayColour = new SGDisplayColour(CurColour); if (DisplayColour == NULL) { InformError(); return; } DisplayDocument->AddItem(DisplayColour); // Create & add item for it } CurColour = (IndexedColour *) ColList->GetNext(CurColour); // Next colour } }

RenderRegion * ColourSGallery::CreateRenderRegion (  DocRect *  VirtualSize, ReDrawInfoType *  DlgRedrawInfo )  [protected, virtual]

An overridable veneer to the DialogOp CreateOSRenderRegion method. This can be overriden to use a different type of renderregion for all of your rendering. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 If you override this, you MUST also override DestroyRenderRegion! Notes: This ovverrides the base class to do the same thing, but to make our RenderRegion use colour correction/separation options from the selected view, so that we display "document colours" correctly for the selview. See also: ColourSGallery::DestroyRenderRegion Reimplemented from SuperGallery. Definition at line 4142 of file sgcolour.cpp. { return(CreateOSRenderRegion(VirtualSize, DlgRedrawInfo, TRUE)); }

BOOL ColourSGallery::DeleteSelection (  SGDisplayGroup *  DocumentGroup, ColourList *  ParentList )  [protected]

Forcibly deletes all selected colours Should be used after OKToDeleteSelection (which confirms the action). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/1/95 Parameters: DocumentGroup  - The subtree in which the selection lies [INPUTS] This is expected to be the subtree for the selected document ParentList - The ColourList in which all these colours reside Returns: TRUE to indicate successful handling of the action, or FALSE to indicate failure See also: ColourSGallery::OKToDeleteSelection Definition at line 3010 of file sgcolour.cpp. { if (ParentList == NULL) return(TRUE); INT32 TotalItems = DocumentGroup->GetSelectedItemCount(); if (TotalItems == 0) return(TRUE); IndexedColour **KillList = new IndexedColourPtr[TotalItems+1]; if (KillList == NULL) return(FALSE); DWORD KillIndex = 0; SGDisplayColour *Item = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(NULL); SGDisplayColour *NextItem; IndexedColour *RefColour; while (Item != NULL) { // Remember the NextItem item, cos we're about to delink/destroy this one NextItem = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(Item); RefColour = Item->GetDisplayedColour()->FindParentIndexedColour(); if (RefColour != NULL) { // Add the colour to the kill list KillList[KillIndex++] = RefColour; // Annihilate this item, so that it no longer references the IndexedColour Item->DestroySubtree(); } // And move on to the NextItem item Item = NextItem; } KillList[KillIndex] = NULL; // NULL terminate the list // Now cause a redraw of the tree in its new state, before the message broadcast goes around InvalidateCachedFormat(); ReformatAndRedrawIfNecessary(); // Delete (hide, with undo actually) the given colours // Our message handler will cope with redrawing the new list (we must do it this // way in case the deletion causes other changes to the list, e.g. a new 'black' // being created if we delete the default one) ColourManager::HideColours(ParentList, KillList, TRUE); // HideColours has made a copy of this list for itself, so we are responsible // for deleting our original list delete [] KillList; return(TRUE); }

void ColourSGallery::DestroyRenderRegion (  RenderRegion *  pRender  )  [protected, virtual]

An overridable veneer to the DialogOp DestroyOSRenderRegion method. This can be overriden to use a different type of renderregion for all of your rendering. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 23/5/96 If you override this, you MUST also override CreateRenderRegion! See also: ColourSGallery::CreateRenderRegion Reimplemented from SuperGallery. Definition at line 4166 of file sgcolour.cpp. { DestroyOSRenderRegion(pRender); }

void ColourSGallery::DoCommand (  StringBase *  CommandID  )  [virtual]

To apply a given command when it is chosen from the menu. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: CommandID  - The String ID of the command [INPUTS] Notes: Override this method to provide handling for your special commands. Call the base class if you don't recognise the command, so that it can handle standard commands. The base class handles all of these (maybe more - see the base class help) Properties, Sort, Find; New, Edit, Delete, Redefine; (it calls ApplyAction as appropriate) NextGroup, PrevGroup, FoldGroup, UnfoldGroup; Reimplemented from SuperGallery. Definition at line 4441 of file sgcolour.cpp. { if (*CommandID == SGCmd_Rename) { SGDisplayColour *FirstSelected = (SGDisplayColour *) // Invoke name-colour dialogue DisplayTree->FindNextSelectedItem(NULL); if (FirstSelected != NULL && !FirstSelected->IsALibraryColour()) { IndexedColour *ColToEdit = FirstSelected->GetDisplayedColour()-> FindParentIndexedColour(); SGDisplayGroup *DocumentGroup = (SGDisplayGroup *) FirstSelected->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 *ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list? Now I've seen it all"); if (ColToEdit != NULL) ColourNameDlg::InvokeDialog(ColList, ColToEdit); } } else if (*CommandID == SGCmd_ShowInColourLine) // Toggle the show in colour line state { SGDisplayColour *pFirstSelected = (SGDisplayColour *)DisplayTree->FindNextSelectedItem(NULL); SGDisplayColourGroup *pGroup = (SGDisplayColourGroup *) DisplayTree->FindNextSelectedGroup(NULL); if (pGroup == NULL && pFirstSelected != NULL) { pGroup = (SGDisplayColourGroup *) pFirstSelected->GetParent(); } if (pGroup) { //SGDisplayLibColGroup * pLibGroup = (SGDisplayColourGroup*) pGroup; // We have a group item selected so use it // Only do this on library colour groups at present pGroup->ToggleDisplayInColourLine(); // Ensure any colours libraries that are now required are loaded // This should also send a message to the colour line to force an update CColourBar::EnsureLibraryColoursPresent(); } } else if (*CommandID == SGCmd_SetBackground) // Set the page background colour { ApplySelectedAsBackground(); } else SuperGallery::DoCommand(CommandID); // Unknown command- pass to the base class }

void ColourSGallery::DoShadeGallery (  BOOL  ShadeIt  )  [protected, virtual]

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. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 4/7/97 Parameters: ShadeIt  - TRUE if the gallery is being shaded [INPUTS] FALSE if the gallery is being unshaded Notes: Need not be overridden - the default action is to do nothing extra to the normal shade/unshade operation. See also: Gallery::ShadeGallery; Gallery::UnshadeGallery Reimplemented from SuperGallery. Definition at line 4713 of file sgcolour.cpp. { // Shade any non-standard buttons that we have on the gallery EnableGadget(_R(IDC_COLGAL_BACKGROUND), !ShadeIt); }

void ColourSGallery::EditColour (  ColourList *  ParentList, IndexedColour *  TheColour )  [protected]

Opens the colour editor, and sets it to edit the given colour. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/1/95 Parameters: ParentList  - The ColourList in which the given colour resides [INPUTS] TheColour - the colour to edit, or NULL to just open the editor See also: ColourPicker Definition at line 2876 of file sgcolour.cpp. { ColourPicker ColPicker; ColPicker.EditColour(ParentList, TheColour); }

OpState ColourSGallery::GetCommandState (  StringBase *  CommandID, String_256 *  ShadeReason )  [virtual]

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). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: CommandID  - TheString ID of the command [INPUTS] ShadeReason  - If you return (OpState.Greyed == TRUE) then this should be filled [OUTPUTS] ion with the reason that the item is shaded/greyed. Returns: An OpState indicating the current menu item state. Notes: Override this method to provide state info for your special commands Call the base class for unknown commands to allow it to handle them for you The base class handles all of these (maybe more - see the base class help) Properties, Sort, Find; New, Edit, Delete, Redefine; NextGroup, PrevGroup, FoldGroup, UnfoldGroup; Reimplemented from SuperGallery. Definition at line 4320 of file sgcolour.cpp. { OpState State; if (AmShaded) // No commands available while the gallery is shaded { State.Greyed = TRUE; return(State); } // Determine if the entire selection consists only of library colours... BOOL AllSelectionIsLibrary = TRUE; SGDisplayColour *Col = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(NULL); SGDisplayColour *pSelectedItem = Col; if (Col == NULL) AllSelectionIsLibrary = FALSE; while (Col != NULL) { if (!Col->IsALibraryColour()) AllSelectionIsLibrary = FALSE; Col = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(Col); } // determine the command state... if (*CommandID == SGCmd_New) // --- New { if (GetSelectedItemCount() > 1) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_SGSHADE_SINGLE)); } } else if (*CommandID == SGCmd_Rename) // --- Rename { if (GetSelectedItemCount() != 1) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_SGSHADE_SINGLECOL)); } else if (AllSelectionIsLibrary) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_ITSALIBRARYCOLOUR)); } } else if (*CommandID == SGCmd_Edit || // --- Edit, Redefine, Delete *CommandID == SGCmd_Redefine || *CommandID == SGCmd_Delete) { // Make sure we disallow these options when the selection is a library colour if (AllSelectionIsLibrary) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_ITSALIBRARYCOLOUR)); } else return(SuperGallery::GetCommandState(CommandID, ShadeReason)); } else if (*CommandID == SGCmd_ShowInColourLine) { // Make sure we only allow these options when the selection is a library colour SGDisplayColourGroup *pGroup = (SGDisplayColourGroup *) DisplayTree->FindNextSelectedGroup(NULL); if (pGroup == NULL && pSelectedItem != NULL) { pGroup = (SGDisplayColourGroup *) pSelectedItem->GetParent(); } if (pGroup) { // We have a group item selected so use it // Only do this on library colour groups at present //SGDisplayLibColGroup * pLibGroup = (SGDisplayLibColGroup*) pGroup; State.Ticked = pGroup->DisplayInColourLine(); } else { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_ITSNOTALIBRARYCOLOUR)); } } else if (*CommandID == SGCmd_SetBackground) // Set the page background colour { // Ensure we have a single selected colour and a selected document Document * pDoc = Document::GetSelected(); if (pSelectedItem == NULL || pDoc == NULL) { State.Greyed = TRUE; ShadeReason->MakeMsg(_R(IDS_SGSHADE_SINGLECOL)); } } else return(SuperGallery::GetCommandState(CommandID, ShadeReason)); // Unknown command- pass to baseclass return(State); }

SGDisplayLibColGroup* ColourSGallery::GetCurrentImportGroup (  void   )  [inline]

Definition at line 536 of file sgcolour.h. { return(CurrentImportGroup); };

BOOL ColourSGallery::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. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 27/3/97 Parameters: pFirstSelected  selected item in the gallery [INPUTS] pColourToApply the DocColour which needs setting up ppDoc  the document which we need to apply the colour to [OUTPUTS] Returns: True if worked ok, False otherwise. Definition at line 4561 of file sgcolour.cpp. { ERROR2IF(pFirstSelected == NULL || pColourToApply == NULL || pDoc == NULL,FALSE,"GetDocColourToApply bad params!"); // Try to get the parent item of the selected item and ask it for the associated document SGDisplayGroup * DocumentGroup = (SGDisplayGroup *) pFirstSelected->GetParent(); ERROR3IF(DocumentGroup == NULL, "SGallery DisplayTree linkage corruption detected"); Document * pScopeDoc = DocumentGroup->GetParentDocument(); if (pScopeDoc == NULL) // Must be a library item, so it will affect the selected doc pScopeDoc = Document::GetSelected(); // Return this to the caller *pDoc = pScopeDoc; // If we have no document to work with then nothing doing if (pScopeDoc == NULL) { ERROR3("No scope document for colour gallery operation!"); return FALSE; } DocColour * pTheColour = pFirstSelected->GetDisplayedColour(); ERROR3IF(pTheColour == NULL, "SGDisplayColour has no colour in it?"); IndexedColour *pSelectedColour = pTheColour->FindParentIndexedColour(); // Check that we have a minimal ensemble of required items if (pTheColour != NULL && (pSelectedColour != NULL || pFirstSelected->IsALibraryColour())) { if (!pFirstSelected->IsALibraryColour()) { // Normal IndexedColour item - just apply it pColourToApply->MakeRefToIndexedColour(pSelectedColour); // 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(pScopeDoc, Document::GetSelected(), pColourToApply); } 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 *pNewCol = new IndexedColour(*pTheColour); if (pNewCol != NULL) { SGDisplayLibColour *pLibCol = (SGDisplayLibColour *) pFirstSelected; // Set the colour's name to the same as the library item String_256 Buffer; pLibCol->GetNameText(&Buffer); pNewCol->SetName(Buffer); // If it's a spot colour, make it so if (pLibCol->IsASpotColour()) pNewCol->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) pColourToApply->MakeRefToIndexedColour(pNewCol); ColourManager::EnsureColourIsInDocument(NULL, Document::GetSelected(), pColourToApply); // And delete the temporary IndexedColour we used delete pNewCol; pNewCol = NULL; } } return TRUE; } // something was a bit squiffy return FALSE; }

SGDisplayLibColGroup * ColourSGallery::GetFirstLibGroup (   )

Gets the first colour library group node in the colour gallery. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 19/3/97 Parameters: -  [INPUTS] Returns: NULL or pointer to the next LibGroup in the list. Definition at line 2811 of file sgcolour.cpp. { return GetNextLibGroup(NULL); }

ColourSGallery * ColourSGallery::GetInstance (   )  [static]

Public access function to the colour gallery. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 19/3/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the program's colour gallery if it exists, or NULL. Errors: - See also: - Definition at line 2464 of file sgcolour.cpp. { return m_pTheGallery; }

SGDisplayLibColGroup * ColourSGallery::GetNextLibGroup (  SGDisplayLibColGroup *  pLibGroup  )

Gets the next colour library group node in the colour gallery. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 19/3/97 Parameters: -  [INPUTS] Returns: NULL or pointer to the next LibGroup in the list. Definition at line 2828 of file sgcolour.cpp. { SGDisplayNode *pGroup = NULL; // If we are passed a null pointer then somebody must want the first item in the list if (pLibGroup == NULL) { if (DisplayTree == NULL) return NULL; // Find the first library groups in the gallery pGroup = DisplayTree->GetChild(); } else pGroup = pLibGroup->GetNext(); while (pGroup != NULL) { if (pGroup->IsKindOf(CC_RUNTIME_CLASS(SGDisplayLibColGroup))) { return (SGDisplayLibColGroup*)pGroup; } pGroup = pGroup->GetNext(); } // none found return NULL; }

void ColourSGallery::HandleDragStart (  DragMessage *  DragMsg  )  [protected, virtual]

Checks a DragMessage to see if it is a colour drag. If it is, then it creates a drag target for this gallerys listbox. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/3/95 Parameters: DragMsg  - The DRAGSTARTED message that we've just recieved, indicating [INPUTS] the type of drag being started Notes: Overrides the default base-class action. Calls down to the base class if it is not a colour drag, so that dragging of gallery groups is allowed Reimplemented from SuperGallery. Definition at line 3876 of file sgcolour.cpp. { // If it's a colour drag, add a target for our window. If not, let the base class // have a look at it (to see if it is a group being dragged) if (DragMsg->pInfo->IsKindOf(CC_RUNTIME_CLASS(ColourDragInformation))) { /*SGColourDragTarget *NewTarget =*/ new SGColourDragTarget(this, GetListGadgetID()); } else SuperGallery::HandleDragStart(DragMsg); }

BOOL ColourSGallery::Init (  void   )  [static]

ColourSGallery initialisation - declares preferences etc. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/3/95 Reimplemented from SimpleCCObject. Definition at line 2431 of file sgcolour.cpp. { // Declare preferences GetApplication()->DeclareSection(TEXT("Displays"), 8); GetApplication()->DeclarePref(TEXT("Displays"), TEXT("AutoScrollColours"), &AutoScrollSelection); GetApplication()->DeclarePref(TEXT("Displays"), TEXT("ColourDisplayMode"), &DefaultDisplayMode); GetApplication()->DeclareSection(TEXT("ColourLine"), 4); GetApplication()->DeclarePref(TEXT("ColourLine"), TEXT("ShowDocumentColours"), &ShowDocumentColours); GetApplication()->DeclareSection(TEXT("Palettes"), 2); GetApplication()->DeclarePref(TEXT("Palettes"), TEXT("Path"), &PalettePath); OpBackground::Init(); return(TRUE); }

BOOL ColourSGallery::InitMenuCommands (  void   )  [virtual]

Initialises any menu commands that this gallery needs. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/9/95 Returns: TRUE for success Notes: Will only create the menu commands once - further calls in the future will return TRUE immediately wihtout doing anything. Reimplemented from SuperGallery. Definition at line 4192 of file sgcolour.cpp. { static BOOL MenusInitialised = FALSE; BOOL ok = TRUE; if (!MenusInitialised) { // Edits to the pop-up menu on the colour gallery // Initialise menu command Ops // "Standard" entries for options menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_Find, _R(IDS_SGMENU_FIND)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Sort, _R(IDS_SGMENU_SORT)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Properties, _R(IDS_SGMENU_PROPERTIES)); // "Special" entries for over-list menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_New, _R(IDS_SGMENU_NEW)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Edit, _R(IDS_SGMENU_EDIT)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Delete, _R(IDS_SGMENU_DELETE)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Redefine, _R(IDS_SGMENU_REDEFINE)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_Rename, _R(IDS_SGMENU_RENAME)); // "Standard" commands for over-list menu ok = ok && InitMenuCommand((StringBase *) &SGCmd_FoldGroup, _R(IDS_SGMENU_FOLD)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_UnfoldGroup, _R(IDS_SGMENU_UNFOLD)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_NextGroup, _R(IDS_SGMENU_NEXTGROUP)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_PrevGroup, _R(IDS_SGMENU_PREVGROUP)); // Extra new group item ok = ok && InitMenuCommand((StringBase *) &SGCmd_ShowInColourLine, _R(IDS_SGMENU_SHOWINCOLOURLINE)); ok = ok && InitMenuCommand((StringBase *) &SGCmd_SetBackground, _R(IDS_SGMENU_SETBACKGROUND)); MenusInitialised = TRUE; } return(ok); }

BOOL ColourSGallery::MakeSureGroupsHaveBeenCreated (   )

This will create the gallery groups (unless they're already there) and return TRUE if ok. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 19/3/97 Parameters: -  [INPUTS] Returns: True if everything went ok, False otherwise. Definition at line 2787 of file sgcolour.cpp. { // We will use the DisplayTree presence or absence to dictate whether the groups are // there or not. If it is there just return TRUE as everything should be fabby. if (DisplayTree != NULL) return TRUE; // If not then just call PreCreate to ensure that they are present. return PreCreate(); }

MsgResult ColourSGallery::Message (  Msg *  Message  )  [virtual]

A standard message handler, really. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 31/10/94 Parameters: Message  - The message to handle [INPUTS] Notes: Any messages that this does not handle must be passed down to the SuperGallery base class message handler. See also: SuperGallery::Message Reimplemented from SuperGallery. Definition at line 3654 of file sgcolour.cpp. { if (IS_OUR_DIALOG_MSG(Message)) { DialogMsg* Msg = (DialogMsg*)Message; switch (Msg->DlgMsg) { case DIM_CREATE: SGInit::UpdateGalleryButton(_R(OPTOKEN_DISPLAYCOLOURGALLERY), TRUE); SetSelectionFromDocument(TRUE); break; case DIM_CANCEL: SGInit::UpdateGalleryButton(_R(OPTOKEN_DISPLAYCOLOURGALLERY), FALSE); break; case DIM_LFT_BN_CLICKED: if (DisplayTree == NULL || !IsVisible()) break; if (FALSE) {} else if (Msg->GadgetID == _R(IDC_GALLERY_NAME)) { SGDisplayColour *FirstSelected = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(NULL); if (FirstSelected != NULL) { IndexedColour *ColToEdit = FirstSelected->GetDisplayedColour()-> FindParentIndexedColour(); SGDisplayGroup *DocumentGroup = (SGDisplayGroup *) FirstSelected->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 *ColList = ScopeDoc->GetIndexedColours(); ERROR3IF(ColList == NULL, "A document with no colour list? Now I've seen it all"); if (ColToEdit != NULL) ColourNameDlg::InvokeDialog(ColList, ColToEdit); } } else if (Msg->GadgetID == _R(IDC_GALLERY_HELP)) { TRACEUSER( "Markn", _T("Hello. Do you want help on this gallery?\n")); HelpUserTopic(_R(IDS_HELPPATH_Gallery_Colour)); } else if (Msg->GadgetID == _R(IDC_COLGAL_BACKGROUND)) // Set a background layer with the selected colour { ApplySelectedAsBackground(); } break; default: break; } return(SuperGallery::Message(Message)); } // If we have no displaytree, then we have not been shown, or something terrible has // happened, so we don't bother handling any of these messages. if (DisplayTree == NULL || !IsVisible()) return(SuperGallery::Message(Message)); if (MESSAGE_IS_A(Message, DocChangingMsg)) { DocChangingMsg *TheMsg = (DocChangingMsg *) Message; switch ( TheMsg->State ) { case DocChangingMsg::BORN: // New document - add to display tree { CreateNewSubtree(TheMsg->pChangingDoc); // Add a subtree for this doc ShadeGallery(FALSE); InvalidateCachedFormat(); // And redraw what is necessary ReformatAndRedrawIfNecessary(); } break; // Pass this message on to the base class as well // case DocChangingMsg::DocState::ABOUTTODIE: // Document dying - remove from tree // case DocChangingMsg::DocState::KILLED: // case DocChangingMsg::DocState::SELCHANGED: // // ==== NOTE ==== // The base sgallery class handles these messages to automatically remove // the subtree for the dying doc, and/or shade the gallery if no docs are left default: break; } } else if (MESSAGE_IS_A(Message, ColourChangingMsg)) { ColourChangingMsg *TheMsg = (ColourChangingMsg *) Message; switch (TheMsg->State) { case ColourChangingMsg::LISTUPDATED: // A document colour list has been changed. We must recreate its display subtree if (!ISentTheMessage && TheMsg->NewColourList != NULL) { // First, try to find the document which owns the changed list Document *ScopeDoc = (Document *)TheMsg->NewColourList->GetParentDocument(); // Just check that the bi-directional link is sane! ERROR3IF(ScopeDoc == NULL || ScopeDoc->GetIndexedColours() != TheMsg->NewColourList, "A Document colour list is somehow screwed up!"); // If we found it, recreate the display subtree for it if (ScopeDoc != NULL) { SGDisplayNode *Ptr = DisplayTree->FindSubtree(this, ScopeDoc, NULL); CreateNewSubtree(ScopeDoc, (SGDisplayColourGroup *) Ptr); // And force a redraw of the entire list //ForceRedrawOfList(); InvalidateCachedFormat(); ReformatAndRedrawIfNecessary(); } } break; case ColourChangingMsg::COLOURUPDATED: case ColourChangingMsg::COLOURUPDATEDINVISIBLE: if (TheMsg->NewColourList != NULL) { Document *ScopeDoc = (Document *)TheMsg->NewColourList->GetParentDocument(); RedrawColourDisplay(ScopeDoc, TheMsg->ChangedColour); } break; case ColourChangingMsg::SELVIEWCONTEXTCHANGE: // Colour separation/correction options for the selected view have // changed, so redraw the entire colour list using the new options. ForceRedrawOfList(); break; default: break; } } // The new CommonAttrsChanged msg replaces this messages. It handles // a change in the Current Attribute group associated with a tool, and a change in the // value of a current attribute. /*else if (MESSAGE_IS_A(Message, SelChangingMsg)) { SelChangingMsg *Msg = (SelChangingMsg *) Message; switch ( Msg->State ) { case SelChangingMsg::COLOURATTCHANGED: case SelChangingMsg::SELECTIONCHANGED: case SelChangingMsg::NODECHANGED: if (!AmShaded) // If we're open & active, set listbox selection SetSelectionFromDocument(); break; } // Drop through so the Gallery base class gets to see this message too } */ else if (MESSAGE_IS_A(Message, CommonAttrsChangedMsg)) { if (!AmShaded) // If we're open & active, set listbox selection SetSelectionFromDocument(); } else if (MESSAGE_IS_A(Message, DocViewMsg)) { DocViewMsg *Msg = (DocViewMsg *) Message; if (Msg->State == DocViewMsg::SELCHANGED) { // Selected DocView is changing - redraw to use the new DocView's colour context BOOL DoRedraw = TRUE; if (Msg->pOldDocView != NULL && Msg->pNewDocView != NULL) { // If we know the old & new views, then see if they have the same colour // context attached - if they do, there's no need to redraw. This eliminates // flicker when swapping normal views (the most common view-swap action) // We only check the RGB context because we assume the screen is always RGB ColourContext *OldCC = Msg->pOldDocView->GetColourContext(COLOURMODEL_RGBT, TRUE); ColourContext *NewCC = Msg->pNewDocView->GetColourContext(COLOURMODEL_RGBT, TRUE); if (OldCC == NewCC) DoRedraw = FALSE; } if (DoRedraw) ForceRedrawOfList(); } } return(SuperGallery::Message(Message)); }

BOOL ColourSGallery::OKToDeleteSelection (  SGDisplayGroup *  DocumentGroup  )  [protected]

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. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 18/1/95 Parameters: DocumentGroup  - The subtree in which the selection lies [INPUTS] This is expected to be the subtree for the selected document Returns: TRUE if it is OK to go ahead and delete, or FALSE if the delete action has been cancelled This checks with the user - they can either delete all colours, delete only those which are not 'in use', or cancel the delete. In the first case, this method does nothing (returns TRUE); in the second, it removes in-use colours from the selection and returns TRUE; in the third case, it does nothing, but returns FALSE. See also: ColourSGallery::DeleteSelection Definition at line 2910 of file sgcolour.cpp. { ERROR3IF(DocumentGroup == NULL, "Illegal NULL param"); SGDisplayColour *Item = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(NULL); IndexedColour *RefColour; INT32 ItemsInUse = 0; INT32 TotalItems = 0; INT32 DeletableItems = 0; Document *ParentDoc = DocumentGroup->GetParentDocument(); if (ParentDoc == NULL) return(FALSE); ColourList *ParentColList = ParentDoc->GetIndexedColours(); if (ParentColList == NULL) return(FALSE); // Determine how many items are selected, and how many of these are in use while (Item != NULL) { if (!Item->IsALibraryColour()) { DeletableItems++; // Increment number of deletable (non-library) items // Check if the colour is in use. NOTE that because it is used in this gallery // display item, it's usage count will be 1 greater than the 'real' usage // (i.e. when we delete it, the usage count will be decremented once, so // it is considered not-in-use if the usagcount is <= 1) RefColour = Item->GetDisplayedColour()->FindParentIndexedColour(); if (RefColour != NULL && ParentColList->IsColourInUseInDoc(RefColour, TRUE)) ItemsInUse++; } TotalItems++; // Increment number of found items Item = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(Item); } if (DeletableItems == 0) return(FALSE); // If some are in use, determine if the user really wants to delete them INT32 ButtonPressed = 2; if (ItemsInUse != 0) { ButtonPressed = AskQuestion(_R(IDS_COLGAL_COLINUSE), _R(IDS_COLGAL_KILL), _R(IDS_COLGAL_NOKILL), _R(IDS_CANCEL), 0, 2, 3); // NOKILL=default, CANCEL=cancel if (ButtonPressed == 3) // Delete was cancelled - return FALSE return(FALSE); } if (ButtonPressed == 1) // Force-delete all items, so go ahead and delete return(TRUE); if (ButtonPressed == 2 && DeletableItems - ItemsInUse <= 0) return(FALSE); // No items left to delete (all in use) so abort // Remove all in-use items from the selection so we only delete 'free' colours Item = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(NULL); while (Item != NULL) { RefColour = Item->GetDisplayedColour()->FindParentIndexedColour(); if (RefColour != NULL && ParentColList->IsColourInUseInDoc(RefColour, TRUE)) Item->SetSelected(FALSE); Item = (SGDisplayColour *) DocumentGroup->FindNextSelectedItem(Item); } return(TRUE); }

BOOL ColourSGallery::PreCreate (  void   )  [protected, virtual]

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. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/10/94 Returns: TRUE if the Gallery initialised successfully FALSE if it should not be opened due to a failure to initialise Reimplemented from SuperGallery. Definition at line 2676 of file sgcolour.cpp. { // If there isn't already one, create a DisplayTree if (DisplayTree == NULL) { DisplayTree = new SGDisplayRootScroll(this); // New root node, with a scrollbar if (DisplayTree == NULL) return(FALSE); } // We're opening the window, so we fold all groups except that for the Selected document SGDisplayGroup *Group = (SGDisplayGroup *) DisplayTree->GetChild(); while (Group != NULL) { // Set the group's folded state, but don't bother trying to redraw, because we know // that the window is not currently visible, and that we are doing this to multiple groups. Document *pDoc = Group->GetParentDocument(); if (pDoc != NULL) // Leave library groups alone Group->SetFoldedState((pDoc != Document::GetSelected()), FALSE); Group = (SGDisplayGroup *) Group->GetNext(); } // And for each document already present, (re)create a display subtree (possibly replacing // a previous displaytree for it if we had one earlier) Document *ParentDoc = (Document *) GetApplication()->Documents.GetTail(); while (ParentDoc != NULL) { SGDisplayColourGroup *ParentGroup = (SGDisplayColourGroup *)DisplayTree->FindSubtree(this, ParentDoc, NULL); CreateNewSubtree(ParentDoc, ParentGroup); ParentDoc = (Document *) GetApplication()->Documents.GetPrev(ParentDoc); } // Only add the library groups if they're not already in the gallery SGDisplayNode *Ptr = DisplayTree->GetChild(); while (Ptr != NULL) { if (Ptr->IsKindOf(CC_RUNTIME_CLASS(SGDisplayLibColGroup))) break; Ptr = Ptr->GetNext(); } PORTNOTE("other", "Colour gallery needs to use the resource system for finding palettes when no path is specified"); #ifndef EXCLUDE_FROM_XARALX if (Ptr == NULL) { SGDisplayLibColGroup *Bob; String_256 SearchPath; // If the user has set a pathname in the preference then use this, otherwise // use a Palettes directory which is sitting alongside the exe. if (PalettePath.IsEmpty()) { // Find the directory path of the .exe file CResDll::GetExecutablePath((TCHAR *) SearchPath); SearchPath += TEXT("\\Palettes\\"); // This is a fixed (non-internationalised) string } else { SearchPath = PalettePath; // Add a trailing slash if it hasn't got one SGLibOil::AppendSlashIfNotPresent(&SearchPath); } // Make up the search string to use so that we see all files. String_256 SearchSpec(SearchPath); SearchSpec += TEXT("*.*"); // This is a fixed (non-internationalised) string if (FileUtil::StartFindingFiles(&SearchSpec)) { String_256 LeafName; while (FileUtil::FindNextFile(&LeafName)) { String_256 FullPath = SearchPath; //FullPath += TEXT("\\Palettes\\"); FullPath += LeafName; PathName Name(FullPath); Bob = new SGDisplayLibColGroup(this, &Name); if (Bob != NULL) DisplayTree->AddItem(Bob); } FileUtil::StopFindingFiles(); } } #endif // Ensure we know we have to reformat before the next redraw InvalidateCachedFormat(); return(TRUE); }

void ColourSGallery::RedrawColourDisplay (  Document *  TheDocument, IndexedColour *  TheColour )  [protected]

Redraws the display item for one specific colour, and all of its linked descendants (liked/tint colours) (if any) in a given document. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 19/1/95 Parameters: TheDocument  - The document containing the colour [INPUTS] TheColour - The colour which needs to be re-displayed Notes: If the specified colo9ur is unnamed, nothing is done See also: SuperGallery::RedrawDocumentDisplay Definition at line 3483 of file sgcolour.cpp. { if (TheDocument == NULL || TheColour == NULL) return; SGDisplayGroup *Group = DisplayTree->FindSubtree(this, TheDocument, NULL); if (Group == NULL) // Can't find a group for this document return; // Now search the tree for the specific items to redraw SGDisplayColour *Item = (SGDisplayColour *) Group->GetChild(); // WEBSTER - markn 28/1/97 // This can be NULL in webster when you edit a non-editable colour (e.g. by double-clicking // on a colour in the web palette folder) // In Camelot it expects a colour to be added to the folder containing the doc's colours, // but for Webster that is not the case. It is now (mab) Martin 15/07/97 if (Item != NULL) { ERROR3IF(Item->GetChild() != NULL, "My leaf-item isn't a leaf-item! Help!"); IndexedColour *RealColour; while (Item != NULL) { RealColour = Item->GetDisplayedColour()->FindParentIndexedColour(); if (RealColour != NULL && RealColour->IsADescendantOf(TheColour)) Item->ForceRedrawOfMyself(); // Found it, or a descendant - redraw Item = (SGDisplayColour *) Item->GetNext(); } } }

void ColourSGallery::SelectionHasChanged (  void   )  [protected, virtual]

To inform the gallery that the selection has changed in some way. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/8/96 The colour gallery does the same as the base class, but also ensures that the selection includes some non-library items for some of the "editing" commands (edit, redefine, rename, delete) Reimplemented from SuperGallery. Definition at line 4654 of file sgcolour.cpp. { if (DisplayTree == NULL || AmShaded || !IsVisible()) return; INT32 Count = DisplayTree->GetSelectedItemCount(); // Determine if the entire selection consists only of library colours... BOOL AllSelectionIsLibrary = TRUE; SGDisplayColour *Col = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(NULL); if (Col == NULL) AllSelectionIsLibrary = FALSE; while (Col != NULL) { if (!Col->IsALibraryColour()) AllSelectionIsLibrary = FALSE; Col = (SGDisplayColour *) DisplayTree->FindNextSelectedItem(Col); } EnableGadget(_R(IDC_GALLERY_APPLY), (Count == 1)); // Apply needs exactly 1 item // Redefine, Edit, Name, all need exactly one item, and it cannot be a library item EnableGadget(_R(IDC_GALLERY_REDEFINE), (Count == 1 && !AllSelectionIsLibrary)); EnableGadget(_R(IDC_GALLERY_EDIT), (Count == 1 && !AllSelectionIsLibrary)); EnableGadget(_R(IDC_GALLERY_NAME), (Count == 1 && !AllSelectionIsLibrary)); EnableGadget(_R(IDC_GALLERY_NEW), (Count <= 1)); // New needs 0 or 1 items // Delete needs 1 or more items, and some of them must be document colours EnableGadget(_R(IDC_GALLERY_DELETE), (Count > 0 && !AllSelectionIsLibrary)); EnableGadget(_R(IDC_GALLERY_UNDO), TRUE); // Undo/menu always available EnableGadget(_R(IDC_GALLERY_MENU), TRUE); Document *pDoc = Document::GetSelected(); EnableGadget(_R(IDC_COLGAL_BACKGROUND), Count == 1 && pDoc != NULL); }

void ColourSGallery::SetCurrentImportGroup (  SGDisplayLibColGroup *  TheGroup  )  [inline]

Definition at line 535 of file sgcolour.h. { CurrentImportGroup = TheGroup; };

void ColourSGallery::SetSelectionFromDocument (  BOOL  AlwaysScroll = FALSE  )  [protected]

Sets the colour gallery listbox selection state based upon the currently selected object(s) in the document (to show the current fill/stroke colours). Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 20/2/95 (copied from old ColourGallery, previously created 11/10/94) Parameters: AlwaysScroll  - TRUE if you always want to autoscroll, regardless of the [INPUTS] preference setting. (This is used when opening the gallery, as there is no point in not auto-scrolling somewhere useful) Scope: private Definition at line 3538 of file sgcolour.cpp. { if (DisplayTree == NULL || !IsVisible()) return; DocColour *SelColour[2]; BOOL AreCurrentAttrs = ColourManager::GetCurrentLineAndFillColours(&SelColour[0], &SelColour[1]); SGDisplayGroup *DocGroup = NULL; if (Document::GetSelected() != NULL) DocGroup = DisplayTree->FindSubtree(this, Document::GetSelected(), NULL); SelectItems(FALSE); // Clear the current selection DocRect ScrollToRect; BOOL HaveSelected = FALSE; BOOL ScrollToBottom = FALSE; // TRUE if it is more important that the bottom of // ScrollToRect, rather than the top, is visible if (DocGroup != NULL) ForceGroupFolded(DocGroup, FALSE); // Ensure group is unfolded ReformatNow(TRUE); // Ensure the tree format information is up to date if (!AreCurrentAttrs && DocGroup != NULL) { // The line/fill colours returned are those of the selection, not the current attrs IndexedColour *Parent; for (INT32 i = 0; i < 2; i++) // For each colour (line, fill) { if (SelColour[i] != NULL) // If there is a single selected colour { Parent = SelColour[i]->FindParentIndexedColour(); // Find the named IxColour if (Parent != NULL && Parent->IsNamed()) // (if any) { // See if we can find a display item for this colour, and select it SGDisplayColour *Ptr = (SGDisplayColour *)DocGroup->GetChild(); while (Ptr != NULL) { if (Ptr->GetDisplayedColour()->FindParentIndexedColour() == Parent) { // determine the rectangle to try to show on screen (the // union of both the selected items) if (!HaveSelected) Ptr->GetFormatRect(&ScrollToRect); else { DocRect TempRect; Ptr->GetFormatRect(&TempRect); // We must be adding the fill colour. If this is below the // line colour, then we'd prefer to scroll to show the // bottom of the rectangle, as it is more important that // the fill rather than line is visible if won't both fit. ScrollToBottom = (TempRect.hi.y <= ScrollToRect.lo.y); ScrollToRect = ScrollToRect.Union(TempRect); } // And select the item, and update the selection-anchor Ptr->SetSelected(TRUE); SetLastSelectedNode(Ptr); HaveSelected = TRUE; break; } Ptr = (SGDisplayColour *) Ptr->GetNext(); } } } } } if (AutoScrollSelection || AlwaysScroll) { if (AlwaysScroll && !HaveSelected && DocGroup != NULL) { // We didn't select anything in the gallery. In that case, scroll to the top // of the document display DocRect TempRect; DocGroup->GetFormatRect(&TempRect); DocGroup->GetChildArea(&ScrollToRect); ScrollToRect = ScrollToRect.Union(TempRect); HaveSelected = TRUE; ScrollToBottom = FALSE; } if (HaveSelected) ScrollToShow(&ScrollToRect, ScrollToBottom); } // scroll to make seln visible on screen SelectionHasChanged(); // Update for the new selection }

---

Friends And Related Function Documentation

friend class SGDisplayColour [friend]

Definition at line 468 of file sgcolour.h.

---

Member Data Documentation

INT32 ColourSGallery::AutoScrollSelection = TRUE [static]

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. Preference: AutoScrollColGal Section: Displays Range: TRUE or FALSE This is because it can be annoying that the gallery keeps scrolling away from a colour which you were about to apply to the selection (though you'd be better off dragging the colour, rather than selecting different objects in this case) Notes: Normal preference, available from the options dialogue. See also: ColourSGallery Definition at line 573 of file sgcolour.h.

ColourListComponent* ColourSGallery::CurrentColComp [protected]

Definition at line 568 of file sgcolour.h.

SGDisplayLibColGroup* ColourSGallery::CurrentImportGroup [private]

Definition at line 587 of file sgcolour.h.

SGDisplayNode* ColourSGallery::CurrentTarget [protected]

Definition at line 569 of file sgcolour.h.

INT32 ColourSGallery::DefaultDisplayMode = 0 [static]

Memory of the current colour gallery display mode, saved between sessions for convenience. Not shown in the options dialogue. Preference: ColourDisplayMode Section: Displays Range: 0..2 See also: ColourSGallery Definition at line 577 of file sgcolour.h.

BOOL ColourSGallery::ISentTheMessage [protected]

Definition at line 566 of file sgcolour.h.

ColourSGallery * ColourSGallery::m_pTheGallery = NULL [static, protected]

Definition at line 601 of file sgcolour.h.

String_256 ColourSGallery::PalettePath = TEXT("") [static]

The path to load the palettes from. Defaults to blank which means alongside the exe. Preference: Path Section: Palette Range: 0 .. 256 characters See also: ColourSGallery Definition at line 579 of file sgcolour.h.

BOOL ColourSGallery::ShowDocumentColours = TRUE [static]

Memory of the current state of showing document colours in the colour line. Preference: ShowDocumentColours Section: ColourLine Range: TRUE, FALSE (0,1) See also: ColourSGallery Definition at line 581 of file sgcolour.h.

BOOL ColourSGallery::ShowNetscapeColours = TRUE [static]

Memory of the current state of showing Netscape colours in the colour line. Webster needs to default to True. Preference: ShowNetscapeColours Section: ColourLine Range: TRUE, FALSE (0,1) See also: ColourSGallery Definition at line 583 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)

---