Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

OpWhatsThis Class Reference

This class represents the global "What's This?" operation. More...

#include <opwhat.h>

Inheritance diagram for OpWhatsThis:

Operation MessageHandler ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 OpWhatsThis ()
 OpWhatsThis constructor.
void Do (OpDescriptor *)
 Puts Camelot into the "What's This?" help mode.

Static Public Member Functions

static BOOL Init ()
 OpWhatsThis initialiser method.
static OpState GetState (String_256 *, OpDescriptor *)
 For finding the OpWhatsThis' state.

Detailed Description

This class represents the global "What's This?" operation.

Author:
Ollie_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/11/95
See also:
Documentation: Docs\*.*

Definition at line 122 of file opwhat.h.

Constructor & Destructor Documentation

OpWhatsThis::OpWhatsThis (   ) 
 

OpWhatsThis constructor.

Author:
Ollie_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/11/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: -

See also:
-

Definition at line 134 of file opwhat.cpp.

00134                         : Operation()                               
00135 {                              
00136 }

Member Function Documentation

void OpWhatsThis::Do (  OpDescriptor *   )  [virtual]
 

Puts Camelot into the "What's This?" help mode.

Author:
Ollie_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/11/95
Parameters:
OpDescriptor (unused) [INPUTS]
- [OUTPUTS]
Returns:
-

Errors: dunno yet

See also:
-

Reimplemented from Operation.

Definition at line 215 of file opwhat.cpp.

00216 {
00217     MessageBox(NULL, "Not implemented","Message", MB_OK );
00218 
00219     // Selecting this op drops the program into a mode where clicking on anything in
00220     // the program elicits help on it. The pointer should change when the program
00221     // is in this mode.
00222     
00223 #ifdef _DEBUG
00224     TRACEUSER( "Ollie", _T("What's This Operation -> Do it!\n"));
00225 #endif
00226 
00227     // Send a WM_HELP to a greyed button.
00228     // ?????
00229     
00230     // Drop into the context sensitive help mode.
00231     // BOOL Succeeded = HelpManager::EnterHelpMode();
00232     
00233     End();
00234 }

OpState OpWhatsThis::GetState (  String_256 *  UIDescription,
OpDescriptor * 
)  [static]
 

For finding the OpWhatsThis' state.

Author:
Ollie_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/11/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
The state of the OpWhatsThis

Errors: -

See also:
-

Definition at line 191 of file opwhat.cpp.

00192 {
00193     OpState OpSt;
00194         
00195     OpSt.Greyed = FALSE;
00196 
00197     return(OpSt);                 // isn't this returning a local variable????????
00198 }

BOOL OpWhatsThis::Init (  void   )  [static]
 

OpWhatsThis initialiser method.

Author:
Ollie_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/11/95
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
TRUE if the operation could be successfully initialised FALSE if no more memory could be allocated

Errors: ERROR will be called if there was insufficient memory to allocate the operation.

See also:
-

Reimplemented from SimpleCCObject.

Definition at line 156 of file opwhat.cpp.

00157 {
00158     return (RegisterOpDescriptor(0,                                     // Module (Tool) ID
00159                                 _R(IDS_WHATSTHISOP),                        // String resource ID
00160                                 CC_RUNTIME_CLASS(OpWhatsThis),          // Ops runtime class
00161                                 OPTOKEN_WHATSTHIS,                      // Optoken ID
00162                                 OpWhatsThis::GetState,                  // Pointer to the GetState function
00163                                 0,  /* help ID */                       // help identifier
00164                                 _R(IDBBL_WHATSTHIS),                        // string resource for bubble help
00165                                 0,                                      // resource ID
00166                                 0,                                      // control ID
00167                                 SYSTEMBAR_ILLEGAL,                      // group bar ID
00168                                 TRUE,                                   // Receive messages
00169                                 FALSE,
00170                                 FALSE,
00171                                 0,
00172                                 0
00173                                  )); 
00174 }

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:59:11 2007 for Camelot by  doxygen 1.4.4