KLayout Manual: Main Index » Class Index » API reference - Class QTextBrowser

API reference - Class QTextBrowser

Notation used in Ruby API documentation

Description: Binding of QTextBrowser

Class hierarchy: QTextBrowser » QTextEdit » QAbstractScrollArea » QFrame » QWidget » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[virtual] void actionEvent(QActionEvent ptr arg1)

Description: Virtual method void QTextBrowser::actionEvent(QActionEvent *)

This method can be reimplemented in a derived class.

[event] void anchorClicked(const QUrl arg1)

Description: Signal declaration for QTextBrowser::anchorClicked(const QUrl &)

You can bind a procedure to this signal.

[virtual] void backward

Description: Virtual method void QTextBrowser::backward()

This method can be reimplemented in a derived class.

[event] void backwardAvailable(bool arg1)

Description: Signal declaration for QTextBrowser::backwardAvailable(bool)

You can bind a procedure to this signal.

[const] int backwardHistoryCount

Description: Method int QTextBrowser::backwardHistoryCount()

[virtual,const] bool canInsertFromMimeData(const QMimeData ptr source)

Description: Virtual method bool QTextBrowser::canInsertFromMimeData(const QMimeData *source)

This method can be reimplemented in a derived class.

[virtual] void changeEvent(QEvent ptr e)

Description: Virtual method void QTextBrowser::changeEvent(QEvent *e)

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QTextBrowser::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void clearHistory

Description: Method void QTextBrowser::clearHistory()

[virtual] void closeEvent(QCloseEvent ptr arg1)

Description: Virtual method void QTextBrowser::closeEvent(QCloseEvent *)

This method can be reimplemented in a derived class.

[virtual] void contextMenuEvent(QContextMenuEvent ptr e)

Description: Virtual method void QTextBrowser::contextMenuEvent(QContextMenuEvent *e)

This method can be reimplemented in a derived class.

[event] void copyAvailable(bool b)

Description: Signal declaration for QTextBrowser::copyAvailable(bool b)

You can bind a procedure to this signal.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual,const] QMimeData ptr createMimeDataFromSelection

Description: Virtual method QMimeData *QTextBrowser::createMimeDataFromSelection()

This method can be reimplemented in a derived class.

[event] void currentCharFormatChanged(const QTextCharFormat format)

Description: Signal declaration for QTextBrowser::currentCharFormatChanged(const QTextCharFormat &format)

You can bind a procedure to this signal.

[event] void cursorPositionChanged

Description: Signal declaration for QTextBrowser::cursorPositionChanged()

You can bind a procedure to this signal.

[event] void customContextMenuRequested(const QPoint pos)

Description: Signal declaration for QTextBrowser::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QTextBrowser::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QTextBrowser::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QTextBrowser::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] void dragEnterEvent(QDragEnterEvent ptr e)

Description: Virtual method void QTextBrowser::dragEnterEvent(QDragEnterEvent *e)

This method can be reimplemented in a derived class.

[virtual] void dragLeaveEvent(QDragLeaveEvent ptr e)

Description: Virtual method void QTextBrowser::dragLeaveEvent(QDragLeaveEvent *e)

This method can be reimplemented in a derived class.

[virtual] void dragMoveEvent(QDragMoveEvent ptr e)

Description: Virtual method void QTextBrowser::dragMoveEvent(QDragMoveEvent *e)

This method can be reimplemented in a derived class.

void drawFrame(QPainter ptr arg1)

Description: Method void QTextBrowser::drawFrame(QPainter *)

This method is protected and can only be called from inside a derived class.

[virtual] void dropEvent(QDropEvent ptr e)

Description: Virtual method void QTextBrowser::dropEvent(QDropEvent *e)

This method can be reimplemented in a derived class.

[virtual] void enabledChange(bool arg1)

Description: Virtual method void QTextBrowser::enabledChange(bool)

This method can be reimplemented in a derived class.

[virtual] void enterEvent(QEvent ptr arg1)

Description: Virtual method void QTextBrowser::enterEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr e)

Description: Virtual method bool QTextBrowser::event(QEvent *e)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QTextBrowser::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[virtual] void focusInEvent(QFocusEvent ptr e)

Description: Virtual method void QTextBrowser::focusInEvent(QFocusEvent *e)

This method can be reimplemented in a derived class.

bool focusNextChild

Description: Method bool QTextBrowser::focusNextChild()

This method is protected and can only be called from inside a derived class.

[virtual] bool focusNextPrevChild(bool next)

Description: Virtual method bool QTextBrowser::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

[virtual] void focusOutEvent(QFocusEvent ptr ev)

Description: Virtual method void QTextBrowser::focusOutEvent(QFocusEvent *ev)

This method can be reimplemented in a derived class.

bool focusPreviousChild

Description: Method bool QTextBrowser::focusPreviousChild()

This method is protected and can only be called from inside a derived class.

[virtual] void fontChange(const QFont arg1)

Description: Virtual method void QTextBrowser::fontChange(const QFont &)

This method can be reimplemented in a derived class.

[virtual] void forward

Description: Virtual method void QTextBrowser::forward()

This method can be reimplemented in a derived class.

[event] void forwardAvailable(bool arg1)

Description: Signal declaration for QTextBrowser::forwardAvailable(bool)

You can bind a procedure to this signal.

[const] int forwardHistoryCount

Description: Method int QTextBrowser::forwardHistoryCount()

[virtual,const] int heightForWidth(int arg1)

Description: Virtual method int QTextBrowser::heightForWidth(int)

This method can be reimplemented in a derived class.

[virtual] void hideEvent(QHideEvent ptr arg1)

Description: Virtual method void QTextBrowser::hideEvent(QHideEvent *)

This method can be reimplemented in a derived class.

[event] void highlighted(const QUrl arg1)

Description: Signal declaration for QTextBrowser::highlighted(const QUrl &)

You can bind a procedure to this signal.

[event] void highlighted_qs(string arg1)

Description: Signal declaration for QTextBrowser::highlighted(const QString &)

You can bind a procedure to this signal.

[event] void historyChanged

Description: Signal declaration for QTextBrowser::historyChanged()

You can bind a procedure to this signal.

[const] string historyTitle(int arg1)

Description: Method QString QTextBrowser::historyTitle(int)

[const] QUrl historyUrl(int arg1)

Description: Method QUrl QTextBrowser::historyUrl(int)

[virtual] void home

Description: Virtual method void QTextBrowser::home()

This method can be reimplemented in a derived class.

[virtual] void inputMethodEvent(QInputMethodEvent ptr arg1)

Description: Virtual method void QTextBrowser::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

[virtual,const] QVariant inputMethodQuery(const Qt_InputMethodQuery property)

Description: Virtual method QVariant QTextBrowser::inputMethodQuery(Qt::InputMethodQuery property)

This method can be reimplemented in a derived class.

[virtual] void insertFromMimeData(const QMimeData ptr source)

Description: Virtual method void QTextBrowser::insertFromMimeData(const QMimeData *source)

This method can be reimplemented in a derived class.

[const] bool isBackwardAvailable?

Description: Method bool QTextBrowser::isBackwardAvailable()

[const] bool isForwardAvailable?

Description: Method bool QTextBrowser::isForwardAvailable()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[virtual] void keyPressEvent(QKeyEvent ptr ev)

Description: Virtual method void QTextBrowser::keyPressEvent(QKeyEvent *ev)

This method can be reimplemented in a derived class.

[virtual] void keyReleaseEvent(QKeyEvent ptr e)

Description: Virtual method void QTextBrowser::keyReleaseEvent(QKeyEvent *e)

This method can be reimplemented in a derived class.

[virtual] void languageChange

Description: Virtual method void QTextBrowser::languageChange()

This method can be reimplemented in a derived class.

[virtual] void leaveEvent(QEvent ptr arg1)

Description: Virtual method void QTextBrowser::leaveEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] QVariant loadResource(int type,const QUrl name)

Description: Virtual method QVariant QTextBrowser::loadResource(int type, const QUrl &name)

This method can be reimplemented in a derived class.

[virtual,const] int metric(const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QTextBrowser::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

[virtual,const] QSize minimumSizeHint

Description: Virtual method QSize QTextBrowser::minimumSizeHint()

This method can be reimplemented in a derived class.

[virtual] void mouseDoubleClickEvent(QMouseEvent ptr e)

Description: Virtual method void QTextBrowser::mouseDoubleClickEvent(QMouseEvent *e)

This method can be reimplemented in a derived class.

[virtual] void mouseMoveEvent(QMouseEvent ptr ev)

Description: Virtual method void QTextBrowser::mouseMoveEvent(QMouseEvent *ev)

This method can be reimplemented in a derived class.

[virtual] void mousePressEvent(QMouseEvent ptr ev)

Description: Virtual method void QTextBrowser::mousePressEvent(QMouseEvent *ev)

This method can be reimplemented in a derived class.

[virtual] void mouseReleaseEvent(QMouseEvent ptr ev)

Description: Virtual method void QTextBrowser::mouseReleaseEvent(QMouseEvent *ev)

This method can be reimplemented in a derived class.

[virtual] void moveEvent(QMoveEvent ptr arg1)

Description: Virtual method void QTextBrowser::moveEvent(QMoveEvent *)

This method can be reimplemented in a derived class.

[static] new QTextBrowser new(QWidget ptr parent = 0)

Description: Constructor QTextBrowser::QTextBrowser(QWidget *parent)

This method creates an object of class QTextBrowser.

Python specific notes:

This method is the default initializer of the object

[const] bool openExternalLinks

Description: Method bool QTextBrowser::openExternalLinks()

Python specific notes:

The object exposes a readable attribute 'openExternalLinks'. This is the getter.

void openExternalLinks=(bool open)

Description: Method void QTextBrowser::setOpenExternalLinks(bool open)

Python specific notes:

The object exposes a writable attribute 'openExternalLinks'. This is the setter.

[const] bool openLinks

Description: Method bool QTextBrowser::openLinks()

Python specific notes:

The object exposes a readable attribute 'openLinks'. This is the getter.

void openLinks=(bool open)

Description: Method void QTextBrowser::setOpenLinks(bool open)

Python specific notes:

The object exposes a writable attribute 'openLinks'. This is the setter.

[virtual,const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QTextBrowser::paintEngine()

This method can be reimplemented in a derived class.

[virtual] void paintEvent(QPaintEvent ptr e)

Description: Virtual method void QTextBrowser::paintEvent(QPaintEvent *e)

This method can be reimplemented in a derived class.

[virtual] void paletteChange(const QPalette arg1)

Description: Virtual method void QTextBrowser::paletteChange(const QPalette &)

This method can be reimplemented in a derived class.

void qt_create(unsigned long arg1 = 0,bool initializeWindow = true,bool destroyOldWindow = true)

Description: Method void QTextBrowser::create(WId, bool initializeWindow, bool destroyOldWindow)

This method is protected and can only be called from inside a derived class.

void qt_destroy(bool destroyWindow = true,bool destroySubWindows = true)

Description: Method void QTextBrowser::destroy(bool destroyWindow, bool destroySubWindows)

This method is protected and can only be called from inside a derived class.

[const] int receivers(string signal)

Description: Method int QTextBrowser::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

[event] void redoAvailable(bool b)

Description: Signal declaration for QTextBrowser::redoAvailable(bool b)

You can bind a procedure to this signal.

[virtual] void reload

Description: Virtual method void QTextBrowser::reload()

This method can be reimplemented in a derived class.

void resetInputContext

Description: Method void QTextBrowser::resetInputContext()

This method is protected and can only be called from inside a derived class.

[virtual] void resizeEvent(QResizeEvent ptr e)

Description: Virtual method void QTextBrowser::resizeEvent(QResizeEvent *e)

This method can be reimplemented in a derived class.

[virtual] void scrollContentsBy(int dx,int dy)

Description: Virtual method void QTextBrowser::scrollContentsBy(int dx, int dy)

This method can be reimplemented in a derived class.

[const] string[] searchPaths

Description: Method QStringList QTextBrowser::searchPaths()

Python specific notes:

The object exposes a readable attribute 'searchPaths'. This is the getter.

void searchPaths=(string[] paths)

Description: Method void QTextBrowser::setSearchPaths(const QStringList &paths)

Python specific notes:

The object exposes a writable attribute 'searchPaths'. This is the setter.

[event] void selectionChanged

Description: Signal declaration for QTextBrowser::selectionChanged()

You can bind a procedure to this signal.

[const] QObject ptr sender

Description: Method QObject *QTextBrowser::sender()

This method is protected and can only be called from inside a derived class.

void setOpenExternalLinks(bool open)

Description: Method void QTextBrowser::setOpenExternalLinks(bool open)

Python specific notes:

The object exposes a writable attribute 'openExternalLinks'. This is the setter.

void setOpenLinks(bool open)

Description: Method void QTextBrowser::setOpenLinks(bool open)

Python specific notes:

The object exposes a writable attribute 'openLinks'. This is the setter.

void setSearchPaths(string[] paths)

Description: Method void QTextBrowser::setSearchPaths(const QStringList &paths)

Python specific notes:

The object exposes a writable attribute 'searchPaths'. This is the setter.

[virtual] void setSource(const QUrl name)

Description: Virtual method void QTextBrowser::setSource(const QUrl &name)

This method can be reimplemented in a derived class.

void setViewportMargins(int left,int top,int right,int bottom)

Description: Method void QTextBrowser::setViewportMargins(int left, int top, int right, int bottom)

This method is protected and can only be called from inside a derived class.

void setViewportMargins(const QMargins margins)

Description: Method void QTextBrowser::setViewportMargins(const QMargins &margins)

This method is protected and can only be called from inside a derived class.

[virtual] void setVisible(bool visible)

Description: Virtual method void QTextBrowser::setVisible(bool visible)

This method can be reimplemented in a derived class.

void setupViewport(QWidget ptr viewport)

Description: Method void QTextBrowser::setupViewport(QWidget *viewport)

This method is protected and can only be called from inside a derived class.

[virtual] void showEvent(QShowEvent ptr arg1)

Description: Virtual method void QTextBrowser::showEvent(QShowEvent *)

This method can be reimplemented in a derived class.

[virtual,const] QSize sizeHint

Description: Virtual method QSize QTextBrowser::sizeHint()

This method can be reimplemented in a derived class.

[const] QUrl source

Description: Method QUrl QTextBrowser::source()

Python specific notes:

The object exposes a readable attribute 'source'. This is the getter.

void source=(const QUrl name)

Description: Method void QTextBrowser::setSource(const QUrl &name)

Python specific notes:

The object exposes a writable attribute 'source'. This is the setter.

[event] void sourceChanged(const QUrl arg1)

Description: Signal declaration for QTextBrowser::sourceChanged(const QUrl &)

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void styleChange(QStyle arg1)

Description: Virtual method void QTextBrowser::styleChange(QStyle &)

This method can be reimplemented in a derived class.

[virtual] void tabletEvent(QTabletEvent ptr arg1)

Description: Virtual method void QTextBrowser::tabletEvent(QTabletEvent *)

This method can be reimplemented in a derived class.

[event] void textChanged

Description: Signal declaration for QTextBrowser::textChanged()

You can bind a procedure to this signal.

[virtual] void timerEvent(QTimerEvent ptr e)

Description: Virtual method void QTextBrowser::timerEvent(QTimerEvent *e)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QTextBrowser::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QTextBrowser::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QTextBrowser::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QTextBrowser::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[event] void undoAvailable(bool b)

Description: Signal declaration for QTextBrowser::undoAvailable(bool b)

You can bind a procedure to this signal.

void updateMicroFocus

Description: Method void QTextBrowser::updateMicroFocus()

This method is protected and can only be called from inside a derived class.

[virtual] bool viewportEvent(QEvent ptr arg1)

Description: Virtual method bool QTextBrowser::viewportEvent(QEvent *)

This method can be reimplemented in a derived class.

[virtual] void wheelEvent(QWheelEvent ptr e)

Description: Virtual method void QTextBrowser::wheelEvent(QWheelEvent *e)

This method can be reimplemented in a derived class.

[virtual] void windowActivationChange(bool arg1)

Description: Virtual method void QTextBrowser::windowActivationChange(bool)

This method can be reimplemented in a derived class.