SaveDocumentAsCmd Class Reference

#include <SaveDocumentAsCmd.hh>

Inheritance diagram for SaveDocumentAsCmd:

Collaboration diagram for SaveDocumentAsCmd:

Public Member Functions
	SaveDocumentAsCmd ()
virtual	~SaveDocumentAsCmd ()
virtual bool	Do ()
virtual int	id () const
virtual SaveDocumentAsCmd *	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 saving documents with a new name.

Definition at line 41 of file SaveDocumentAsCmd.hh.

Constructor & Destructor Documentation

SaveDocumentAsCmd()

SaveDocumentAsCmd::SaveDocumentAsCmd

(

)

The Constructor.

Definition at line 43 of file SaveDocumentAsCmd.cc.

                                    :
    EditorCommand(ProDeConstants::CMD_NAME_SAVEAS_DOC) {
 
}

Referenced by create().

~SaveDocumentAsCmd()

SaveDocumentAsCmd::~SaveDocumentAsCmd ( )

virtual

The Destructor.

Definition at line 52 of file SaveDocumentAsCmd.cc.

{}

Member Function Documentation

create()

SaveDocumentAsCmd * SaveDocumentAsCmd::create ( ) const

virtual

Creates and returns a new instance of this command.

Returns

Newly created instance of this command.

Implements GUICommand.

Definition at line 87 of file SaveDocumentAsCmd.cc.

                                {
    return new SaveDocumentAsCmd();
}

References SaveDocumentAsCmd().

Here is the call graph for this function:

Do()

bool SaveDocumentAsCmd::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 63 of file SaveDocumentAsCmd.cc.

                      {
    wxCommandEvent dummy(wxID_SAVEAS, 0);
    wxGetApp().docManager()->OnFileSaveAs(dummy);
    return false;
}

References dummy.

icon()

string SaveDocumentAsCmd::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 108 of file SaveDocumentAsCmd.cc.

                              {
    return ProDeConstants::CMD_ICON_SAVEAS_DOC;
}

References ProDeConstants::CMD_ICON_SAVEAS_DOC.

id()

int SaveDocumentAsCmd::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 76 of file SaveDocumentAsCmd.cc.

                            {
    return ProDeConstants::COMMAND_SAVEAS_DOC;
}

References ProDeConstants::COMMAND_SAVEAS_DOC.

isEnabled()

bool SaveDocumentAsCmd::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 121 of file SaveDocumentAsCmd.cc.

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

shortName()

string SaveDocumentAsCmd::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 98 of file SaveDocumentAsCmd.cc.

                                   {
    return ProDeConstants::CMD_SNAME_SAVEAS_DOC;
}

References ProDeConstants::CMD_SNAME_SAVEAS_DOC.

---

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

• SaveDocumentAsCmd.hh
• SaveDocumentAsCmd.cc