Gui::TextDocumentEditorView Class Reference

#include <TextDocumentEditorView.h>

Public Member Functions

bool canClose () override
 overwrite when checking on close state More...
 
bool event (QEvent *event) override
 
QPlainTextEditgetEditor () const
 
const char * getName () const override
 returns the name of the view (important for messages) More...
 
App::TextDocumentgetTextObject () const
 
bool onHasMsg (const char *msg) const override
 Message handler test. More...
 
bool onMsg (const char *msg, const char **) override
 Message handler. More...
 
QStringList redoActions () const override
 
 TextDocumentEditorView (App::TextDocument *textDocument, QPlainTextEdit *editor, QWidget *parent)
 
QStringList undoActions () const override
 
 ~TextDocumentEditorView ()
 
- 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...
 
virtual void print ()
 Print content of view. More...
 
virtual void printPdf ()
 Print to PDF file. More...
 
virtual void printPreview ()
 Show a preview dialog. 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 onUpdate (void)
 get called when the document is updated 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...
 

Protected Member Functions

void closeEvent (QCloseEvent *) override
 
void hideEvent (QHideEvent *) override
 
void showEvent (QShowEvent *) override
 
- Protected Member Functions inherited from Gui::MDIView
void closeEvent (QCloseEvent *e)
 
void changeEvent (QEvent *e)
 

Additional Inherited Members

- Public Types inherited from Gui::MDIView
enum  ViewMode { Child , TopLevel , FullScreen }
 MDI view mode enum. More...
 
- Public Slots inherited from Gui::MDIView
virtual void setOverrideCursor (const QCursor &)
 
virtual void restoreOverrideCursor ()
 
virtual void print (QPrinter *printer)
 
- 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 ()
 
- 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...
 
- 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

◆ TextDocumentEditorView()

TextDocumentEditorView::TextDocumentEditorView ( App::TextDocument textDocument,
QPlainTextEdit editor,
QWidget parent 
)

◆ ~TextDocumentEditorView()

TextDocumentEditorView::~TextDocumentEditorView ( )

Member Function Documentation

◆ canClose()

bool TextDocumentEditorView::canClose ( void  )
overridevirtual

overwrite when checking on close state

Reimplemented from Gui::MDIView.

References Gui::MDIView::canClose(), getEditor(), Gui::BaseView::getGuiDocument(), and Gui::Document::save().

◆ closeEvent()

void TextDocumentEditorView::closeEvent ( QCloseEvent *  event)
overrideprotected

◆ event()

bool TextDocumentEditorView::event ( QEvent event)
override

◆ getEditor()

QPlainTextEdit * Gui::TextDocumentEditorView::getEditor ( ) const

Referenced by canClose(), onHasMsg(), and onMsg().

◆ getName()

const char * Gui::TextDocumentEditorView::getName ( void  ) const
overridevirtual

returns the name of the view (important for messages)

Reimplemented from Gui::BaseView.

◆ getTextObject()

App::TextDocument * Gui::TextDocumentEditorView::getTextObject ( ) const

◆ hideEvent()

void TextDocumentEditorView::hideEvent ( QHideEvent *  event)
overrideprotected

◆ onHasMsg()

bool TextDocumentEditorView::onHasMsg ( const char *  pMsg) const
overridevirtual

Message handler test.

Reimplemented from Gui::MDIView.

References getEditor().

◆ onMsg()

bool TextDocumentEditorView::onMsg ( const char *  pMsg,
const char **  ppReturn 
)
overridevirtual

Message handler.

receive a message

Reimplemented from Gui::MDIView.

References getEditor(), Gui::BaseView::getGuiDocument(), and Gui::Document::save().

◆ redoActions()

QStringList TextDocumentEditorView::redoActions ( ) const
overridevirtual

Reimplemented from Gui::MDIView.

◆ showEvent()

void TextDocumentEditorView::showEvent ( QShowEvent *  event)
overrideprotected

References Gui::getMainWindow().

◆ undoActions()

QStringList TextDocumentEditorView::undoActions ( ) const
overridevirtual

Reimplemented from Gui::MDIView.


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