|
OpenASIP 2.2
|
#include <UserManualCmd.hh>


Public Member Functions | |
| UserManualCmd () | |
| virtual | ~UserManualCmd () |
| virtual bool | Do () |
| virtual int | id () const |
| virtual UserManualCmd * | create () const |
| virtual std::string | icon () const |
| virtual std::string | shortName () const |
| virtual bool | isEnabled () |
Public Member Functions inherited from GUICommand | |
| GUICommand (std::string name, wxWindow *parent) | |
| virtual | ~GUICommand () |
| virtual bool | isChecked () const |
| void | setParentWindow (wxWindow *view) |
| wxWindow * | parentWindow () const |
| std::string | name () const |
Static Public Attributes | |
| static const std::string | COMMAND_NAME = "User Manual" |
| Command name string. | |
| static const std::string | COMMAND_SHORT_NAME = "Help" |
| Short version of the command name string. | |
| static const std::string | COMMAND_ICON = "help.png" |
| Command icon file name. | |
| static const int | COMMAND_ID = 30000 |
| Command ID. | |
Private Member Functions | |
| bool | askFromUser () |
Static Private Attributes | |
| static bool | mimeTypesManagerInitialized_ = false |
| Tells if the singleton mime types manager has already been initialized. | |
wxCommand for displaying the TCE manual in the system's default PDF viewer.
Definition at line 40 of file UserManualCmd.hh.
| UserManualCmd::UserManualCmd | ( | ) |
The Constructor.
Definition at line 60 of file UserManualCmd.cc.
Referenced by create().
|
virtual |
|
private |
Fall back function which is called if a default pdf viewer is not found.
Definition at line 216 of file UserManualCmd.cc.
References assert, GUICommand::parentWindow(), Environment::pdfManual(), and WxConversion::toWxString().
Referenced by Do().

|
virtual |
Creates and returns a new instance of this command.
Implements GUICommand.
Definition at line 176 of file UserManualCmd.cc.
References UserManualCmd().

|
virtual |
Executes the command.
Implements GUICommand.
Definition at line 77 of file UserManualCmd.cc.
References askFromUser(), StringTools::chopString(), FileSystem::DIRECTORY_SEPARATOR, DS, Environment::environmentVariable(), FileSystem::fileIsExecutable(), mimeTypesManagerInitialized_, Environment::pdfManual(), and WxConversion::toWxString().

|
virtual |
Returns path to the command's icon file.
Implements GUICommand.
Definition at line 194 of file UserManualCmd.cc.
References COMMAND_ICON.
|
virtual |
Returns id of this command.
Implements GUICommand.
Definition at line 167 of file UserManualCmd.cc.
References COMMAND_ID.
|
virtual |
This command is always executable.
Implements GUICommand.
Definition at line 205 of file UserManualCmd.cc.
|
virtual |
Returns short version of the command name.
Reimplemented from GUICommand.
Definition at line 185 of file UserManualCmd.cc.
References COMMAND_SHORT_NAME.
|
static |
|
static |
Command ID.
Definition at line 58 of file UserManualCmd.hh.
Referenced by MainFrame::createHelpMenu(), ProximMainFrame::createMenubar(), HDBEditorMainFrame::HDBEditorMainFrame(), id(), and OSEdMainFrame::OSEdMainFrame().
|
static |
Command name string.
Definition at line 52 of file UserManualCmd.hh.
Referenced by ProDe::createDefaultOptions().
|
static |
Short version of the command name string.
Definition at line 54 of file UserManualCmd.hh.
Referenced by shortName().
|
staticprivate |
Tells if the singleton mime types manager has already been initialized.
Definition at line 64 of file UserManualCmd.hh.
Referenced by Do().