OpenDocumentCmd Class Reference

#include <OpenDocumentCmd.hh>

Inheritance diagram for OpenDocumentCmd:

Collaboration diagram for OpenDocumentCmd:

Public Member Functions
	OpenDocumentCmd ()
virtual	~OpenDocumentCmd ()
virtual bool	Do ()
virtual int	id () const
virtual OpenDocumentCmd *	create () const
virtual std::string	shortName () const
virtual std::string	icon () const
virtual bool	isEnabled ()
Public Member Functions inherited from EditorCommand
	EditorCommand (std::string name, wxWindow *parent=NULL)
virtual	~EditorCommand ()
void	setView (wxView *view)
wxView *	view () const
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

Detailed Description

EditorCommand for opening documents.

Definition at line 41 of file OpenDocumentCmd.hh.

Constructor & Destructor Documentation

OpenDocumentCmd()

OpenDocumentCmd::OpenDocumentCmd

(

)

The Constructor.

Definition at line 44 of file OpenDocumentCmd.cc.

                                :
    EditorCommand(ProDeConstants::CMD_NAME_OPEN_DOC) {
 
}

Referenced by create().

~OpenDocumentCmd()

OpenDocumentCmd::~OpenDocumentCmd ( )

virtual

The Destructor.

Definition at line 53 of file OpenDocumentCmd.cc.

{}

Member Function Documentation

create()

OpenDocumentCmd * OpenDocumentCmd::create ( ) const

virtual

Creates and returns a new instance of this command.

Returns

Newly created instance of this command.

Implements GUICommand.

Definition at line 109 of file OpenDocumentCmd.cc.

                              {
    return new OpenDocumentCmd();
}

References OpenDocumentCmd().

Here is the call graph for this function:

Do()

bool OpenDocumentCmd::Do ( )

virtual

Executes the command.

Returns

Always false. Returning true here would cause problems with the wxCommandProcessor, and the command is never undoable so it's safe to return false even if the command was succesfully executed.

Implements GUICommand.

Definition at line 64 of file OpenDocumentCmd.cc.

                    {
            
    wxDocManager* docManager = wxGetApp().docManager();
    
    // Disable multiple tabs if we're not using wxWidgets 2.8 or above   
    if (wxCHECK_VERSION(2, 8, 0)) {        
        docManager->CreateDocument(_T(""), 0);        
        return false;
    }
    else {
        // close the active document if there is any
        wxDocument *doc = docManager->GetCurrentDocument();
        if (doc) {
            if (doc->Close()) {
                doc->DeleteAllViews();
            }
            else { // cancel was pressed -> cancel the command
                return false;
            }
        }
    }
 
    // Open the document
    docManager->CreateDocument(_T(""), 0);        
    return false;
}

icon()

string OpenDocumentCmd::icon ( ) const

virtual

Returns path to the command's icon file.

Returns

Full path to the command's icon file.

Reimplemented from EditorCommand.

Definition at line 130 of file OpenDocumentCmd.cc.

                            {
    return ProDeConstants::CMD_ICON_OPEN_DOC;
}

References ProDeConstants::CMD_ICON_OPEN_DOC.

id()

int OpenDocumentCmd::id ( ) const

virtual

Returns id of this command.

Returns

ID for this command to be used in menus and toolbars.

Implements GUICommand.

Definition at line 98 of file OpenDocumentCmd.cc.

                          {
    return ProDeConstants::COMMAND_OPEN_DOC;
}

References ProDeConstants::COMMAND_OPEN_DOC.

isEnabled()

bool OpenDocumentCmd::isEnabled ( )

virtual

This command is always executable.

Returns

Always true.

Reimplemented from EditorCommand.

Definition at line 141 of file OpenDocumentCmd.cc.

                           {
    return true;
}

shortName()

string OpenDocumentCmd::shortName ( ) const

virtual

Returns short version of the command name.

Returns

Short name of the command to be used in the toolbar.

Reimplemented from GUICommand.

Definition at line 120 of file OpenDocumentCmd.cc.

                                 {
    return ProDeConstants::CMD_SNAME_OPEN_DOC;
}

References ProDeConstants::CMD_SNAME_OPEN_DOC.

---

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

• OpenDocumentCmd.hh
• OpenDocumentCmd.cc