LayerSGallery Class Reference

The Layer SuperGallery class. More...

#include <sglayer.h>

Inheritance diagram for LayerSGallery:

List of all members.

Public Member Functions
	LayerSGallery ()
	LayerSGallery default constructor.
	~LayerSGallery ()
	LayerSGallery destructor.
virtual MsgResult	Message (Msg *Message)
	A standard message handler, really.
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.
virtual void	CreateNewSubtree (Document *ParentDoc, SGDisplayGroup *ExistingGroup=NULL)
	Internal call. This takes the Layer 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.
Spread *	GetSelectedSpread (void)
	To find the current layer gallery spread.
virtual void	DoChangeAllVisible (BOOL AllVisible)
	Called when the AllVisible button is clicked in the layers gallery. Effects the visibility of all layers, regardless of their visibility.
virtual void	DoChangeMultilayer (BOOL Multilayer)
	Called when the Multilayer button is clicked in the layers gallery. Effects the locked state of all layers, regardless of their individual locked state.
virtual void	DoChangeLayerState (Layer *pLayer, OpLayerGalReason Reason, BOOL NewState)
	Undoable way of changing the layer's state.
Static Public Member Functions
static void	ForceRedrawLayer (Document *pDoc, Layer *pLayer)
	Does a ForceRedraw on the layer in the given doc.
static void	MakeActiveLayer (Layer *pNewActiveLayer, BOOL TellAll=TRUE)
	Makes the layer active. Firstly it will inactivate any other active layers, forcing it to redraw if necessary Then it will set this layer to be active, again forcing a redraw if necessary.
static void	EnsureActiveLayerIntegrity (Spread *pSpread, Layer **ppActiveLayer=NULL)
	This checks that there is one and only one active layer in the given spread. If there isn't an active layer, the first layer is made active. If there is more than on active layer, all but the first active layer are made inactive.
static void	SetActive (Document *pDoc, Layer *pLayer, BOOL state)
	Calls pLayer->SetActive(state), redrawing and changing the layer's selection if necessary. DON'T CALL THIS FUNC!! USE MakeActiveLayer() INSTEAD!!!!
static void	MakeTopLayerActive (Spread *pSpread)
	Makes the layer active. Firstly it will inactivate any other active layers, forcing it to redraw if necessary If the new layer is already active, nothing else happens Then it will set this layer to be active, again forcing a redraw if necessary.
static String_256	CreateUniqueLayerID (Spread *pSpread)
	Used to generate a LayerID which is unique for the spread. The name generated is normally of the form "Layer n", where n is the number of layers in the spread + 1. If "Layer n" already exists on the spread then "Layer m" is generated where m is the smallest integer greater than n such that the id is unique.
static void	DoChangeVisible (Layer *pLayer, BOOL Visible)
	Called when the visible button is clicked in a layer gallery item. Changes the visibility of the displayed layer.
static void	DoChangeLocked (Layer *pLayer, BOOL Locked)
	Called when the Locked button is clicked in a layer gallery item. Changes the lockedness of the displayed layer.
static BOOL	DoMoveSelectionToActiveLayer ()
Protected Member Functions
virtual BOOL	PreCreate (void)
	Layer SuperGallery PreCreate handler.
virtual BOOL	PostCreate (void)
	The LayerSGallery PostCreate handler. This overrides the base class PostCreate function. It is called at the very end of the SuperGallery::Create method, after the window has been created and opened.
virtual BOOL	ApplyAction (SGActionType Action)
	Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc).
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 SGDisplayItem *	CopyDisplayItem (SGDisplayItem *SourceItem, SGDisplayGroup *DestGroup, SGDisplayItem *TargetPosition=NULL)
	"Copies" the existing node in the tree in an appropriate fashion.
virtual void	NewSelectedSpread (Spread *pNewSelSpread=NULL)
	Central place for setting the layer gal's selected spread. Also takes a copy of the selected document.
virtual void	EnsureSelSpreadSelectionIntegrity ()
	This makes sure that all the invisible and/or locked layers in the spread have no selection. It calls NodeRenderableInk::DeselectAllOnLayer() on each layer that should NOT have a selection, just in case. Currently only called after an undo or redo op, because it could be quite slow.
virtual void	EnsureActiveLayerIntegrity ()
	This checks that there is one and only one active layer in the gallery's spread.
virtual BOOL	CheckVarsAreValid ()
	A routine that checks to see if critical vars are OK. All it does at the mo is check that pSpread and pDoc are not NULL. In debug builds, an ENSURE will go off if something goes wrong.
virtual SGDisplayLayer *	GetSelectedLayerGalItem ()
	Gets the selected layer gallery item In debug builds, an ENSURE will go off if there is no selected gal item.
virtual BOOL	HasLayerGotChildren (Layer *pLayer)
	Scans the layer for children that render something on the screen. It ignores attributes, hidden nodes, etc - nodes that don't render anything themselves.
virtual BOOL	PrepareToDelete (void)
	Scans the current Gallery selection. Possibly asks the user for confirmation about the delete. Possibly adjusts the selection as appropriate. Then returns a value to indicate whether the remaining selection should be deleted.
virtual BOOL	DoDeleteSelection (void)
	FORCIBLY deletes the current gallery selection. By the time this function is called, PrepareToDelete has made sure that it is safe to continue. This must simply invoke a forced delete upon the selection. Deletion of colours occurs by hiding (with undo).
virtual void	DoCreateNewItem (void)
	This function is meant to be overridden in derived classes It creates a new item and adds it to the Gallery DisplayList The item may be created by cloning/deriving/basing-on the selected item, depending on the type of Gallery concerned.
virtual void	DoChangeName ()
	Pops up the name changing dialog for the selected layer.
virtual void	DoCopyLayer ()
	Pops up the name changing dialog for the selected layer, and if OK is clicked a copy of the layer is made with the new name.
virtual void	DoLayerProperties ()
	Opens the layer properties dlg.
virtual void	DoCreateGuideLayer ()
	Creates a guide layer.
virtual void	DoChangeLayerStatus (Layer *pLayer, const LayerStatus &NewStatus)
	General undoable way of changing the selected layer's status.
virtual void	DoMoveLayer (MoveLayerType Reason)
	Called when the Locked button is clicked in the layers gallery. Changes the lockedness of the selected layer, if there is one.
virtual INT32	GetGuideLayerState (DocView *pDocView)
	This returns the current state of the guide layer. It is used to determine whether we need to recreate and redraw the layer gallery when the selected view changes.
virtual BOOL	IsSelectedItemGuideLayer ()
	General function for finding out if the selected item is a guide layer Notes: Need not be overridden - the default action is to do nothing extra to the normal shade/unshade operation.
BOOL	IsLayerMode (Document *pDoc)
BOOL	CloseLayerGallery ()
BOOL	OpenFrameGallery ()
void	SetNewDocBorn (BOOL Val)
BOOL	GetNewDocBorn ()
Protected Attributes
Spread *	pSpread
Document *	pDoc
SGDisplayGroup *	DisplayForeground
SGDisplayGroup *	DisplayBackground
BOOL	m_NewDocBorn
INT32	OldGuideLayerState
INT32	NewGuideLayerState

---

Detailed Description

The Layer SuperGallery class.

Author:

Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> (Based on template code by Jason)

Date:

27/1/95 (Based on the Colour SGallery code)

Notes: SuperGalleries are specced in a number of docs including specs.doc ("super" gallery extensions) specs.doc (gallery basic ui) There is also howtouse.doc which describes creating a supergallery

See also:

SuperGallery; SGDisplayLayer

Definition at line 267 of file sglayer.h.

---

Constructor & Destructor Documentation

LayerSGallery::LayerSGallery (   )

LayerSGallery default constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Definition at line 1290 of file sglayer.cpp. { #ifndef EXCLUDE_GALS DlgResID = _R(IDD_LAYERSGALLERY); pSpread = NULL; pDoc = NULL; DisplayForeground = NULL; // Group of foreground layers DisplayBackground = NULL; // Group of background layers OldGuideLayerState = -1; NewGuideLayerState = -1; m_NewDocBorn = FALSE; #endif }

LayerSGallery::~LayerSGallery (   )

LayerSGallery destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 27/1/95 (base generated in sgbase.cpp) Definition at line 1317 of file sglayer.cpp. { }

---

Member Function Documentation

BOOL LayerSGallery::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: 27/1/95 (base generated in sgbase.cpp) 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. Reimplemented in FrameSGallery. Definition at line 1527 of file sglayer.cpp. { // No display tree? Better forget about it then! if (DisplayTree == NULL) return(FALSE); // Determine useful info - this is usually needed for most actions, so always get it Document *SelectedDoc = Document::GetSelected(); SGDisplayGroup *DocumentGroup = DisplayTree->FindSubtree(this, SelectedDoc, NULL); SGDisplayLayer *FirstSelected = NULL; if (DocumentGroup != NULL) FirstSelected = (SGDisplayLayer *) DocumentGroup->FindNextSelectedItem(NULL); // Now, process the action TO DO! - see Colour gallery for examples switch(Action) { case SGACTION_CREATE: DoCreateNewItem(); break; case SGACTION_EDIT: DoChangeName(); break; case SGACTION_DELETE: if (PrepareToDelete()) DoDeleteSelection(); break; // case SGACTION_APPLY: // case SGACTION_REDEFINE: // case SGACTION_DISPLAYMODECHANGED: // These operations are not provided by the layer gallery // break; default: return(SuperGallery::ApplyAction(Action)); } return(TRUE); }

BOOL LayerSGallery::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: The Layer gallery provides only a simple item-pop-up menu Reimplemented from SuperGallery. Reimplemented in FrameSGallery. Definition at line 3279 of file sglayer.cpp. { BOOL ok = TRUE; if (MenuID == SGMENU_OVERITEM) { // Over-list menu SGDisplayLayer* pLayerGalItem = GetSelectedLayerGalItem(); #ifndef STANDALONE // no layer properties tab present on standalone version if (pLayerGalItem != NULL) { // Changed for Frame/Layer integration. //#ifdef WEBSTER // GIFAnimationPropertyTabs * pTabHandler = GIFAnimationPropertyTabsDlg::GetGIFAnimationPropertiesTabs(); //#else LayerPropertyTabs * pTabHandler = LayerPropertyTabsDlg::GetLayerPropertiesTabs(); //#endif //webster if (pTabHandler) { pTabHandler->SetCurrentLayer(pLayerGalItem->GetDisplayedLayer()); } } #endif ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_New); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Copy); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Delete,TRUE); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Create); #ifndef STANDALONE ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Properties); #endif } return(ok); }

BOOL LayerSGallery::CheckVarsAreValid (   )  [protected, virtual]

A routine that checks to see if critical vars are OK. All it does at the mo is check that pSpread and pDoc are not NULL. In debug builds, an ENSURE will go off if something goes wrong. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 8/8/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE - the vars are ok FALSE - one or more of the vars is invalid Definition at line 2395 of file sglayer.cpp. { return ((pSpread != NULL) && (pDoc != NULL)); }

BOOL LayerSGallery::CloseLayerGallery (   )  [protected]

Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/97 Parameters: -  [INPUTS] Returns: TRUE if sucessful, else FALSE. Definition at line 3454 of file sglayer.cpp. { SuperGallery* pSuperGallery = SuperGallery::FindSuperGallery(_R(IDD_LAYERSGALLERY)); // Ensure a valid ptr. if (pSuperGallery == NULL) return FALSE; if (pSuperGallery->GetRuntimeClass() == CC_RUNTIME_CLASS(LayerSGallery)) { PORTNOTE("galleries", "Disabled frame gallery") #ifndef EXCLUDE_FROM_XARALX GIFAnimationPropertyTabs::SetFrameGalleryOpen(FALSE); #endif // Toggle the visible state of the gallery window pSuperGallery->SetVisibility( FALSE ); } else { ERROR3("Got the frame gallery but it's not of the LayerSGallery class"); } SGInit::UpdateGalleryButton(_R(OPTOKEN_DISPLAYLAYERGALLERY), FALSE); // Everything ok. return TRUE; }

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

"Copies" the existing node in the tree in an appropriate fashion. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> (from a Jason func) Date: 21/3/95 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 add to the end of the sibling list), or points to the item BEFORE which the 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 method should be overridden by derived galleries to provide appropriate behaviour (some galleries (e.g colour) will copy the real-item that the given display-item references to the new group (document), while other galleries (layer) may just move the item after all). Note the handy InsertCopiedItem and MoveBefore/After methods which are available to take all of the hard work out of copying/moving items! See the body of this method in the source code for example pseudocode. For real code, see the Colour Gallery (sgcolour.cpp) See also: SuperGallery::InsertCopiedItem; SGDisplayItem::MoveBefore; SGDisplayItem::MoveAfter; SGColour::CopyDisplayItem Reimplemented from SuperGallery. Definition at line 3147 of file sglayer.cpp. { ERROR3IF(SourceItem == NULL || DestGroup == NULL, "Illegal NULL param"); if (SourceItem == NULL || DestGroup == NULL) return(NULL); ERROR3IF(!IS_A(DestGroup,SGLayerGroup),"DestGroup is not a SGLayerGroup"); ERROR3IF(!IS_A(SourceItem,SGDisplayLayer),"SourceItem is not a SGDisplayLayer"); if (!IS_A(DestGroup,SGLayerGroup) || !IS_A(SourceItem,SGDisplayLayer)) return(NULL); SGLayerGroup* pDestLayerGroup = (SGLayerGroup*)DestGroup; SGDisplayLayer* pSourceLayerItem = (SGDisplayLayer*)SourceItem; SGDisplayItem* pDestItem = TargetPosition; BOOL Before = TRUE; if (pDestItem == NULL) { pDestItem = (SGDisplayItem*) pDestLayerGroup->GetChild(); Before = TRUE; if (pDestItem == NULL) { SGDisplayNode* pNode = SourceItem; while (pNode != NULL) { pDestItem = (SGDisplayItem*) pNode; if (pDestLayerGroup->IsForeground()) pNode = pNode->GetPrevious(); else pNode = pNode->GetNext(); } Before = pDestLayerGroup->IsForeground(); } else { SGDisplayItem* pLastDestItem = NULL; while (pDestItem != NULL) { pLastDestItem = pDestItem; pDestItem = (SGDisplayItem*)(pDestItem->GetNext()); } pDestItem = pLastDestItem; Before = FALSE; } } ERROR3IF(pDestItem == NULL,"pDestItem is still NULL"); if (pDestItem == NULL) return(NULL); // Move the display item around SourceItem->RemoveFromTree(); // Delink from current displaytree position SuperGallery::InsertCopiedItem(SourceItem, DestGroup, TargetPosition); if (pDestItem != NULL) { ERROR3IF(!IS_A(pDestItem,SGDisplayLayer),"SourceItem is not a SGDisplayLayer"); if (!IS_A(pDestItem,SGDisplayLayer)) return(NULL); SGDisplayLayer* pDestLayerItem = (SGDisplayLayer*)pDestItem; pDestLayerItem->MoveLayer(pSourceLayerItem,Before,TRUE); } return(SourceItem); }

void LayerSGallery::CreateNewSubtree (  Document *  ParentDoc, SGDisplayGroup *  ExistingGroup = NULL )  [virtual]

Internal call. This takes the Layer 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: 27/1/95 (base generated in sgbase.cpp) 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 See also: SuperGallery::ForceRedrawOfList Reimplemented in FrameSGallery. Definition at line 1348 of file sglayer.cpp. { if (DisplayTree == NULL) return; TRACEUSER( "Neville", _T("LayerSGallery::CreateNewSubtree Just about to DestroySubtree\n")); // The layer gallery only ever shows one document, so destroy the entire tree // and start again from scratch (note that this doesn't destroy the root node) DisplayTree->DestroySubtree(); // All groups will be destroyed by DestroySubtree(), so we'd better forget them DisplayForeground = NULL; DisplayBackground = NULL; TRACEUSER( "Neville", _T("LayerSGallery::CreateNewSubtree completed DestroySubtree\n")); if (ParentDoc == NULL) return; SGDisplayLayer *DisplayLayer = NULL; EnsureActiveLayerIntegrity(); // Create the foreground layer group DisplayForeground = new SGLayerGroup(this, ParentDoc,NULL,TRUE); // Create new Group if (DisplayForeground == NULL) // Total failure - abort return; DisplayTree->AddItem(DisplayForeground); // Add new group to tree // Create the background layer group DisplayBackground = new SGLayerGroup(this, ParentDoc,NULL,FALSE); // Create new Group if (DisplayBackground == NULL) // Total failure - abort return; DisplayTree->AddItem(DisplayBackground); // Add new group to tree Spread* pSelSpread = GetSelectedSpread(); ERROR3IF(pSelSpread == NULL,"No selected spread in LayerSGallery"); if (pSelSpread == NULL) return; Layer* pLayer = pSelSpread->FindLastLayer(); Layer* pActiveLayer = NULL; Layer* pGuideLayer = NULL; while (pLayer != NULL) { // Keep a ptr to the guide layer, if there is one if (pLayer->IsGuide()) pGuideLayer = pLayer; DisplayLayer = new SGDisplayLayer(pLayer); if (DisplayLayer != NULL) { if (pLayer->IsBackground()) DisplayBackground->AddItem(DisplayLayer); else DisplayForeground->AddItem(DisplayLayer); } if (pLayer->IsActive()) { ERROR3IF(pActiveLayer != NULL, "Found more than one active layer in the selected spread"); pActiveLayer = pLayer; DisplayLayer->SetSelected(TRUE); // Make the active layer selected } pLayer = pLayer->FindPrevLayer(); } // The new state of the Guide Layer is now the old state OldGuideLayerState = NewGuideLayerState; if (pGuideLayer == NULL) NewGuideLayerState = -1; // If there's no guide layer, set new state to be -1 else NewGuideLayerState = pGuideLayer->IsVisible(); // New state is based on the guide layer's visibility if (IsVisible()) { SetBoolGadgetSelected(_R(IDC_BTN_MULTILAYER),!(ParentDoc->IsMultilayer() == 0)); SetBoolGadgetSelected(_R(IDC_BTN_ALLVISIBLE),!(ParentDoc->IsAllVisible() == 0)); } TRACEUSER( "Neville", _T("LayerSGallery::CreateNewSubtree exit\n")); }

String_256 LayerSGallery::CreateUniqueLayerID (  Spread *  pSpread  )  [static]

Used to generate a LayerID which is unique for the spread. The name generated is normally of the form "Layer n", where n is the number of layers in the spread + 1. If "Layer n" already exists on the spread then "Layer m" is generated where m is the smallest integer greater than n such that the id is unique. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> (based on a Simon routine) Date: 4/8/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A LayerID which is unique for the layer galleries spread. Errors: - See also: - Definition at line 2327 of file sglayer.cpp. { if (pSpread == NULL) return String_256(""); String_256 UniqueLayerID; INT32 NumLayers = 0; Layer* pLayer = pSpread->FindFirstLayer(); // Calculate how many layers are on the current spread while (pLayer != NULL) { // Don't cound the guide layer - it's LayerID (aka Name) is "Guides" if(!pLayer->IsGuide()) { NumLayers++; } pLayer = pLayer->FindNextLayer(); } INT32 NewLayerNum = NumLayers+1; BOOL Unique; // Flag used to indicate if the id generated is unique or not do { // Construct a first attempt at a unique layer id 'Layer n' // where n = the number of layers on the current spread + 1 UniqueLayerID.MakeMsg(_R(IDS_SGLAYER_LAYER_NUM), /*TEXT("Layer #1%ld"),*/NewLayerNum); // Check that UniqueLayerID is indeed unique Unique = TRUE; // Until we know better pLayer = pSpread->FindFirstLayer(); while (pLayer != NULL) { if (UniqueLayerID == pLayer->GetLayerID()) { Unique = FALSE; // UniqueLayerID is not unique so increment NewLayerNum and try again NewLayerNum++; break; } pLayer = pLayer->FindNextLayer(); } } while (!Unique); return(UniqueLayerID); }

void LayerSGallery::DoChangeAllVisible (  BOOL  AllVisible  )  [virtual]

Called when the AllVisible button is clicked in the layers gallery. Effects the visibility of all layers, regardless of their visibility. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 11/8/94 Parameters: AllVisible  - TRUE means all layers become visible [INPUTS] FALSE means only visible layers are visible Returns: - Definition at line 2736 of file sglayer.cpp. { if (!CheckVarsAreValid()) return; // Get the state prior to the change BOOL PrevAllVisible = pDoc->IsAllVisible(); // If no change, return if (PrevAllVisible == AllVisible) return; Layer* pLayer = pSpread->FindFirstLayer(); while (pLayer != NULL) { // Do not include the page background layer in this process as this is very bad! if (!pLayer->IsPageBackground()) { pDoc->SetAllVisible(PrevAllVisible); BOOL PrevVisible = pLayer->IsVisible(); // BOOL PrevLocked = pLayer->IsLocked(); pDoc->SetAllVisible(AllVisible); BOOL PostVisible = pLayer->IsVisible(); // BOOL PostLocked = pLayer->IsLocked(); if (PrevVisible != PostVisible) { LayerSGallery::ForceRedrawLayer(pDoc,pLayer); if (!PostVisible) NodeRenderableInk::DeselectAllOnLayer(pLayer); } } pLayer = pLayer->FindNextLayer(); } pDoc->SetAllVisible(AllVisible); // inform that visible layers have changed BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::LAYER_VISIBILITY_CHANGED)); }

void LayerSGallery::DoChangeLayerState (  Layer *  pLayer, OpLayerGalReason  Reason, BOOL  NewState )  [virtual]

Undoable way of changing the layer's state. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 7/3/95 Parameters: pLayer  = ptr to the layer to change [INPUTS] Reason = the flag which to change NewState = The new state of the flag to change Returns: - Definition at line 2951 of file sglayer.cpp. { if (!CheckVarsAreValid()) return; OpLayerGalParam Param(Reason, pSpread); Param.pLayer = pLayer; Param.NewState = NewState; Param.pLayerSGal= this; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_LAYERGALCHANGE); if (pOpDesc != NULL) pOpDesc->Invoke((OpParam*)&Param); else { ERROR3("Couldn't find OPTOKEN_LAYERGALCHANGE op descriptor"); } }

void LayerSGallery::DoChangeLayerStatus (  Layer *  pLayer, const LayerStatus &  NewStatus )  [protected, virtual]

General undoable way of changing the selected layer's status. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 8/8/94 Parameters: pLayer  = ptr to the layer to change [INPUTS] NewStatus = reference to the status that the selected layer should take on board. Returns: - Definition at line 2919 of file sglayer.cpp. { if (!CheckVarsAreValid()) return; OpLayerGalParam Param(LAYER_CHANGE, pSpread); Param.pLayer = pLayer; Param.Status = NewStatus; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_LAYERGALCHANGE); if (pOpDesc != NULL) pOpDesc->Invoke((OpParam*)&Param); else { ENSURE(FALSE,"Couldn't find OPTOKEN_LAYERGALCHANGE op descriptor"); } }

void LayerSGallery::DoChangeLocked (  Layer *  pLayer, BOOL  Locked )  [static]

Called when the Locked button is clicked in a layer gallery item. Changes the lockedness of the displayed layer. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> (Jason, ripped from the LayerGallery, 1/2/95) Date: 8/8/94 Parameters: pLayer  = the layer to change [INPUTS] Locked - TRUE means make the displayed layer locked FALSE means unlock Returns: - Notes: Does not redraw the layer in the display list Definition at line 2891 of file sglayer.cpp. { ERROR3IF(pLayer == NULL,"pLayer == NULL"); if (pLayer == NULL) return; BOOL PrevLocked = pLayer->IsLocked(); pLayer->SetLocked(Locked); BOOL PostLocked = pLayer->IsLocked(); if (PrevLocked != PostLocked) NodeRenderableInk::DeselectAllOnLayer(pLayer); }

void LayerSGallery::DoChangeMultilayer (  BOOL  Multilayer  )  [virtual]

Called when the Multilayer button is clicked in the layers gallery. Effects the locked state of all layers, regardless of their individual locked state. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 11/8/94 Parameters: Multilayer  - TRUE means all layers become unlocked [INPUTS] FALSE means only locked layers are locked Returns: - Definition at line 2796 of file sglayer.cpp. { if (!CheckVarsAreValid()) return; // Get the state prior to the change BOOL PrevMultilayer = pDoc->IsMultilayer(); // If no change, return if (PrevMultilayer == Multilayer) return; Layer* pLayer = pSpread->FindFirstLayer(); BOOL PrevLocked; BOOL PostLocked; while (pLayer != NULL) { // Do not include the page background layer in this process as this is very bad! if (!pLayer->IsPageBackground()) { pDoc->SetMultilayer(PrevMultilayer); PrevLocked = pLayer->IsLocked(); pDoc->SetMultilayer(Multilayer); PostLocked = pLayer->IsLocked(); if ((PrevLocked != PostLocked) && PostLocked) NodeRenderableInk::DeselectAllOnLayer(pLayer); } pLayer = pLayer->FindNextLayer(); } pDoc->SetMultilayer(Multilayer); }

void LayerSGallery::DoChangeName (   )  [protected, virtual]

Pops up the name changing dialog for the selected layer. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 9/8/94 Parameters: -  [INPUTS] Returns: - Definition at line 2610 of file sglayer.cpp. { SGDisplayLayer* pLayerGalItem = GetSelectedLayerGalItem(); if (pLayerGalItem != NULL) { LayerDlgParam Param(LAYER_CHANGE_NAME,NULL,pLayerGalItem->GetDisplayedLayer()); LayerNameDlg::StartUp(&Param); } }

void LayerSGallery::DoChangeVisible (  Layer *  pLayer, BOOL  Visible )  [static]

Called when the visible button is clicked in a layer gallery item. Changes the visibility of the displayed layer. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> (Jason, ripped from the LayerGallery, 1/2/95) Date: 8/8/94 Parameters: pLayer  = the layer to change [INPUTS] Visible - TRUE means make the displayed layer visible FALSE means make invisiblr Returns: - Notes: Does not redraw the layer in the display list Definition at line 2850 of file sglayer.cpp. { ERROR3IF(pLayer == NULL,"pLayer == NULL"); if (pLayer == NULL) return; BOOL PrevVisible = pLayer->IsVisible(); pLayer->SetVisible(Visible); BOOL PostVisible = pLayer->IsVisible(); if (PrevVisible != PostVisible) { // Force a redraw if the layer's visibility has changed LayerSGallery::ForceRedrawLayer(pLayer->FindDocument(), pLayer); // inform that visible layers have changed BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::LAYER_VISIBILITY_CHANGED)); // If layer has just become invisible, remove the selections on the layer if (!PostVisible) NodeRenderableInk::DeselectAllOnLayer(pLayer); } }

void LayerSGallery::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. Reimplemented in FrameSGallery. Definition at line 3424 of file sglayer.cpp. { if (*CommandID == SGCmd_Copy) DoCopyLayer(); else if (*CommandID == SGCmd_New) DoCreateNewItem(); else if (*CommandID == SGCmd_Delete) { if (PrepareToDelete()) DoDeleteSelection(); } else if (*CommandID == SGCmd_Properties) DoLayerProperties(); else if (*CommandID == SGCmd_Create) DoCreateGuideLayer(); // Don't call the base class 'cos we don't want any other commands }

void LayerSGallery::DoCopyLayer (   )  [protected, virtual]

Pops up the name changing dialog for the selected layer, and if OK is clicked a copy of the layer is made with the new name. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 9/8/94 Parameters: -  [INPUTS] Returns: - Reimplemented in FrameSGallery. Definition at line 2637 of file sglayer.cpp. { SGDisplayLayer* pLayerGalItem = GetSelectedLayerGalItem(); if (pLayerGalItem != NULL) { LayerDlgParam Param(LAYER_COPY,NULL,pLayerGalItem->GetDisplayedLayer()); LayerNameDlg::StartUp(&Param); } }

void LayerSGallery::DoCreateGuideLayer (   )  [protected, virtual]

Creates a guide layer. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 4/10/95 Parameters: -  [INPUTS] Returns: - Definition at line 2704 of file sglayer.cpp. { #ifndef WEBSTER OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_GUIDELINE); ERROR3IF(pOpDesc == NULL,"FindOpDescriptor(OPTOKEN_GUIDELINE) failed"); if (pOpDesc != NULL) { OpGuidelineParam GuidelineParam; GuidelineParam.Method = GUIDELINEOPMETHOD_CREATE_GUIDE_LAYER; pOpDesc->Invoke(&GuidelineParam); } #endif // WEBSTER }

void LayerSGallery::DoCreateNewItem (  void   )  [protected, virtual]

This function is meant to be overridden in derived classes It creates a new item and adds it to the Gallery DisplayList The item may be created by cloning/deriving/basing-on the selected item, depending on the type of Gallery concerned. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 2/8/94 Reimplemented in FrameSGallery. Definition at line 2589 of file sglayer.cpp. { if (!CheckVarsAreValid()) return; LayerDlgParam Param(LAYER_NEW,pSpread,NULL); LayerNameDlg::StartUp(&Param); }

BOOL LayerSGallery::DoDeleteSelection (  void   )  [protected, virtual]

FORCIBLY deletes the current gallery selection. By the time this function is called, PrepareToDelete has made sure that it is safe to continue. This must simply invoke a forced delete upon the selection. Deletion of colours occurs by hiding (with undo). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 2/8/94 Returns: FALSE if it couldn't delete the selection. (This should, if at all possible leave the entire selection undeleted in this case) See also: LayerSGallery::PrepareToDelete; ColourManager::HideColours Reimplemented in FrameSGallery. Definition at line 2549 of file sglayer.cpp. { SGDisplayLayer* pLayerGalItem = GetSelectedLayerGalItem(); if (pLayerGalItem != NULL) { OpLayerGalParam Param(LAYER_DELETE,pSpread); Param.pLayer = pLayerGalItem->GetDisplayedLayer(); OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_LAYERGALCHANGE); if (pOpDesc != NULL) pOpDesc->Invoke((OpParam*)&Param); else { ERROR3("Couldn't find OPTOKEN_LAYERGALCHANGE op descriptor"); } return (TRUE); } return (pLayerGalItem != NULL); }

void LayerSGallery::DoLayerProperties (   )  [protected, virtual]

Opens the layer properties dlg. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/95 Parameters: -  [INPUTS] Returns: - Definition at line 2661 of file sglayer.cpp. { #ifndef STANDALONE // layer property tabs not present in viewer OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_LAYERPROPERTYTABS); if (pOpDesc != NULL) {