EditorCommand Class Reference

#include <EditorCommand.hh>

Inherits GUICommand.

Inherited by AboutCmd, AddASCmd, AddBridgeCmd, AddBusCmd, AddFUCmd, AddFUFromHDBCmd, AddGCUCmd, AddIUCmd, AddIUFromHDBCmd, AddRFCmd, AddRFFromHDBCmd, AddSocketCmd, BlocksConnectICCmd, CallExplorerPluginCmd, CloseDocumentCmd, CopyComponentCmd, CutComponentCmd, DeleteComponentCmd, EditAddressSpacesCmd, EditBusOrderCmd, EditConnectionsCmd, EditImmediateSlotsCmd, EditMachineCmd, EditOptionsCmd, EditOTAFormatsCmd, EditTemplatesCmd, FitHeightCmd, FitWidthCmd, FitWindowCmd, FullyConnectBussesCmd, ImplementMachineCmd, ModifyComponentCmd, NewDocumentCmd, OpenDocumentCmd, PasteComponentCmd, PrintCmd, PrintPreviewCmd, ProDeExportCmd, QuitCmd, RedoCmd, SaveDocumentAsCmd, SaveDocumentCmd, SaveOptionsCmd, SelectCmd, ToggleUnitDetailsCmd, UndoCmd, VerifyMachineCmd, VLIWConnectICCmd, ZoomInCmd, and ZoomOutCmd.

Collaboration diagram for EditorCommand:

Public Member Functions
	EditorCommand (std::string name, wxWindow *parent=NULL)
virtual	~EditorCommand ()
void	setView (wxView *view)
wxView *	view () const
virtual std::string	icon () const
virtual bool	isEnabled ()
Public Member Functions inherited from GUICommand
	GUICommand (std::string name, wxWindow *parent)
virtual	~GUICommand ()
virtual int	id () const =0
virtual GUICommand *	create () const =0
virtual bool	Do ()=0
virtual bool	isChecked () const
virtual std::string	shortName () const
void	setParentWindow (wxWindow *view)
wxWindow *	parentWindow () const
std::string	name () const

Private Attributes
wxView *	view_
	The view assigned for the command. More...

Detailed Description

Base class for editor commands, which can be added to menus or toolbar.

Definition at line 46 of file EditorCommand.hh.

Constructor & Destructor Documentation

EditorCommand()

EditorCommand::EditorCommand	(	std::string	name,
		wxWindow *	parent = NULL
	)

The Constructor.

Definition at line 42 of file EditorCommand.cc.

                                                             :
    GUICommand(name, parent),
    view_(NULL) {
 
}

~EditorCommand()

EditorCommand::~EditorCommand ( )

virtual

The Destructor.

Definition at line 53 of file EditorCommand.cc.

                              {
}

Member Function Documentation

icon()

string EditorCommand::icon ( ) const

virtual

Returns path to the icon of the command to be used on the toolbar.

Returns

Base class implementation returns default icon's path.

Implements GUICommand.

Reimplemented in PasteComponentCmd, CallExplorerPluginCmd, DeleteComponentCmd, EditOptionsCmd, EditOTAFormatsCmd, EditTemplatesCmd, ImplementMachineCmd, ModifyComponentCmd, PrintPreviewCmd, CloseDocumentCmd, CopyComponentCmd, CutComponentCmd, EditConnectionsCmd, NewDocumentCmd, OpenDocumentCmd, SaveDocumentAsCmd, SaveDocumentCmd, SaveOptionsCmd, VerifyMachineCmd, AboutCmd, AddFUFromHDBCmd, AddIUFromHDBCmd, AddRFFromHDBCmd, EditImmediateSlotsCmd, PrintCmd, QuitCmd, RedoCmd, SelectCmd, UndoCmd, EditAddressSpacesCmd, FitHeightCmd, FitWidthCmd, FitWindowCmd, ZoomInCmd, ZoomOutCmd, and EditMachineCmd.

Definition at line 87 of file EditorCommand.cc.

                          {
    return ProDeConstants::CMD_ICON_DEFAULT;
}

References ProDeConstants::CMD_ICON_DEFAULT.

isEnabled()

bool EditorCommand::isEnabled ( )

virtual

Returns true if command is currently executable, otherwise false.

Base class implementation returns always false.

Returns

True if command is currently executable, otherwise false.

Implements GUICommand.

Reimplemented in FullyConnectBussesCmd, PasteComponentCmd, CallExplorerPluginCmd, EditOTAFormatsCmd, EditTemplatesCmd, ImplementMachineCmd, AddBridgeCmd, AddGCUCmd, DeleteComponentCmd, EditConnectionsCmd, EditOptionsCmd, ModifyComponentCmd, PrintPreviewCmd, SaveOptionsCmd, VerifyMachineCmd, AddASCmd, AddBusCmd, AddFUCmd, AddFUFromHDBCmd, AddIUCmd, AddIUFromHDBCmd, AddRFCmd, AddRFFromHDBCmd, AddSocketCmd, CloseDocumentCmd, CopyComponentCmd, CutComponentCmd, EditImmediateSlotsCmd, NewDocumentCmd, OpenDocumentCmd, ProDeExportCmd, SaveDocumentAsCmd, SaveDocumentCmd, EditAddressSpacesCmd, FitHeightCmd, FitWidthCmd, FitWindowCmd, PrintCmd, QuitCmd, RedoCmd, SelectCmd, ToggleUnitDetailsCmd, UndoCmd, VLIWConnectICCmd, ZoomInCmd, ZoomOutCmd, BlocksConnectICCmd, EditBusOrderCmd, EditMachineCmd, and AboutCmd.

Definition at line 100 of file EditorCommand.cc.

                         {
    return false;
}

setView()

void EditorCommand::setView

(

wxView *

view

)

Sets the MDFView of the command.

Parameters

view	MDFView to be assigned for the command.

Definition at line 65 of file EditorCommand.cc.

                                   {
    view_ = view;
}

References view(), and view_.

Referenced by MainFrame::onCommandEvent(), SelectTool::onMouseEvent(), and MainFrame::onUpdateUI().

Here is the call graph for this function:

view()

wxView * EditorCommand::view

(

)

const

Returns MDFView of the command.

Returns

MDFView of the command.

Definition at line 76 of file EditorCommand.cc.

                          {
    return view_;
}

References view_.

Referenced by EditMachineCmd::Do(), EditAddressSpacesCmd::Do(), ZoomInCmd::Do(), FitHeightCmd::Do(), FitWidthCmd::Do(), ZoomOutCmd::Do(), FitWindowCmd::Do(), AddIUFromHDBCmd::Do(), PrintCmd::Do(), EditBusOrderCmd::Do(), RedoCmd::Do(), SelectCmd::Do(), EditImmediateSlotsCmd::Do(), ToggleUnitDetailsCmd::Do(), UndoCmd::Do(), AddFUFromHDBCmd::Do(), AddRFFromHDBCmd::Do(), BlocksConnectICCmd::Do(), ModifyComponentCmd::Do(), CutComponentCmd::Do(), DeleteComponentCmd::Do(), AddFUCmd::Do(), AddRFCmd::Do(), AddASCmd::Do(), EditConnectionsCmd::Do(), AddSocketCmd::Do(), VLIWConnectICCmd::Do(), AddBusCmd::Do(), VerifyMachineCmd::Do(), AddIUCmd::Do(), CopyComponentCmd::Do(), ImplementMachineCmd::Do(), AddBridgeCmd::Do(), CallExplorerPluginCmd::Do(), EditTemplatesCmd::Do(), EditOTAFormatsCmd::Do(), ProDeExportCmd::Do(), AddGCUCmd::Do(), PasteComponentCmd::Do(), FullyConnectBussesCmd::Do(), ToggleUnitDetailsCmd::isChecked(), BlocksConnectICCmd::isEnabled(), UndoCmd::isEnabled(), RedoCmd::isEnabled(), VLIWConnectICCmd::isEnabled(), ProDeExportCmd::isEnabled(), FullyConnectBussesCmd::isEnabled(), and setView().

Member Data Documentation

view_

wxView* EditorCommand::view_

private

The view assigned for the command.

Definition at line 58 of file EditorCommand.hh.

Referenced by setView(), and view().

---

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

• EditorCommand.hh
• EditorCommand.cc