Gui::PythonEditorView Class Reference

#include <EditorView.h>

Public Slots

void executeScript ()
 Runs the opened script in the macro manager. More...
 
void hideDebugMarker ()
 
void showDebugMarker (int line)
 
void startDebug ()
 
void toggleBreakpoint ()
 
- Public Slots inherited from Gui::MDIView
virtual void setOverrideCursor (const QCursor &)
 
virtual void restoreOverrideCursor ()
 

Public Member Functions

bool onHasMsg (const char *pMsg) const
 Checks if the action pMsg is available. More...
 
bool onMsg (const char *pMsg, const char **ppReturn)
 Runs the action specified by pMsg. More...
 
 PythonEditorView (PythonEditor *editor, QWidget *parent)
 
 ~PythonEditorView ()
 
- Public Member Functions inherited from Gui::EditorView
bool canClose (void)
 Checking on close state. More...
 
 EditorView (QPlainTextEdit *editor, QWidget *parent)
 Constructs a EditorView which is a child of 'parent', with the name 'name'. More...
 
QPlainTextEditgetEditor () const
 
const char * getName (void) const
 returns the name of the view (important for messages) More...
 
void OnChange (Base::Subject< const char * > &rCaller, const char *rcReason)
 
bool onHasMsg (const char *pMsg) const
 Checks if the action pMsg is available. More...
 
bool onMsg (const char *pMsg, const char **ppReturn)
 Runs the action specified by pMsg. More...
 
void onUpdate (void)
 get called when the document is updated More...
 
void setDisplayName (DisplayName)
 
 ~EditorView ()
 Destroys the object and frees any allocated resources. More...
 
bool open (const QString &f)
 Opens the file fileName. More...
 
bool saveAs ()
 Saves the content of the editor to a file specified by the appearing file dialog. More...
 
void cut ()
 Copies the selected text to the clipboard and deletes it from the text edit. More...
 
void copy ()
 Copies any selected text to the clipboard. More...
 
void paste ()
 Pastes the text from the clipboard into the text edit at the current cursor position. More...
 
void undo ()
 Undoes the last operation. More...
 
void redo ()
 Redoes the last operation. More...
 
void print ()
 Shows the printer dialog. More...
 
void printPdf ()
 Prints the document into a Pdf file. More...
 
void printPreview ()
 Show a preview dialog. More...
 
void print (QPrinter *)
 
QStringList undoActions () const
 Get the undo history. More...
 
QStringList redoActions () const
 Get the redo history. More...
 
QString fileName () const
 
- Public Member Functions inherited from Gui::MDIView
virtual bool canClose (void)
 overwrite when checking on close state More...
 
virtual void deleteSelf ()
 delete itself More...
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
 MDIView (Gui::Document *pcDocument, QWidget *parent, Qt::WindowFlags wflags=Qt::WindowFlags())
 View constructor Attach the view to the given document. More...
 
virtual bool onHasMsg (const char *pMsg) const
 Message handler test. More...
 
virtual bool onMsg (const char *pMsg, const char **ppReturn)
 Message handler. More...
 
virtual void onRelabel (Gui::Document *pDoc)
 get called when the document is updated More...
 
virtual void viewAll ()
 
 ~MDIView ()
 View destructor Detach the view from the document, if attached. More...
 
QSize minimumSizeHint () const
 
virtual void setCurrentViewMode (ViewMode mode)
 If b is set to FullScreen the MDI view is displayed in full screen mode, if b is set to TopLevel then it is displayed as an own top-level window, otherwise (Normal) as tabbed window. More...
 
ViewMode currentViewMode () const
 
template<typename _T >
_T getActiveObject (const char *name, App::DocumentObject **parent=nullptr, std::string *subname=nullptr) const
 access getter for the active object list More...
 
void setActiveObject (App::DocumentObject *o, const char *n, const char *subname=nullptr)
 
bool hasActiveObject (const char *n) const
 
bool isActiveObject (App::DocumentObject *o, const char *n, const char *subname=nullptr) const
 
virtual bool containsViewProvider (const ViewProvider *) const
 containsViewProvider Checks if the given view provider is part of this view. The default implementation returns false. More...
 
void savePrinterSettings (QPrinter *printer)
 Save the printer configuration. More...
 
void restorePrinterSettings (QPrinter *printer)
 Restore the printer configuration. More...
 
- Public Member Functions inherited from Gui::BaseView
 BaseView (Gui::Document *pcDocument=nullptr)
 View constructor Attach the view to the given document. More...
 
virtual ~BaseView ()
 View destructor Detach the view from the document, if attached! More...
 
void setDocument (Gui::Document *pcDocument)
 sets the view to another document (called by Application) More...
 
void onClose (void)
 is sent from the document in order to close the document More...
 
Gui::DocumentgetGuiDocument () const
 returns the document the view is attached to More...
 
App::DocumentgetAppDocument () const
 returns the document the view is attached to More...
 
bool isPassive (void) const
 indicates if the view is in passive mode More...
 
virtual void onRename (Gui::Document *)
 get called when the document is renamed (change of its internal name) More...
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
 BaseClass (const BaseClass &)=default
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (const BaseClass &)=default
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 
- Public Member Functions inherited from Gui::WindowParameter
ParameterGrp::handle getWindowParameter (void)
 return the parameter group of this window More...
 
void OnChange (Base::Subject< const char * > &rCaller, const char *sReason)
 
bool setGroupName (const char *name)
 Sets the group of the window to name. More...
 
 WindowParameter (const char *name)
 
virtual ~WindowParameter ()
 

Additional Inherited Members

- Public Types inherited from Gui::EditorView
enum  DisplayName { FullName , FileName , BaseName }
 
- Public Types inherited from Gui::MDIView
enum  ViewMode { Child , TopLevel , FullScreen }
 MDI view mode enum. More...
 
- Signals inherited from Gui::EditorView
void changeFileName (const QString &)
 
- Signals inherited from Gui::MDIView
void message (const QString &, int)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
 
static Type getClassTypeId ()
 
static void init ()
 
- Static Public Member Functions inherited from Gui::WindowParameter
static ParameterGrp::handle getDefaultParameter (void)
 get the parameters More...
 
- Protected Slots inherited from Gui::MDIView
virtual void windowStateChanged (MDIView *)
 This method gets called from the main window this view is attached to whenever the window state of the active view changes. More...
 
- Protected Member Functions inherited from Gui::EditorView
void focusInEvent (QFocusEvent *e)
 
void showEvent (QShowEvent *)
 
void hideEvent (QHideEvent *)
 
void closeEvent (QCloseEvent *)
 
- Protected Member Functions inherited from Gui::MDIView
void closeEvent (QCloseEvent *e)
 
void changeEvent (QEvent *e)
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 
- Protected Attributes inherited from Gui::MDIView
PyObjectpythonObject
 
- Protected Attributes inherited from Gui::BaseView
bool bIsDetached
 
bool bIsPassive
 

Constructor & Destructor Documentation

◆ PythonEditorView()

PythonEditorView::PythonEditorView ( PythonEditor editor,
QWidget parent 
)

◆ ~PythonEditorView()

PythonEditorView::~PythonEditorView ( )

Member Function Documentation

◆ executeScript

void PythonEditorView::executeScript ( )
slot

◆ hideDebugMarker

void PythonEditorView::hideDebugMarker ( )
slot

◆ onHasMsg()

bool PythonEditorView::onHasMsg ( const char *  pMsg) const
virtual

Checks if the action pMsg is available.

This is for enabling/disabling the corresponding buttons or menu items for this action.

Reimplemented from Gui::EditorView.

References Gui::EditorView::onHasMsg().

◆ onMsg()

bool PythonEditorView::onMsg ( const char *  pMsg,
const char **  ppReturn 
)
virtual

Runs the action specified by pMsg.

Reimplemented from Gui::EditorView.

References executeScript(), Gui::EditorView::onMsg(), startDebug(), and toggleBreakpoint().

◆ showDebugMarker

void PythonEditorView::showDebugMarker ( int  line)
slot

◆ startDebug

void PythonEditorView::startDebug ( )
slot

Referenced by onMsg().

◆ toggleBreakpoint

void PythonEditorView::toggleBreakpoint ( )
slot

Referenced by onMsg().


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