NewDocumentCmd Class Reference

#include <NewDocumentCmd.hh>

Inheritance diagram for NewDocumentCmd:

Collaboration diagram for NewDocumentCmd:

Public Member Functions
	NewDocumentCmd ()
virtual	~NewDocumentCmd ()
virtual bool	Do ()
virtual int	id () const
virtual NewDocumentCmd *	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 NewDocumentCmd.hh.

Constructor & Destructor Documentation

NewDocumentCmd()

NewDocumentCmd::NewDocumentCmd

(

)

The Constructor.

Definition at line 45 of file NewDocumentCmd.cc.

                              :
    EditorCommand(ProDeConstants::CMD_NAME_NEW_DOC) {
 
}

Referenced by create().

~NewDocumentCmd()

NewDocumentCmd::~NewDocumentCmd ( )

virtual

The Destructor.

Definition at line 54 of file NewDocumentCmd.cc.

{}

Member Function Documentation

create()

NewDocumentCmd * NewDocumentCmd::create ( ) const

virtual

Creates and returns a new instance of this command.

Returns

Newly created instance of this command.

Implements GUICommand.

Definition at line 110 of file NewDocumentCmd.cc.

                             {
    return new NewDocumentCmd();
}

References NewDocumentCmd().

Here is the call graph for this function:

Do()

bool NewDocumentCmd::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 65 of file NewDocumentCmd.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(""), wxDOC_NEW);
        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;
            }
        }
    }
    
    // create a new document
    docManager->CreateDocument(_T(""), wxDOC_NEW);
    return false;
}

icon()

string NewDocumentCmd::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 132 of file NewDocumentCmd.cc.

                           {
    return ProDeConstants::CMD_ICON_NEW_DOC;
}

References ProDeConstants::CMD_ICON_NEW_DOC.

id()

int NewDocumentCmd::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 99 of file NewDocumentCmd.cc.

                         {
    return ProDeConstants::COMMAND_NEW_DOC;
}

References ProDeConstants::COMMAND_NEW_DOC.

isEnabled()

bool NewDocumentCmd::isEnabled ( )

virtual

This command is always executable.

Returns

Always true.

Reimplemented from EditorCommand.

Definition at line 143 of file NewDocumentCmd.cc.

                          {
    return true;
}

shortName()

string NewDocumentCmd::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 121 of file NewDocumentCmd.cc.

                                {
    return ProDeConstants::CMD_SNAME_NEW_DOC;
}

References ProDeConstants::CMD_SNAME_NEW_DOC.

---

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

• NewDocumentCmd.hh
• NewDocumentCmd.cc