SaveDocumentCmd Class Reference

#include <SaveDocumentCmd.hh>

Inheritance diagram for SaveDocumentCmd:

Collaboration diagram for SaveDocumentCmd:

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

Constructor & Destructor Documentation

SaveDocumentCmd()

SaveDocumentCmd::SaveDocumentCmd

(

)

The Constructor.

Definition at line 44 of file SaveDocumentCmd.cc.

                                :
    EditorCommand(ProDeConstants::CMD_NAME_SAVE_DOC) {
 
}

Referenced by create().

~SaveDocumentCmd()

SaveDocumentCmd::~SaveDocumentCmd ( )

virtual

The Destructor.

Definition at line 53 of file SaveDocumentCmd.cc.

{}

Member Function Documentation

create()

SaveDocumentCmd * SaveDocumentCmd::create ( ) const

virtual

Creates and returns a new instance of this command.

Returns

Newly created instance of this command.

Implements GUICommand.

Definition at line 102 of file SaveDocumentCmd.cc.

                              {
    return new SaveDocumentCmd();
}

References SaveDocumentCmd().

Here is the call graph for this function:

Do()

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

                    {
    wxDocument* doc = wxGetApp().docManager()->GetCurrentDocument();
    assert(doc != NULL);
 
    // warning: Dirty trick to avoid file dialog on saving a document
    // already assigned into a specific file name. wxID_SAVE handler
    // always opens file dialog. Checking that file name does not
    // contain a . should verify that the document has not been
    // saved before.
    wxString currentDocFilename = doc->GetFilename();
    if (doc->GetFilename().Find('.') == -1) {
        wxCommandEvent dummy(wxID_SAVE, 0);
        wxGetApp().docManager()->OnFileSave(dummy);
    } else {
        doc->OnSaveDocument(currentDocFilename);
    }
 
    return false;
}

References assert, and dummy.

icon()

string SaveDocumentCmd::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 124 of file SaveDocumentCmd.cc.

                            {
    return ProDeConstants::CMD_ICON_SAVE_DOC;
}

References ProDeConstants::CMD_ICON_SAVE_DOC.

id()

int SaveDocumentCmd::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 91 of file SaveDocumentCmd.cc.

                          {
    return ProDeConstants::COMMAND_SAVE_DOC;
}

References ProDeConstants::COMMAND_SAVE_DOC.

isEnabled()

bool SaveDocumentCmd::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 137 of file SaveDocumentCmd.cc.

                           {
    wxDocument* doc = wxGetApp().docManager()->GetCurrentDocument();
    if (doc != NULL && doc->IsModified()) {
    return true;
    }
    return false;
}

shortName()

string SaveDocumentCmd::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 113 of file SaveDocumentCmd.cc.

                                 {
    return ProDeConstants::CMD_SNAME_SAVE_DOC;
}

References ProDeConstants::CMD_SNAME_SAVE_DOC.

---

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

• SaveDocumentCmd.hh
• SaveDocumentCmd.cc