FrameSGallery Class Reference

The Layer SuperGallery class. More...

#include <sgframe.h>

Inheritance diagram for FrameSGallery:

List of all members.

Public Member Functions
	FrameSGallery ()
	FrameSGallery default constructor.
	~FrameSGallery ()
	FrameSGallery 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.
Static Public Member Functions
static void	MakeActiveLayer (Layer *pNewActiveLayer, UndoableOperation *pUndoOp=NULL)
	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	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 String_256	CreateUniqueLayerID (Spread *pSpread, const String_256 *pBaseName=NULL)
	This function tries to hide the specified node. Copy of the undoable operation version as we are not undoable and don't have an op. Hide it as it may be mentioned in the undo history. Note: This would be safer than deleting the layer nodes but if we use this, which should be the same as the DoHideNode in undoable operation does, then it leaks the hidden nodes and layers that are being hidden. So there must be something sneaky going on.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 BOOL	EnsureFrameLayerIntegrity (Spread *pSpread)
	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.This function should be called before any frame related actions are carried out It will ensure that all the visible layers are frame layers.
static BOOL	DoHideNode (Node *pNodeToHide)
static void	DoChangeSolid (Layer *pLayer, BOOL Solid)
	Called when the Solid button is clicked in a layer gallery item. Changes the Solidness of the displayed layer.
static void	DoChangeOverlay (Layer *pLayer, BOOL Overlay)
	Called when the Overlay button is clicked in a layer gallery item. Changes the Overlayness of the displayed layer.
static void	FixOtherLayers (Spread *pSpread)
	A layer flag such as overlay or solid has been changed and so we need to go and find the active layer and ensure that the other layers above and below this have the correct visibility and locked settings.
static void	FixOtherLayersFromActive (Layer *pActiveLayer, UndoableOperation *pUndoOp=NULL)
	A layer flag such as overlay or solid has been changed and so we need take the passed in current active layer and then ensure that the other layers above and below this have the correct visibility and locked settings.
Protected Member Functions
virtual BOOL	PostCreate (void)
	The FrameSGallery 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 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 SGDisplayLayer *	GetSelectedLayerGalItem ()
	Gets the selected layer gallery item In debug builds, an ENSURE will go off if there is no selected gal item.
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 BOOL	DoDeleteSelection (void)
	FORCIBLY deletes the active layer/frame.
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	DoCopyLayer ()
	Copies the active layer creating a new one with a default frame name.
virtual BOOL	DoSaveAnimation ()
	Saves out the current animation to file.
virtual BOOL	DoPreviewAnimation ()
	Previews the current animation.
virtual BOOL	DoFrameProperties ()
	Opens the frame properties dlg.
virtual BOOL	DoRegenerateFrames ()
	While previewing an animation, if the spread properties are changed we neeed to regenerate the frame layers. This function invokes the correct Op.
virtual BOOL	DoRegenerateSingleFrame ()
	While previewing an animation, if the frame layer properties are changed we neeed to regenerate the active frame. This function invokes the correct Op.
BOOL	UpdateFrameRelatedButtons ()
	Ensures that they buttons on the gallery up to date in their greying/ungreying status.
BOOL	IsFrameMode (Document *pDoc)
BOOL	CloseFrameGallery ()
BOOL	OpenLayerGallery ()
void	SetNewDocBorn (BOOL Val)
BOOL	GetNewDocBorn ()
Protected Attributes
BOOL	m_NewDocBorn

---

Detailed Description

The Layer SuperGallery class.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code)

Date:

16/4/97 (Based on Jason's Layer gallery 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; SGDisplayFrame

Definition at line 224 of file sgframe.h.

---

Constructor & Destructor Documentation

FrameSGallery::FrameSGallery (   )

FrameSGallery default constructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Definition at line 1006 of file sgframe.cpp. { #ifndef EXCLUDE_GALS pSpread = NULL; pDoc = NULL; DisplayForeground = NULL; // Group of foreground layers DisplayBackground = NULL; // Group of background layers OldGuideLayerState = -1; NewGuideLayerState = -1; m_NewDocBorn = FALSE; #endif }

FrameSGallery::~FrameSGallery (   )

FrameSGallery destructor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Definition at line 1032 of file sgframe.cpp. { }

---

Member Function Documentation

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

Applies certain conventional gallery actions (usually associated with gallery buttons, for new, edit, delete, etc). Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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 LayerSGallery. Definition at line 1265 of file sgframe.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); SGDisplayFrame *FirstSelected = NULL; if (DocumentGroup != NULL) FirstSelected = (SGDisplayFrame *) 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()) // No warning on Frame gallery 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 FrameSGallery::BuildCommandMenu (  GalleryContextMenu *  TheMenu, SGMenuID  MenuID )  [virtual]

To build a menu of commands to be popped up over the gallery. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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 LayerSGallery. Definition at line 2854 of file sgframe.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) { GIFAnimationPropertyTabs * pTabHandler = GIFAnimationPropertyTabsDlg::GetGIFAnimationPropertiesTabs(); //LayerPropertyTabs * pTabHandler = LayerPropertyTabsDlg::GetLayerPropertiesTabs(); 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); #ifndef STANDALONE // ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Animation); // ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Save); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Preview); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Properties); // ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_FrameProps); // ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Browser); ok = ok && AddCommand(TheMenu, (StringBase *) &SGCmd_Show); #endif } return(ok); }

BOOL FrameSGallery::CloseFrameGallery (   )  [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 3273 of file sgframe.cpp. { String_32 Name(_R(IDS_FRAMEGAL_GALLNAME)); DialogBarOp* pDialogBarOp = DialogBarOp::FindDialogBarOp(Name); // Ensure a valid ptr. if (pDialogBarOp == NULL) return FALSE; if (pDialogBarOp->GetRuntimeClass() == CC_RUNTIME_CLASS(FrameSGallery)) { GIFAnimationPropertyTabs::SetFrameGalleryOpen(FALSE); // Toggle the visible state of the gallery window pDialogBarOp->SetVisibility( FALSE ); } else { ERROR3("Got the frame gallery but it's not of the LayerSGallery class"); } SGInit::UpdateGalleryButton(OPTOKEN_DISPLAYFRAMEGALLERY, FALSE); GIFAnimationPropertyTabs::SetFrameGalleryOpen(FALSE); // Everything ok. return TRUE; }

void FrameSGallery::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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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 from LayerSGallery. Definition at line 1063 of file sgframe.cpp. { if (DisplayTree == NULL) return; TRACEUSER( "Neville", _T("FrameSGallery::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; TRACEUSER( "Neville", _T("FrameSGallery::CreateNewSubtree completed DestroySubtree\n")); if (ParentDoc == NULL) return; SGDisplayFrame *DisplayLayer = NULL; EnsureActiveLayerIntegrity(); // Create the foreground layer group DisplayForeground = new SGFrameGroup(this, ParentDoc,NULL,TRUE); // Create new Group if (DisplayForeground == NULL) // Total failure - abort return; DisplayTree->AddItem(DisplayForeground); // Add new group to tree Spread* pSelSpread = GetSelectedSpread(); ERROR3IF(pSelSpread == NULL,"No selected spread in FrameSGallery"); if (pSelSpread == NULL) return; Layer* pLayer = pSelSpread->FindLastLayer(); Layer* pActiveLayer = NULL; Layer* pGuideLayer = NULL; BOOL SetActiveLayer = FALSE; // Only Webster needs to show a dummy frame layer #ifdef WEBSTER Layer* pSingleNonFrameLayer = NULL; BOOL ShownSingleNonFrameLayer = FALSE; #endif // WEBSTER while (pLayer != NULL) { // If we find a guide layer then note that for future use if (pLayer->IsGuide()) { pGuideLayer = pLayer; } else if ( (pLayer->IsPseudoFrame() && pLayer->IsFrame()) // its a proper frame layer #ifdef WEBSTER || (pLayer->IsPseudoFrame() && !ShownSingleNonFrameLayer) // its a potential frame layer #endif // WEBSTER ) { #ifdef WEBSTER // If its not a frame layer then note that we have added our single // non-frame layer in. if (!pLayer->IsFrame()) { ShownSingleNonFrameLayer = TRUE; pSingleNonFrameLayer = pLayer; } #endif // WEBSTER // Only add foreground layers and non-guide layers DisplayLayer = new SGDisplayFrame(pLayer); if (DisplayLayer != NULL) { // Always add to the foreground layers 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 SetActiveLayer = TRUE; // Note this fact } } } pLayer = pLayer->FindPrevLayer(); } // If we have not set a selected layer then this is very bad if (!SetActiveLayer) { TRACEUSER( "Neville", _T("Active layer is not a frame layer so force it!\n")); Layer * pNewActiveLayer = pSpread->FindLastFrameLayer(); #ifdef WEBSTER if (pNewActiveLayer == NULL && pSingleNonFrameLayer != NULL) pNewActiveLayer = pSingleNonFrameLayer; #else // ERROR3IF(pNewActiveLayer == NULL,"No current active frame layer"); #endif // WEBSTER // If we have an active layer, ensure that it really is the one and only active layer if (pNewActiveLayer != NULL) { // Search for the new display item to match this new active layer SGDisplayLayer *pWantedDispLayer = NULL; SGDisplayLayer *pDispLayer = ((SGDisplayLayer *) DisplayForeground->GetChild()); while (pDispLayer != NULL) { if (pDispLayer->GetDisplayedLayer() == pNewActiveLayer) pWantedDispLayer = pDispLayer; pDispLayer = ((SGDisplayLayer *)pDispLayer->GetNext()); } // If we found the required display item then go and select it if (pWantedDispLayer) { // Now update the selection states... SelectItems(FALSE); // Deselect everything else // Something has changed so we must go and select this new item pWantedDispLayer->SetSelected(TRUE); } // As this can only happen when we have a frame layer which is not active // e.g. import a non-frame xar/web document into a non-frame document // we must use the layer form of MakeActiveLayer so that the visibility of // layers is not affected. LayerSGallery::MakeActiveLayer(pNewActiveLayer); //FrameSGallery::MakeActiveLayer(pNewActiveLayer); } } // 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("FrameSGallery::CreateNewSubtree exit\n")); }

String_256 FrameSGallery::CreateUniqueLayerID (  Spread *  pSpread, const String_256 *  pBaseName = NULL )  [static]

This function tries to hide the specified node. Copy of the undoable operation version as we are not undoable and don't have an op. Hide it as it may be mentioned in the undo history. Note: This would be safer than deleting the layer nodes but if we use this, which should be the same as the DoHideNode in undoable operation does, then it leaks the hidden nodes and layers that are being hidden. So there must be something sneaky going on.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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Parameters: pSpread  - the spread to use when checking [INPUTS] pBaseName - the name to use as the basis of the layer name, defaults to just 'Frame' Returns: A LayerID which is unique for the layer galleries spread. Errors: - See also: - Definition at line 2425 of file sgframe.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) { NumLayers++; pLayer = pLayer->FindNextLayer(); } INT32 NewLayerNum = NumLayers; if (NewLayerNum == 0) NewLayerNum = 1; // Always start at one BOOL Unique; // Flag used to indicate if the id generated is unique or not String_256 LayerName(_R(IDS_DEFAULTFRAMENAME)); // If the caller suggested a base name then use this instead. if (pBaseName != NULL) LayerName = *pBaseName; 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_FRAMENAMEUNIQUEFORM), (TCHAR *)LayerName, NewLayerNum); //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 FrameSGallery::DoChangeOverlay (  Layer *  pLayer, BOOL  Overlay )  [static]

Called when the Overlay button is clicked in a layer gallery item. Changes the Overlayness of the displayed layer. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Parameters: pLayer  = the layer to change [INPUTS] Overlay - TRUE means make the displayed layer Overlayed FALSE means make the displayed layer non-Overlayed Returns: - Notes: Does not redraw the layer in the display list Definition at line 2667 of file sgframe.cpp. { ERROR3IF(pLayer == NULL,"pLayer == NULL"); if (pLayer == NULL) return; BOOL PrevOverlay = pLayer->IsOverlay(); pLayer->SetOverlay(Overlay); BOOL PostOverlay = pLayer->IsOverlay(); //if (PrevOverlay != PostOverlay) // NodeRenderableInk::DeselectAllOnLayer(pLayer); if (PrevOverlay != PostOverlay) { Spread* pSpread = pLayer->FindParentSpread(); // Go and fix the status of other layers according to this new setting FixOtherLayers(pSpread); // Ensure that the buttons are in the correct state BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::LayerReason::ACTIVE_LAYER_CHANGED)); } }

void FrameSGallery::DoChangeSolid (  Layer *  pLayer, BOOL  Solid )  [static]

Called when the Solid button is clicked in a layer gallery item. Changes the Solidness of the displayed layer. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Parameters: pLayer  = the layer to change [INPUTS] Solid - TRUE means make the displayed layer Solid FALSE means make Solid Returns: - Notes: Does not redraw the layer in the display list Definition at line 2607 of file sgframe.cpp. { ERROR3IF(pLayer == NULL,"pLayer == NULL"); if (pLayer == NULL) return; BOOL PrevSolid = pLayer->IsSolid(); pLayer->SetSolid(Solid); BOOL PostSolid = pLayer->IsSolid(); /* if (PrevSolid != PostSolid) { // Force a redraw if the layer's visibility has changed FrameSGallery::ForceRedrawLayer(pLayer->FindDocument(), pLayer); // If layer has just become invisible, remove the selections on the layer if (!PostSolid) NodeRenderableInk::DeselectAllOnLayer(pLayer); } */ if (PrevSolid != PostSolid) { // Mark all frames above this as edited until we reach the last frame // OR we hit a solid/background layer. // Previewing all the frames copes with dependent frames // Previwing single frames does not if you preview the solid frame. Layer * pFrame = pLayer->FindNextFrameLayer(); while (pFrame != NULL && !pFrame->IsSolid()) { // Mark that frame as edited pFrame->SetEdited(TRUE); pFrame = pFrame->FindNextFrameLayer(); } Spread* pSpread = pLayer->FindParentSpread(); // Go and fix the status of other layers according to this new setting FixOtherLayers(pSpread); // Ensure that the buttons are in the correct state BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::LayerReason::ACTIVE_LAYER_CHANGED)); } }

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

To apply a given command when it is chosen from the menu. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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 LayerSGallery. Definition at line 3021 of file sgframe.cpp. { if (*CommandID == SGCmd_Copy) DoCopyLayer(); else if (*CommandID == SGCmd_New) DoCreateNewItem(); else if (*CommandID == SGCmd_Delete) { //if (PrepareToDelete()) // No warning on Frame gallery DoDeleteSelection(); } // else if (*CommandID == SGCmd_Properties) // DoFrameProperties(); else if (*CommandID == SGCmd_Preview) { DoPreviewAnimation(); } else if (*CommandID == SGCmd_FrameProps || *CommandID == SGCmd_Properties) { // Open the Animation properties dlg with the "Frame properties" page selected. DoFrameProperties(); } else if (*CommandID == SGCmd_Show) { // Toggle the state of the show frame in animation flag SGDisplayLayer* pItem = GetSelectedLayerGalItem(); Layer * pLayer = NULL; if (pItem) pLayer = pItem->GetDisplayedLayer(); if (pLayer) { BOOL CurrentState = pLayer->IsHiddenFrame(); pLayer->SetHiddenFrame(!CurrentState); if (pItem) pItem->ForceRedrawOfMyself(); // Ensure that the buttons are in the correct state BROADCAST_TO_ALL(LayerMsg(pLayer, LayerMsg::LayerReason::ACTIVE_LAYER_CHANGED)); } } // else if (*CommandID == SGCmd_Save) // DoSaveAnimation(); // Implement **** // *CommandID == SGCmd_Animation // *CommandID == SGCmd_Browser // Don't call the base class 'cos we don't want any other commands }

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

Copies the active layer creating a new one with a default frame name. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Parameters: -  [INPUTS] Returns: - Reimplemented from LayerSGallery. Definition at line 2578 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_COPYFRAME); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_COPYFRAME op descriptor"); } }

void FrameSGallery::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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Reimplemented from LayerSGallery. Definition at line 2555 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_NEWFRAME); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_NEWFRAME op descriptor"); } }

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

FORCIBLY deletes the active layer/frame. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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: FrameSGallery::PrepareToDelete; ColourManager::HideColours Reimplemented from LayerSGallery. Definition at line 2528 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_DELETEFRAME); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_DELETEFRAME op descriptor"); } return TRUE; }

BOOL FrameSGallery::DoFrameProperties (   )  [protected, virtual]

Opens the frame properties dlg. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 22/5/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 3205 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_GIFANIMPROPERTYTABS); if (pOpDesc != NULL) { // Select the "Frame properties tab". GIFAnimationPropertyTabsDlg::SetPageToOpen(GIFAnimationPropertyTabs::FramePropertiesTabNumber); String_256 Str; OpState State = pOpDesc->GetOpsState(&Str); if (!State.Greyed) pOpDesc->Invoke(); else { GIFAnimationPropertyTabs * pTabHandler = GIFAnimationPropertyTabsDlg::GetGIFAnimationPropertiesTabs(); if (pTabHandler) { DialogTabOp* pDlg = pTabHandler->GetTabbedDlg(); if (pDlg != NULL) pDlg->Open(); } } } return TRUE; }

static BOOL FrameSGallery::DoHideNode (  Node *  pNodeToHide  )  [static]

void FrameSGallery::DoMoveLayer (  MoveLayerType  Reason  )  [protected, virtual]

Called when the Locked button is clicked in the layers gallery. Changes the lockedness of the selected layer, if there is one. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> (Based on Mark N's function in the Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) Parameters: Reason  = how the layer should be moved [INPUTS] Returns: - Note: Same as LayerSGallery version but uses FRAME_MOVE Reimplemented from LayerSGallery. Definition at line 2706 of file sgframe.cpp. { SGDisplayLayer* pLayerGalItem = GetSelectedLayerGalItem(); if (pLayerGalItem != NULL) { OpLayerGalParam Param(FRAME_MOVE, pSpread); Param.pLayer = pLayerGalItem->GetDisplayedLayer(); switch (Reason) { case (MOVELAYER_UPONE) : Param.pContextNode = Param.pLayer->FindNextLayer(); Param.AttDir = NEXT; break; case (MOVELAYER_DOWNONE) : Param.pContextNode = Param.pLayer->FindPrevLayer(); Param.AttDir = PREV; break; default: ERROR3("Unrecognised MoveLayer reason"); break; } if (Param.pContextNode != NULL) { // Redraw after the op if both this layer and the one it's moving in front/behind // is also visible Param.MoveRedraw = ((Layer*)Param.pContextNode)->IsVisible() && Param.pLayer->IsVisible(); // The above won't work in an undo or redo, so always redraw Param.MoveRedraw = TRUE; OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_LAYERGALCHANGE); if (pOpDesc != NULL) pOpDesc->Invoke((OpParam*)&Param); else { ERROR3("Couldn't find OPTOKEN_LAYERGALCHANGE op descriptor"); } } } }

BOOL FrameSGallery::DoPreviewAnimation (   )  [protected, virtual]

Previews the current animation. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 30/4/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 3108 of file sgframe.cpp. { // Check to see if the operation is available // No longer required as the button is hooked into the real op //String_256 ShadeReason; //OpState State; //State = OpGrabAllFrames::GetState(&ShadeReason, NULL); //if (State.Greyed) // return FALSE; // Normally we want to invoke the grab frame, but we will sneak in that // if the shift key is pressed then we will grab all frames. OpDescriptor* pOpDesc = NULL; // Is the shift key pressed? if (KeyPress::IsAdjustPressed()) pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABALLFRAMES); else pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABFRAME); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_GRABFRAME/_GRABALLFRAMES op descriptor"); } return TRUE; }

BOOL FrameSGallery::DoRegenerateFrames (   )  [protected, virtual]

While previewing an animation, if the spread properties are changed we neeed to regenerate the frame layers. This function invokes the correct Op. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 14/05/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 3179 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABALLFRAMES); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_GRABALLFRAMES op descriptor"); } return TRUE; }

BOOL FrameSGallery::DoRegenerateSingleFrame (   )  [protected, virtual]

While previewing an animation, if the frame layer properties are changed we neeed to regenerate the active frame. This function invokes the correct Op. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 14/05/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 3151 of file sgframe.cpp. { OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_FRAME_GRABFRAME); GIFAnimationExportParam Param; if (pOpDesc != NULL) pOpDesc->Invoke(&Param); else { ERROR3("Couldn't find OPTOKEN_FRAME_GRABALLFRAMES op descriptor"); } return TRUE; }

BOOL FrameSGallery::DoSaveAnimation (   )  [protected, virtual]

Saves out the current animation to file. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 30/4/97 Parameters: -  [INPUTS] Returns: True if worked ok, False otherwise Definition at line 3082 of file sgframe.cpp. { // Not required at present /* OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_SAVEANIMATEDGIF); if (pOpDesc != NULL) pOpDesc->Invoke(); else { ERROR3("Couldn't find OPTOKEN_FRAME_COPYFRAME op descriptor"); } */ return TRUE; }

void FrameSGallery::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> (Based on Jason's Layer gallery code) Date: 16/4/97 (Based on Jason's Layer gallery code) 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 LayerSGallery. Definition at line 2773 of file sgframe.cpp. { EnableGadget(_R(IDC_GALLERY_UPONE), !ShadeIt); EnableGadget(_R(IDC_GALLERY_DOWNONE), !ShadeIt); EnableGadget(_R(IDC_GALLERY_PROPERTIES),!ShadeIt); EnableGadget(_R(IDC_GALLERY_COPY), !ShadeIt && !IsSelectedItemGuideLayer()); EnableGadget(_R(IDC_FRAME_DELETE), !ShadeIt); EnableGadget(_R(IDC_BTN_MULTILAYER), !ShadeIt); EnableGadget(_R(IDC_BTN_ALLVISIBLE), !ShadeIt); //EnableGadget(_R(IDC_GALLERY_NAME), !ShadeIt); EnableGadget(_R(IDC_GALLERY_COPY), !ShadeIt && !IsSelectedItemGuideLayer()); UpdateFrameRelatedButtons(); }

BOOL FrameSGallery::EnsureFrameLayerIntegrity (  Spread *  pSpread  )  [static]

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.This function should be called before any frame related actions are carried out It will ensure that all the visible layers are frame layers. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 21/5/97 Returns: True if worked ok, False otherwise. Errors: - See also: - Definition at line 2199 of file sgframe.cpp. { ERROR2IF(pSpread == NULL,FALSE,"EnsureFrameLayerIntegrity null spread passed in"); // For the present moment just ensure that the active layer is a frame layer //Layer * pActiveLayer = pSpread->FindActiveLayer(); //if (pActiveLayer) // pActiveLayer->SetFrame(TRUE); /* #if _DEBUG // Find out whether the operation thinks it is required or not String_256 ShadeReason; OpState State; State = OpCombineLayersToFrameLayer::GetState(&ShadeReason, NULL); if (!State.Greyed) { // Try and find the operation we want to use OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_COMBINELAYERSTOFRAMELAYER); if (pOpDesc != NULL) { // We