WebGui::BrowserView Class Reference

A special view class which sends the messages from the application to the editor and embeds it in a window. More...

#include <BrowserView.h>

Public Member Functions

 BrowserView (QWidget *parent)
 Constructs a BrowserView which is a child of 'parent', with the name 'name'. More...
 
bool canClose (void)
 Checking on close state. More...
 
const char * getName (void) const
 returns the name of the view (important for messages) More...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
void load (const char *URL)
 
void load (const QUrl &url)
 
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 setHtml (const QString &HtmlCode, const QUrl &BaseUrl)
 
void stop (void)
 
QUrl url () const
 
 ~BrowserView ()
 Destroys the object and frees any allocated resources. More...
 
- Public Member Functions inherited from Gui::MDIView
virtual void deleteSelf ()
 delete itself More...
 
 MDIView (Gui::Document *pcDocument, QWidget *parent, Qt::WindowFlags wflags=Qt::WindowFlags())
 View constructor Attach the view to the given document. 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...
 
virtual void print ()
 Print content of view. More...
 
virtual void printPdf ()
 Print to PDF file. More...
 
virtual void printPreview ()
 Show a preview dialog. 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=0, std::string *subname=0) const
 access getter for the active object list More...
 
void setActiveObject (App::DocumentObject *o, const char *n, const char *subname=0)
 
bool hasActiveObject (const char *n) const
 
bool isActiveObject (App::DocumentObject *o, const char *n, const char *subname=0) 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...
 
- Public Member Functions inherited from Gui::BaseView
 BaseView (Gui::Document *pcDocument=0)
 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...
 
virtual Type getTypeId (void) const
 
bool isDerivedFrom (const Type type) const
 
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 ()
 

Protected Slots

bool chckHostAllowed (const QString &host)
 
void onDownloadRequested (const QNetworkRequest &request)
 
void onLinkClicked (const QUrl &url)
 
void onLinkHovered (const QString &link, const QString &title, const QString &textContent)
 
void onLoadFinished (bool)
 
void onLoadProgress (int)
 
void onLoadStarted ()
 
void onOpenLinkInExternalBrowser (const QUrl &url)
 
void onOpenLinkInNewWindow (const QUrl &)
 
void onUnsupportedContent (QNetworkReply *reply)
 
void onViewSource (const QUrl &url)
 
- 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...
 

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 print (QPrinter *printer)
 
virtual void setOverrideCursor (const QCursor &)
 
virtual void restoreOverrideCursor ()
 
- Signals inherited from Gui::MDIView
void message (const QString &, int)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 
- Static Public Member Functions inherited from Gui::WindowParameter
static ParameterGrp::handle getDefaultParameter (void)
 get the parameters More...
 
- 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
 

Detailed Description

A special view class which sends the messages from the application to the editor and embeds it in a window.

Constructor & Destructor Documentation

◆ BrowserView()

◆ ~BrowserView()

BrowserView::~BrowserView ( )

Destroys the object and frees any allocated resources.

Member Function Documentation

◆ canClose()

bool BrowserView::canClose ( void  )
virtual

Checking on close state.

Reimplemented from Gui::MDIView.

◆ chckHostAllowed

bool BrowserView::chckHostAllowed ( const QString &  host)
protectedslot

◆ getName()

const char* WebGui::BrowserView::getName ( void  ) const
virtual

returns the name of the view (important for messages)

Reimplemented from Gui::BaseView.

◆ getPyObject()

PyObject * BrowserView::getPyObject ( void  )
virtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Gui::MDIView.

References Base::BaseClass::init(), and WebGui::BrowserViewPy::init_type().

◆ load() [1/2]

void BrowserView::load ( const char *  URL)

References url().

Referenced by WebGui::UrlWidget::keyPressEvent().

◆ load() [2/2]

void BrowserView::load ( const QUrl &  url)

References stop(), and url().

◆ OnChange()

void BrowserView::OnChange ( Base::Subject< const char * > &  rCaller,
const char *  rcReason 
)

◆ onDownloadRequested

void BrowserView::onDownloadRequested ( const QNetworkRequest &  request)
protectedslot

◆ onHasMsg()

bool BrowserView::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::MDIView.

◆ onLinkClicked

void BrowserView::onLinkClicked ( const QUrl &  url)
protectedslot

◆ onLinkHovered

void BrowserView::onLinkHovered ( const QString &  link,
const QString &  title,
const QString &  textContent 
)
protectedslot

◆ onLoadFinished

void BrowserView::onLoadFinished ( bool  ok)
protectedslot

◆ onLoadProgress

void BrowserView::onLoadProgress ( int  step)
protectedslot

◆ onLoadStarted

void BrowserView::onLoadStarted ( )
protectedslot

◆ onMsg()

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

Runs the action specified by pMsg.

Reimplemented from Gui::MDIView.

References WebGui::UrlWidget::display(), and stop().

◆ onOpenLinkInExternalBrowser

void BrowserView::onOpenLinkInExternalBrowser ( const QUrl &  url)
protectedslot

References url().

Referenced by BrowserView().

◆ onOpenLinkInNewWindow

void BrowserView::onOpenLinkInNewWindow ( const QUrl &  url)
protectedslot

◆ onUnsupportedContent

void BrowserView::onUnsupportedContent ( QNetworkReply *  reply)
protectedslot

◆ onViewSource

void BrowserView::onViewSource ( const QUrl &  url)
protectedslot

◆ setHtml()

void BrowserView::setHtml ( const QString &  HtmlCode,
const QUrl &  BaseUrl 
)

References stop().

◆ stop()

void BrowserView::stop ( void  )

◆ url()


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Mod/Web/Gui/BrowserView.h
  • Sources/FreeCAD/src/Mod/Web/Gui/BrowserView.cpp