OpGalleryCommand Class Reference

A polymorphic Op which is used for all generic gallery "commands". More...

#include <sgmenu.h>

Inheritance diagram for OpGalleryCommand:

List of all members.

Public Member Functions
virtual void	Do (OpDescriptor *pOpDesc)
	The nudge op's Do() function.
Static Public Member Functions
static BOOL	InitPolymorphicCommand (StringBase *OpToken, UINT32 MenuTextID)
	Given a Gallery command OpToken of the form "Gallery name:Command name" this creates a new OpDescriptor for the OpGalleryCommand Op. This in turn will provide an Upcall to the named Gallery containing the given command string, whenever the Op is invoked.
static OpState	GetCommandState (String_256 *ShadeReason, OpDescriptor *pOpDesc)
	OpGalleryCommand initialiser method.For finding OpGalleryCommand's state.
Static Protected Member Functions
static SuperGallery *	GetGalleryAndCommand (OpDescriptor *pOpDesc, String_32 *Command)
	Given a Gallery command OpDescriptor of the form "Gallery name:Command name" this returns a pointer to the gallery to use and the string "Command name" which is the command that gallery should apply.
Private Member Functions
	CC_DECLARE_DYNCREATE (OpGalleryCommand)

---

Detailed Description

A polymorphic Op which is used for all generic gallery "commands".

Author:

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

Date:

14/9/95

A gallery command is an OpToken along the lines "Colour gallery:DoSomething" where "Colour gallery" is the gallery bar name, and "DoSomething" is a command supported by either the "Colour gallery" bar or the SuperGallery base class.

See also:

SuperGallery::DoMenuCommand; SuperGallery::GetMenuCommandState; SuperGallery::GetMenuCommandName

Definition at line 239 of file sgmenu.h.

---

Member Function Documentation

OpGalleryCommand::CC_DECLARE_DYNCREATE (  OpGalleryCommand   )  [private]

void OpGalleryCommand::Do (  OpDescriptor *  pOpDesc  )  [virtual]

The nudge op's Do() function. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/9/95 Parameters: pOpDesc  = ptr to the op descriptor [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Reimplemented from Operation. Definition at line 362 of file sgmenu.cpp. { String_32 Command; SuperGallery *ParentGallery = GetGalleryAndCommand(pOpDesc, &Command); if (ParentGallery != NULL) ParentGallery->DoCommand(&Command); End(); }

OpState OpGalleryCommand::GetCommandState (  String_256 *  UIDescription, OpDescriptor *  pOpDesc )  [static]

OpGalleryCommand initialiser method.For finding OpGalleryCommand's state. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/9/95 Parameters: UIDescriptoin  - ptr to a string to place a description of what went wrong (if it did!) [INPUTS] OpDesc - The OpDescriptor for which we need the state UIDescription  is updated appropriately [OUTPUTS] Returns: The state of the OpGalleryCommand operation for the given OpDescriptor Definition at line 328 of file sgmenu.cpp. { String_32 Command; SuperGallery *ParentGallery = GetGalleryAndCommand(pOpDesc, &Command); if (ParentGallery != NULL) return(ParentGallery->GetCommandState(&Command, UIDescription)); ERROR3("Attempt to get state for non-existent Gallery command"); // Return a "safe" shaded state OpState OpSt; OpSt.Greyed = TRUE; *UIDescription = ""; return (OpSt); }

SuperGallery * OpGalleryCommand::GetGalleryAndCommand (  OpDescriptor *  pOpDesc, String_32 *  Command )  [static, protected]

Given a Gallery command OpDescriptor of the form "Gallery name:Command name" this returns a pointer to the gallery to use and the string "Command name" which is the command that gallery should apply. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 14/9/95 Parameters: pOpDesc  - The Op Descriptor for the Op [INPUTS] Command  - returned as "" or as the command string from the OpToken [OUTPUTS] Returns: NULL if the gallery wasn't found, or a pointer to the SuperGallery which should process the command Definition at line 251 of file sgmenu.cpp. { String_256 Temp = pOpDesc->Token; TCHAR *Str = (TCHAR *)Temp; *Command = TEXT(""); while (*Str != '\0' && *Str != ':') Str++; if (*Str == '\0') return(NULL); // Copy the right end of the string into Command for return *Command = (TCHAR *) (Str+1); // Find the gallery referenced by the left end of the string *Str = '\0'; // NULL Terminate the left end of the string String_32 Bob; Temp.Left(&Bob, 31); SuperGallery* pSuperGallery = SuperGallery::FindSuperGallery(Bob , GalleryBarNameLimitSize); if (pSuperGallery != NULL && pSuperGallery->IsKindOf(CC_RUNTIME_CLASS(SuperGallery))) return((SuperGallery *) pSuperGallery); // Not found, or isn't a gallery?! (eep!) return(NULL); }

BOOL OpGalleryCommand::InitPolymorphicCommand (  StringBase *  OpToken, UINT32  MenuTextID )  [static]

Given a Gallery command OpToken of the form "Gallery name:Command name" this creates a new OpDescriptor for the OpGalleryCommand Op. This in turn will provide an Upcall to the named Gallery containing the given command string, whenever the Op is invoked. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 15/9/95 Parameters: OpToken  - The OpToken for the new Op [INPUTS] This must be of the form "Gallery name:Gallery command" Each portion must be no more than 31 characters long MenuTextID - A String Resource ID for the menu item text Returns: TRUE if it succeeded, FALSE if not enough memory to register the OpDescriptor Definition at line 208 of file sgmenu.cpp. { return(RegisterOpDescriptor(0, // Tool ID MenuTextID, // String resource ID CC_RUNTIME_CLASS(OpGalleryCommand), // Runtime class (TCHAR *) (*OpToken), // Token string OpGalleryCommand::GetCommandState, // GetState function 0, // help ID 0, // bubble help 0, // resource ID 0, // control ID SYSTEMBAR_ILLEGAL, // Bar ID FALSE, // Recieve system messages FALSE, // Smart duplicate operation TRUE, // Clean operation 0, // No vertical counterpart 0, // String for one copy only error DONT_GREY_WHEN_SELECT_INSIDE // Auto state flags )); }

---

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

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

---