CloseDocumentCmd Class Reference

#include <CloseDocumentCmd.hh>

Inheritance diagram for CloseDocumentCmd:

Collaboration diagram for CloseDocumentCmd:

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

Definition at line 41 of file CloseDocumentCmd.hh.

Constructor & Destructor Documentation

CloseDocumentCmd()

CloseDocumentCmd::CloseDocumentCmd

(

)

The Constructor.

Definition at line 44 of file CloseDocumentCmd.cc.

                                  :
    EditorCommand(ProDeConstants::CMD_NAME_CLOSE_DOC) {
 
}

Referenced by create().

~CloseDocumentCmd()

CloseDocumentCmd::~CloseDocumentCmd ( )

virtual

The Destructor.

Definition at line 53 of file CloseDocumentCmd.cc.

{}

Member Function Documentation

create()

CloseDocumentCmd * CloseDocumentCmd::create ( ) const

virtual

Creates and returns a new instance of this command.

Returns

Newly created instance of this command.

Implements GUICommand.

Definition at line 94 of file CloseDocumentCmd.cc.

                               {
    return new CloseDocumentCmd();
}

References CloseDocumentCmd().

Here is the call graph for this function:

Do()

bool CloseDocumentCmd::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 CloseDocumentCmd.cc.

                     {
    // close the active document
    wxDocManager* docManager = wxGetApp().docManager();
    wxDocument *doc = docManager->GetCurrentDocument();
    if (!doc)
    return false;
    if (doc->Close()) {
    doc->DeleteAllViews();
    }
    return false;
}

icon()

string CloseDocumentCmd::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 115 of file CloseDocumentCmd.cc.

                             {
    return ProDeConstants::CMD_ICON_CLOSE_DOC;
}

References ProDeConstants::CMD_ICON_CLOSE_DOC.

id()

int CloseDocumentCmd::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 83 of file CloseDocumentCmd.cc.

                           {
    return ProDeConstants::COMMAND_CLOSE_DOC;
}

References ProDeConstants::COMMAND_CLOSE_DOC.

isEnabled()

bool CloseDocumentCmd::isEnabled ( )

virtual

Returns true when the command is executable, false when not.

This command is executable when a document is open.

Returns

True, if a document is open.

Reimplemented from EditorCommand.

Definition at line 128 of file CloseDocumentCmd.cc.

                            {
    wxDocManager* manager = wxGetApp().docManager();
    if (manager->GetCurrentView() != NULL) {
    return true;
    }
    return false;
}

shortName()

string CloseDocumentCmd::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 105 of file CloseDocumentCmd.cc.

                                  {
    return ProDeConstants::CMD_SNAME_CLOSE_DOC;
}

References ProDeConstants::CMD_SNAME_CLOSE_DOC.

---

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

• CloseDocumentCmd.hh
• CloseDocumentCmd.cc