FrameInFrontOpDescriptor Class Reference

New FrameInFrontOpDescriptor class whose purpose is to allow an OpDescriptor to be created which allows us to over-ride the virtual function GetText. More...

#include <zordops.h>

Inheritance diagram for FrameInFrontOpDescriptor:

List of all members.

Public Member Functions
	FrameInFrontOpDescriptor (const TCHAR *pcszToken, CCRuntimeClass *pClass=CC_RUNTIME_CLASS(FrameInFrontOpDescriptor), pfnGetState gs=FrameInFrontOpDescriptor::GetState)
	OpCombineLayersToFrameLayer constructorOpCombineLayersToFrameLayer constructor For finding the OpCombineLayersToFrameLayer's state. Performs the OpCombineLayersToFrameLayer operation. This sees if we have frame layers present. If so, then it checks if there are any non-frame layers present. If we have a mixture of frame and non-frame layers then combine all non-frame layers together onto one layer and make it a frame layer.Performs the OpCombineLayersToFrameLayer operation. This sees if we have frame layers present. If so, then it checks if there are any non-frame layers present. If we have a mixture of frame and non-frame layers then combine all non-frame layers together onto one layer and make it a frame layer.Constructs the new FrameInFrontOpDescriptor.
virtual BOOL	GetText (String_256 *Description, OpTextFlags WhichText)
	Depending upon the document Mode, (i.e Frame or Layer), this function will obtain the String resource describing an operation. String resources may have one or more text descriptions in them, therefore, a TextFlag can be used to identify the the appropriate text required.
Static Public Member Functions
static OpState	GetState (String_256 *psName, OpDescriptor *pOpDesc)
	Returns the state that this operation should appear in the menus or as a buttom, for example - greyed out, or ticked.
Private Member Functions
	CC_DECLARE_DYNAMIC (FrameInFrontOpDescriptor)

---

Detailed Description

New FrameInFrontOpDescriptor class whose purpose is to allow an OpDescriptor to be created which allows us to over-ride the virtual function GetText.

Author:

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

Date:

21/10/97

Definition at line 338 of file zordops.h.

---

Constructor & Destructor Documentation

FrameInFrontOpDescriptor::FrameInFrontOpDescriptor (  const TCHAR *  pcszToken, CCRuntimeClass *  pClass = CC_RUNTIME_CLASS(FrameInFrontOpDescriptor), pfnGetState  gs = FrameInFrontOpDescriptor::GetState )

OpCombineLayersToFrameLayer constructorOpCombineLayersToFrameLayer constructor For finding the OpCombineLayersToFrameLayer's state. Performs the OpCombineLayersToFrameLayer operation. This sees if we have frame layers present. If so, then it checks if there are any non-frame layers present. If we have a mixture of frame and non-frame layers then combine all non-frame layers together onto one layer and make it a frame layer.Performs the OpCombineLayersToFrameLayer operation. This sees if we have frame layers present. If so, then it checks if there are any non-frame layers present. If we have a mixture of frame and non-frame layers then combine all non-frame layers together onto one layer and make it a frame layer.Constructs the new FrameInFrontOpDescriptor. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/96 Parameters: pcszToken  the "OpToken" of the associated Operation [INPUTS] pClass the runtime class to use. gs the GetState function to use. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 3314 of file zordops.cpp. : OpDescriptor( 0, // tool ID _R(IDS_MOVELAYERINFRONT), // String resource ID (use same for all) pClass, //CC_RUNTIME_CLASS(PlugInOp), Runtime class (TCHAR*) pcszToken, // OpToken gs, // GetState function 0, // help ID _R(IDBBL_MOVELAYERINFRONT), // bubble help _R(IDD_ANIMATIONBAR), // resource ID _R(IDC_FRAME_MOVEUPAFRAME), // control ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation 0, // String for one copy only error (GREY_WHEN_NO_CURRENT_DOC | GREY_WHEN_NO_SELECTION) // Auto state flags ) {}

---

Member Function Documentation

FrameInFrontOpDescriptor::CC_DECLARE_DYNAMIC (  FrameInFrontOpDescriptor   )  [private]

OpState FrameInFrontOpDescriptor::GetState (  String_256 *  psName, OpDescriptor *  pOpDesc )  [static]

Returns the state that this operation should appear in the menus or as a buttom, for example - greyed out, or ticked. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> Date: 21/10/97 Parameters: pDesc  --- A pointer to a String. GetState fills this with the [INPUTS] appropriate details for the conditions arising eg. why "Previous Zoom" is greyed out. pOpDesc --- A pointer to the OpDescriptor whose state is being queried. Returns: An OpState containing the flags that show what is valid. Definition at line 3351 of file zordops.cpp. { // At present, this item is always available. OpState OpSt; return OpSt; }

BOOL FrameInFrontOpDescriptor::GetText (  String_256 *  Description, OpTextFlags  WhichText )  [virtual]

Depending upon the document Mode, (i.e Frame or Layer), this function will obtain the String resource describing an operation. String resources may have one or more text descriptions in them, therefore, a TextFlag can be used to identify the the appropriate text required. Author: Ranbir_Rana (Xara Group Ltd) <camelotdev@xara.com> (From Mario code in base class.) Date: 21/10/97 Parameters: TextFlag  - Identifies which text string to retrieve from the string resource [INPUTS] Description  - Operation description string if it is found or [OUTPUTS] NULL otherwise. Returns: TRUE if successfully retrieves the string and FALSE othersise. Reimplemented from OpDescriptor. Definition at line 3376 of file zordops.cpp. { // Assume we are in layer mode. BOOL LayerMode = TRUE; TCHAR* ok; //Determine the document mode. Document* pDoc = Document::GetSelected(); // Ensure a valid ptr. if(pDoc) { // Get a ptr to the selected spread Spread* pSpread = pDoc->GetSelectedSpread(); // Ensure a valid spread ptr. if(pSpread) { // Are there any frame layers? Layer* pFrameLayer = pSpread->FindFirstFrameLayer(); //If a frame layer exists, then this is an animation doc. if (pFrameLayer) LayerMode = FALSE; } } if(LayerMode) { // In layer mode. String_256 ResourceText( _R(IDS_MOVELAYERINFRONT), ModuleID ); // Explicitly cast return value from GetDescription from a TCHAR* to a String_256 ok = GetDescription((TCHAR*) ResourceText, WhichText); } else { // In frame mode. String_256 ResourceText( _R(IDS_MOVEFRAMERINFRONT), ModuleID ); // Explicitly cast return value from GetDescription from a TCHAR* to a String_256 ok = GetDescription((TCHAR*) ResourceText, WhichText); } // if description is found then return true else return false if (ok) { *Description = String_256(ok); return TRUE; } else return FALSE; }

---

The documentation for this class was generated from the following files:

• Kernel/zordops.h (r1785/r1282)
• Kernel/zordops.cpp (r1785/r1282)

---