PlugInOpDescriptor Class Reference

New PlugInOpDescriptor class whose purpose in life is to allow an OpDescriptor to be created which instead of using a resource id to get the menu item/operation item text, uses a string resource. This then means we can use the name from the plug-in instead of having to resource all names! More...

#include <plugop.h>

Inheritance diagram for PlugInOpDescriptor:

List of all members.

Public Member Functions
	PlugInOpDescriptor (const TCHAR *pcszToken, const String_64 &NewMenuText, CCRuntimeClass *pClass=CC_RUNTIME_CLASS(PlugInOp), pfnGetState gs=PlugInOp::GetState)
	Constructs the new PlugInOpDescriptor.
virtual BOOL	GetText (String_256 *Description, OpTextFlags WhichText)
	This function will use the TextID and ModuleID values to obtain a 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.
Protected Attributes
String_64	m_MenuText
Private Member Functions
	CC_DECLARE_DYNAMIC (PlugInOpDescriptor)

---

Detailed Description

New PlugInOpDescriptor class whose purpose in life is to allow an OpDescriptor to be created which instead of using a resource id to get the menu item/operation item text, uses a string resource. This then means we can use the name from the plug-in instead of having to resource all names!

Author:

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

Date:

11/12/96

Definition at line 190 of file plugop.h.

---

Constructor & Destructor Documentation

PlugInOpDescriptor::PlugInOpDescriptor (  const TCHAR *  pcszToken, const String_64 &  NewMenuText, CCRuntimeClass *  pClass = CC_RUNTIME_CLASS(PlugInOp), pfnGetState  gs = PlugInOp::GetState )

Constructs the new PlugInOpDescriptor. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/96 Parameters: pcszToken  the "OpToken" (OLE verb?) of the associated Operation [INPUTS] NewMenuText string resource of menu text pClass the runtime class to use, defaults to PlugInOp. gs the GetState function to use -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 140 of file plugop.cpp. : OpDescriptor( 0, // tool ID _R(IDS_PHOTOSHOP_PLUGIN), // String resource ID (use same for all) pClass, //CC_RUNTIME_CLASS(PlugInOp), // Runtime class (TCHAR*) pcszToken, // OpToken gs, // GetState function NULL, // help ID NULL, // bubble help NULL, // resource ID NULL, // control ID TRUE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation NULL, // String for one copy only error (DONT_GREY_WHEN_SELECT_INSIDE | GREY_WHEN_NO_CURRENT_DOC) // Auto state flags ) { m_MenuText = NewMenuText; }

---

Member Function Documentation

PlugInOpDescriptor::CC_DECLARE_DYNAMIC (  PlugInOpDescriptor   )  [private]

OpState PlugInOpDescriptor::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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/96 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 178 of file plugop.cpp. { // At present, this item is always available. OpState OpSt; return OpSt; }

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

This function will use the TextID and ModuleID values to obtain a 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: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 11/12/96 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. See also: OpDescriptor::GetText GetDescription Note: Made virtual by Neville 11/12/96 We do this so that we do not have to store a string with every OpDesciptor. This would be ok if we had dynamic strings but of course we don't. The overhead would be unacceptable. So we use this overriding class instead. Reimplemented from OpDescriptor. Definition at line 209 of file plugop.cpp. { String_256 ResourceText = m_MenuText; // ( TextID, ModuleID ); // This string should contain various elements for each part of the apply, undo, redo text // each separated by a semi colon. So we will fake this up in the string using the // text that we will have set, which is the plug-in name on the menu, for the apply name. ResourceText += ";"; // DO NOT internationlise this! ResourceText += m_MenuText; // add undo text ResourceText += ";"; // DO NOT internationlise this! ResourceText += m_MenuText; // add redo text TCHAR* ok = NULL; // The rest is the same as the main OpDescriptor... // 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; }

---

Member Data Documentation

String_64 PlugInOpDescriptor::m_MenuText [protected]

Definition at line 207 of file plugop.h.

---

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

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

---