MSYS_DispatchEntry Struct Reference

Menu command definition. More...

#include <menusys.h>


Public Member Functions

bool operator== (const MSYS_DispatchEntry &rhs) const

Data Fields

const TCHAR * cmd
MSYS_Handler fn
bool unquote
const TCHAR * oneHelp
const TCHAR * longHelp


Detailed Description

Menu command definition.

All commands available via the MSYS menu are defined with in a table of these entries (see MSYS_Commands).

Parameters:
cmd Command text typed by the user to start the command. For example, "dir", "list". This must not be NULL.
fn Function implementing the command. This must not be NULL.
unquote Should quoted characters in the parameter list be unquoted prior to being passed to the function. Quoted entries like \n \t \r will be converted to the actual characters if this is set to true. If set to false, the actual text will be returned. Double quotes are always interpreted as delimiters of parameters and need to be quoted \" in order to be passed to the command function.
oneHelp One line summary help that will be displayed by the general "help" request. This should not exceed about 60 characters.
longHelp Extended help text that will be displayed by "help \<command\>" or "\<command\> -?". Help text will be automatically wrapped at 80 characters.

Definition at line 236 of file menusys.h.


Member Function Documentation

bool MSYS_DispatchEntry::operator== ( const MSYS_DispatchEntry rhs  )  const

Definition at line 540 of file menusys.cpp.

References cmd.


Field Documentation

const TCHAR* MSYS_DispatchEntry::cmd

Definition at line 237 of file menusys.h.

Referenced by Dispatch(), DoHelp(), DoSetOpt(), InitInternal(), MSYS_ShowHelp(), and operator==().

MSYS_Handler MSYS_DispatchEntry::fn

Definition at line 238 of file menusys.h.

Referenced by Dispatch(), DoHelp(), and DoSetOpt().

bool MSYS_DispatchEntry::unquote

Definition at line 239 of file menusys.h.

Referenced by Dispatch().

const TCHAR* MSYS_DispatchEntry::oneHelp

Definition at line 240 of file menusys.h.

Referenced by DoSetOpt(), and MSYS_ShowHelp().

const TCHAR* MSYS_DispatchEntry::longHelp

Definition at line 241 of file menusys.h.

Referenced by MSYS_ShowHelp().


The documentation for this struct was generated from the following files:
Generated on Wed Jun 20 09:28:35 2007 for menusys by  doxygen 1.5.2