Qt 4.8
Public Slots | Signals | Public Functions | Protected Functions | Properties | List of all members
QTextBrowser Class Reference

The QTextBrowser class provides a rich text browser with hypertext navigation. More...

#include <qtextbrowser.h>

Inheritance diagram for QTextBrowser:
QTextEdit QAbstractScrollArea QFrame QWidget QObject QPaintDevice

Public Slots

virtual void backward ()
 Changes the document displayed to the previous document in the list of documents built by navigating links. More...
 
virtual void forward ()
 Changes the document displayed to the next document in the list of documents built by navigating links. More...
 
virtual void home ()
 Changes the document displayed to be the first document from the history. More...
 
virtual void reload ()
 Reloads the current set source. More...
 
virtual void setSource (const QUrl &name)
 
- Public Slots inherited from QTextEdit
void append (const QString &text)
 Appends a new paragraph with text to the end of the text edit. More...
 
void clear ()
 Deletes all the text in the text edit. More...
 
void copy ()
 Copies any selected text to the clipboard. More...
 
void cut ()
 Copies the selected text to the clipboard and deletes it from the text edit. More...
 
void insertHtml (const QString &text)
 Convenience slot that inserts text which is assumed to be of html formatting at the current cursor position. More...
 
void insertPlainText (const QString &text)
 Convenience slot that inserts text at the current cursor position. More...
 
void paste ()
 Pastes the text from the clipboard into the text edit at the current cursor position. More...
 
void redo ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void scrollToAnchor (const QString &name)
 Scrolls the text edit so that the anchor with the given name is visible; does nothing if the name is empty, or is already visible, or isn't found. More...
 
void selectAll ()
 Selects all text. More...
 
void setAlignment (Qt::Alignment a)
 Sets the alignment of the current paragraph to a. More...
 
void setCurrentFont (const QFont &f)
 Sets the font of the current format to f. More...
 
void setFontFamily (const QString &fontFamily)
 Sets the font family of the current format to fontFamily. More...
 
void setFontItalic (bool b)
 If italic is true, sets the current format to italic; otherwise sets the current format to non-italic. More...
 
void setFontPointSize (qreal s)
 Sets the point size of the current format to s. More...
 
void setFontUnderline (bool b)
 If underline is true, sets the current format to underline; otherwise sets the current format to non-underline. More...
 
void setFontWeight (int w)
 Sets the font weight of the current format to the given weight, where the value used is in the range defined by the QFont::Weight enum. More...
 
void setHtml (const QString &text)
 
void setPlainText (const QString &text)
 Changes the text of the text edit to the string text. More...
 
void setText (const QString &text)
 Sets the text edit's text. More...
 
void setTextBackgroundColor (const QColor &c)
 Sets the text background color of the current format to c. More...
 
void setTextColor (const QColor &c)
 Sets the text color of the current format to c. More...
 
void undo ()
 Undoes the last operation. More...
 
void zoomIn (int range=1)
 Zooms in on the text by making the base font size range points larger and recalculating all font sizes to be the new size. More...
 
void zoomOut (int range=1)
 Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. More...
 
- Public Slots inherited from QWidget
bool close ()
 Closes this widget. More...
 
void hide ()
 Hides the widget. More...
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack. More...
 
void raise ()
 Raises this widget to the top of the parent widget's stack. More...
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. More...
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events. More...
 
void setEnabled (bool)
 
void setFocus ()
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More...
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden). More...
 
QT_MOC_COMPAT void setShown (bool shown)
 Use setVisible(shown) instead. More...
 
void setStyleSheet (const QString &styleSheet)
 
virtual void setVisible (bool visible)
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void show ()
 Shows the widget and its child widgets. More...
 
void showFullScreen ()
 Shows the widget in full-screen mode. More...
 
void showMaximized ()
 Shows the widget maximized. More...
 
void showMinimized ()
 Shows the widget minimized, as an icon. More...
 
void showNormal ()
 Restores the widget after it has been maximized or minimized. More...
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 

Signals

void anchorClicked (const QUrl &)
 This signal is emitted when the user clicks an anchor. More...
 
void backwardAvailable (bool)
 This signal is emitted when the availability of backward() changes. More...
 
void forwardAvailable (bool)
 This signal is emitted when the availability of forward() changes. More...
 
void highlighted (const QUrl &)
 This signal is emitted when the user has selected but not activated an anchor in the document. More...
 
void highlighted (const QString &)
 Convenience signal that allows connecting to a slot that takes just a QString, like for example QStatusBar's message(). More...
 
void historyChanged ()
 This signal is emitted when the history changes. More...
 
void sourceChanged (const QUrl &)
 This signal is emitted when the source has changed, src being the new source. More...
 
- Signals inherited from QTextEdit
void copyAvailable (bool b)
 This signal is emitted when text is selected or de-selected in the text edit. More...
 
void currentCharFormatChanged (const QTextCharFormat &format)
 This signal is emitted if the current character format has changed, for example caused by a change of the cursor position. More...
 
void cursorPositionChanged ()
 This signal is emitted whenever the position of the cursor changed. More...
 
void redoAvailable (bool b)
 This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false). More...
 
void selectionChanged ()
 This signal is emitted whenever the selection changes. More...
 
void textChanged ()
 This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied. More...
 
void undoAvailable (bool b)
 This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false). More...
 
- Signals inherited from QWidget
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 

Public Functions

int backwardHistoryCount () const
 Returns the number of locations backward in the history. More...
 
void clearHistory ()
 Clears the history of visited documents and disables the forward and backward navigation. More...
 
int forwardHistoryCount () const
 Returns the number of locations forward in the history. More...
 
QString historyTitle (int) const
 Returns the documentTitle() of the HistoryItem. More...
 
QUrl historyUrl (int) const
 Returns the url of the HistoryItem. More...
 
bool isBackwardAvailable () const
 Returns true if the text browser can go backward in the document history using backward(). More...
 
bool isForwardAvailable () const
 Returns true if the text browser can go forward in the document history using forward(). More...
 
virtual QVariant loadResource (int type, const QUrl &name)
 This function is called when the document is loaded and for each image in the document. More...
 
bool openExternalLinks () const
 
bool openLinks () const
 
 QTextBrowser (QWidget *parent=0)
 Constructs an empty QTextBrowser with parent parent. More...
 
QStringList searchPaths () const
 
void setOpenExternalLinks (bool open)
 
void setOpenLinks (bool open)
 
void setSearchPaths (const QStringList &paths)
 
QUrl source () const
 
virtual ~QTextBrowser ()
 
- Public Functions inherited from QTextEdit
bool acceptRichText () const
 
Qt::Alignment alignment () const
 Returns the alignment of the current paragraph. More...
 
QString anchorAt (const QPoint &pos) const
 Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point. More...
 
AutoFormatting autoFormatting () const
 
bool canPaste () const
 Returns whether text can be pasted from the clipboard into the textedit. More...
 
QMenucreateStandardContextMenu ()
 This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. More...
 
QMenucreateStandardContextMenu (const QPoint &position)
 This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. More...
 
QTextCharFormat currentCharFormat () const
 Returns the char format that is used when inserting new text. More...
 
QFont currentFont () const
 Returns the font of the current format. More...
 
QTextCursor cursorForPosition (const QPoint &pos) const
 returns a QTextCursor at position pos (in viewport coordinates). More...
 
QRect cursorRect (const QTextCursor &cursor) const
 returns a rectangle (in viewport coordinates) that includes the cursor. More...
 
QRect cursorRect () const
 returns a rectangle (in viewport coordinates) that includes the cursor of the text edit. More...
 
int cursorWidth () const
 
QTextDocumentdocument () const
 Returns a pointer to the underlying document. More...
 
QString documentTitle () const
 
void ensureCursorVisible ()
 Ensures that the cursor is visible by scrolling the text edit if necessary. More...
 
QList< ExtraSelectionextraSelections () const
 Returns previously set extra selections. More...
 
bool find (const QString &exp, QTextDocument::FindFlags options=0)
 Finds the next occurrence of the string, exp, using the given options. More...
 
QString fontFamily () const
 Returns the font family of the current format. More...
 
bool fontItalic () const
 Returns true if the font of the current format is italic; otherwise returns false. More...
 
qreal fontPointSize () const
 Returns the point size of the font of the current format. More...
 
bool fontUnderline () const
 Returns true if the font of the current format is underlined; otherwise returns false. More...
 
int fontWeight () const
 Returns the font weight of the current format. More...
 
bool isReadOnly () const
 
bool isUndoRedoEnabled () const
 
int lineWrapColumnOrWidth () const
 
LineWrapMode lineWrapMode () const
 
void mergeCurrentCharFormat (const QTextCharFormat &modifier)
 Merges the properties specified in modifier into the current character format by calling QTextCursor::mergeCharFormat on the editor's cursor. More...
 
void moveCursor (QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode=QTextCursor::MoveAnchor)
 Moves the cursor by performing the given operation. More...
 
bool overwriteMode () const
 
void print (QPrinter *printer) const
 Convenience function to print the text edit's document to the given printer. More...
 
 QTextEdit (QWidget *parent=0)
 Constructs an empty QTextEdit with parent parent. More...
 
 QTextEdit (const QString &text, QWidget *parent=0)
 Constructs a QTextEdit with parent parent. More...
 
void setAcceptRichText (bool accept)
 
void setAutoFormatting (AutoFormatting features)
 
void setCurrentCharFormat (const QTextCharFormat &format)
 Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor. More...
 
void setCursorWidth (int width)
 
void setDocument (QTextDocument *document)
 Makes document the new document of the text editor. More...
 
void setDocumentTitle (const QString &title)
 
void setExtraSelections (const QList< ExtraSelection > &selections)
 This function allows temporarily marking certain regions in the document with a given color, specified as selections. More...
 
void setLineWrapColumnOrWidth (int w)
 
void setLineWrapMode (LineWrapMode mode)
 
void setOverwriteMode (bool overwrite)
 
void setReadOnly (bool ro)
 
void setTabChangesFocus (bool b)
 
void setTabStopWidth (int width)
 
void setTextCursor (const QTextCursor &cursor)
 Sets the visible cursor. More...
 
void setTextInteractionFlags (Qt::TextInteractionFlags flags)
 
void setUndoRedoEnabled (bool enable)
 
void setWordWrapMode (QTextOption::WrapMode policy)
 
bool tabChangesFocus () const
 
int tabStopWidth () const
 
QColor textBackgroundColor () const
 Returns the text background color of the current format. More...
 
QColor textColor () const
 Returns the text color of the current format. More...
 
QTextCursor textCursor () const
 Returns a copy of the QTextCursor that represents the currently visible cursor. More...
 
Qt::TextInteractionFlags textInteractionFlags () const
 
QString toHtml () const
 
QString toPlainText () const
 Returns the text of the text edit as plain text. More...
 
QTextOption::WrapMode wordWrapMode () const
 the mode QTextEdit will use when wrapping text by words More...
 
virtual ~QTextEdit ()
 Destructor. More...
 
- Public Functions inherited from QAbstractScrollArea
void addScrollBarWidget (QWidget *widget, Qt::Alignment alignment)
 Adds widget as a scroll bar widget in the location specified by alignment. More...
 
QWidgetcornerWidget () const
 Returns the widget in the corner between the two scroll bars. More...
 
QScrollBarhorizontalScrollBar () const
 Returns the horizontal scroll bar. More...
 
Qt::ScrollBarPolicy horizontalScrollBarPolicy () const
 
QSize maximumViewportSize () const
 Returns the size of the viewport as if the scroll bars had no valid scrolling range. More...
 
QSize minimumSizeHint () const
 Reimplemented Function More...
 
 QAbstractScrollArea (QWidget *parent=0)
 Constructs a viewport. More...
 
QWidgetList scrollBarWidgets (Qt::Alignment alignment)
 Returns a list of the currently set scroll bar widgets. More...
 
void setCornerWidget (QWidget *widget)
 Sets the widget in the corner between the two scroll bars to be widget. More...
 
void setHorizontalScrollBar (QScrollBar *scrollbar)
 Replaces the existing horizontal scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. More...
 
void setHorizontalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setVerticalScrollBar (QScrollBar *scrollbar)
 Replaces the existing vertical scroll bar with scrollBar, and sets all the former scroll bar's slider properties on the new scroll bar. More...
 
void setVerticalScrollBarPolicy (Qt::ScrollBarPolicy)
 
void setViewport (QWidget *widget)
 Sets the viewport to be the given widget. More...
 
QSize sizeHint () const
 Reimplemented Function More...
 
QScrollBarverticalScrollBar () const
 Returns the vertical scroll bar. More...
 
Qt::ScrollBarPolicy verticalScrollBarPolicy () const
 
QWidgetviewport () const
 Returns the viewport widget. More...
 
 ~QAbstractScrollArea ()
 Destroys the viewport. More...
 
- Public Functions inherited from QFrame
QRect frameRect () const
 
Shadow frameShadow () const
 
Shape frameShape () const
 
int frameStyle () const
 Returns the frame style. More...
 
int frameWidth () const
 
int lineWidth () const
 
int midLineWidth () const
 
 QFrame (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a frame widget with frame style NoFrame and a 1-pixel frame width. More...
 
void setFrameRect (const QRect &)
 em>Reimplemented Function More...
 
void setFrameShadow (Shadow)
 
void setFrameShape (Shape)
 
void setFrameStyle (int)
 Sets the frame style to style. More...
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
QSize sizeHint () const
 em>Reimplemented Function More...
 
 ~QFrame ()
 Destroys the frame. More...
 
- Public Functions inherited from QWidget
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions. More...
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window. More...
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions. More...
 
void addActions (QList< QAction *> actions)
 Appends the actions actions to this widget's list of actions. More...
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents. More...
 
bool autoFillBackground () const
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget. More...
 
QSize baseSize () const
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. More...
 
QWidgetchildAt (const QPoint &p) const
 Returns the visible child widget at point p in the widget's own coordinate system. More...
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 Takes keyboard input focus from the widget. More...
 
void clearMask ()
 Removes any mask set by setMask(). More...
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins. More...
 
QRect contentsRect () const
 Returns the area inside the widget's margins. More...
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void createWinId ()
 
QCursor cursor () const
 
int devType () const
 
WId effectiveWinId () const
 Returns the effective window system identifier of the widget, i. More...
 
void ensurePolished () const
 Ensures that the widget has been polished by QStyle (i.e., has a proper font and palette). More...
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 Returns the focus proxy, or 0 if there is no focus proxy. More...
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on. More...
 
const QFontfont () const
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font. More...
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font. More...
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role. More...
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 Returns the widget's contents margins for left, top, right, and bottom. More...
 
HDC getDC () const
 Returns the window system handle of the widget, for low-level access. More...
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags. More...
 
void grabKeyboard ()
 Grabs the keyboard input. More...
 
void grabMouse ()
 Grabs the mouse input. More...
 
void grabMouse (const QCursor &)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. More...
 
QGraphicsEffectgraphicsEffect () const
 The graphicsEffect function returns a pointer to the widget's graphics effect. More...
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0. More...
 
bool hasFocus () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w. More...
 
QInputContextinputContext ()
 This function returns the QInputContext for this widget. More...
 
Qt::InputMethodHints inputMethodHints () const
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before. More...
 
void insertActions (QAction *before, QList< QAction *> actions)
 Inserts the actions actions to this widget's list of actions, before the action before. More...
 
WId internalWinId () const
 Returns the window system identifier of the widget, or 0 if the widget is not created yet. More...
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false. More...
 
bool isEnabled () const
 
bool isEnabledTo (QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false. More...
 
bool isEnabledToTLW () const
 This function is deprecated. More...
 
bool isFullScreen () const
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false. More...
 
bool isLeftToRight () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isRightToLeft () const
 
bool isTopLevel () const
 Use isWindow() instead. More...
 
bool isVisible () const
 
bool isVisibleTo (QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false. More...
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false. More...
 
bool isWindowModified () const
 
QLayoutlayout () const
 Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed. More...
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
Qt::HANDLE macCGHandle () const
 Returns the CoreGraphics handle of the widget. More...
 
Qt::HANDLE macQDHandle () const
 Returns the QuickDraw handle of the widget. More...
 
QPoint mapFrom (QWidget *, const QPoint &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. More...
 
QPoint mapFromGlobal (const QPoint &) const
 Translates the global screen coordinate pos to widget coordinates. More...
 
QPoint mapFromParent (const QPoint &) const
 Translates the parent widget coordinate pos to widget coordinates. More...
 
QPoint mapTo (QWidget *, const QPoint &) const
 Translates the widget coordinate pos to the coordinate system of parent. More...
 
QPoint mapToGlobal (const QPoint &) const
 Translates the widget coordinate pos to global screen coordinates. More...
 
QPoint mapToParent (const QPoint &) const
 Translates the widget coordinate pos to a coordinate in the parent widget. More...
 
QRegion mask () const
 Returns the mask currently set on a widget. More...
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (int x, int y)
 This corresponds to move(QPoint(x, y)). More...
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 Returns the native parent for this widget, i. More...
 
QWidgetnextInFocusChain () const
 Returns the next widget in this widget's focus chain. More...
 
QRect normalGeometry () const
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system. More...
 
void overrideWindowState (Qt::WindowStates state)
 
QPaintEnginepaintEngine () const
 Returns the widget's paint engine. More...
 
const QPalettepalette () const
 
QWidgetparentWidget () const
 Returns the parent of this widget, or 0 if it does not have any parent widget. More...
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain. More...
 
 QWidget (QWidget *parent=0, Qt::WindowFlags f=0)
 Constructs a widget which is a child of parent, with widget flags set to f. More...
 
QRect rect () const
 
void releaseDC (HDC) const
 Releases the HDC hdc acquired by a previous call to getDC(). More...
 
void releaseKeyboard ()
 Releases the keyboard grab. More...
 
void releaseMouse ()
 Releases the mouse grab. More...
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system. More...
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions. More...
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. More...
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 Renders the widget into the painter's QPainter::device(). More...
 
void repaint (int x, int y, int w, int h)
 This version repaints a rectangle (x, y, w, h) inside the widget. More...
 
void repaint (const QRect &)
 This version repaints a rectangle rect inside the widget. More...
 
void repaint (const QRegion &)
 This version repaints a region rgn inside the widget. More...
 
void resize (int w, int h)
 This corresponds to resize(QSize(w, h)). More...
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 Restores the geometry and state top-level widgets stored in the byte array geometry. More...
 
QByteArray saveGeometry () const
 Saves the current geometry and state for top-level widgets. More...
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward. More...
 
void scroll (int dx, int dy, const QRect &)
 This version only scrolls r and does not move the children of the widget. More...
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. More...
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role. More...
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This corresponds to setBaseSize(QSize(basew, baseh)). More...
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. More...
 
void setContentsMargins (const QMargins &margins)
 The setContentsMargins function sets the margins around the widget's contents. More...
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths. More...
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. More...
 
void setFixedSize (int w, int h)
 Sets the width of the widget to w and the height to h. More...
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights. More...
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More...
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w. More...
 
void setFont (const QFont &)
 Use the single-argument overload instead. More...
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role. More...
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)). More...
 
void setGeometry (const QRect &)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 The setGraphicsEffect function is for setting the widget's graphics effect. More...
 
void setInputContext (QInputContext *)
 This function sets the input context context on this widget. More...
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout. More...
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. More...
 
void setMask (const QRegion &)
 Causes only the parts of the widget which overlap region to be visible. More...
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This function corresponds to setMaximumSize(QSize(maxw, maxh)). More...
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This function corresponds to setMinimumSize(QSize(minw, minh)). More...
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 Use the single-argument overload instead. More...
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags. More...
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This function also takes widget flags, f as an argument. More...
 
void setShortcutAutoRepeat (int id, bool enable=true)
 If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled. More...
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. More...
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 Sets the x (width) size increment to w and the y (height) size increment to h. More...
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. More...
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style. More...
 
void setToolTip (const QString &)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 Sets up the user interface for the specified widget. More...
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &)
 Sets the window's role to role. More...
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState. More...
 
void setWindowSurface (QWindowSurface *surface)
 Sets the window surface to be the surface specified. More...
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack. More...
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false. More...
 
QString toolTip () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false. More...
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type. More...
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update (int x, int y, int w, int h)
 This version updates a rectangle (x, y, w, h) inside the widget. More...
 
void update (const QRect &)
 This version updates a rectangle rect inside the widget. More...
 
void update (const QRegion &)
 This version repaints a region rgn inside the widget. More...
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry. More...
 
bool updatesEnabled () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur. More...
 
QString whatsThis () const
 
int width () const
 
QWidgetwindow () const
 Returns the window for this widget, i.e. More...
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e. More...
 
QIcon windowIcon () const
 
QString windowIconText () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 Returns the window's role, or an empty string. More...
 
Qt::WindowStates windowState () const
 Returns the current window state. More...
 
QWindowSurfacewindowSurface () const
 Returns the QWindowSurface this widget will be drawn into. More...
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 Returns the window type of this widget. More...
 
WId winId () const
 Returns the window system identifier of the widget. More...
 
int x () const
 
const QX11Infox11Info () const
 Returns information about the configuration of the X display used to display the widget. More...
 
Qt::HANDLE x11PictureHandle () const
 Returns the X11 Picture handle of the widget for XRender support. More...
 
int y () const
 
 ~QWidget ()
 Destroys the widget. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 
- Public Functions inherited from QPaintDevice
int colorCount () const
 
int depth () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
QT_DEPRECATED int numColors () const
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 
virtual ~QPaintDevice ()
 

Protected Functions

bool event (QEvent *e)
 Reimplemented Function More...
 
virtual bool focusNextPrevChild (bool next)
 Reimplemented Function More...
 
virtual void focusOutEvent (QFocusEvent *ev)
 Reimplemented Function More...
 
virtual void keyPressEvent (QKeyEvent *ev)
 The event ev is used to provide the following keyboard shortcuts: More...
 
virtual void mouseMoveEvent (QMouseEvent *ev)
 Reimplemented Function More...
 
virtual void mousePressEvent (QMouseEvent *ev)
 Reimplemented Function More...
 
virtual void mouseReleaseEvent (QMouseEvent *ev)
 Reimplemented Function More...
 
virtual void paintEvent (QPaintEvent *e)
 Reimplemented Function More...
 
- Protected Functions inherited from QTextEdit
virtual bool canInsertFromMimeData (const QMimeData *source) const
 This function returns true if the contents of the MIME data object, specified by source, can be decoded and inserted into the document. More...
 
virtual void changeEvent (QEvent *e)
 Reimplemented Function More...
 
virtual void contextMenuEvent (QContextMenuEvent *e)
 Shows the standard context menu created with createStandardContextMenu(). More...
 
virtual QMimeDatacreateMimeDataFromSelection () const
 This function returns a new MIME data object to represent the contents of the text edit's current selection. More...
 
virtual void dragEnterEvent (QDragEnterEvent *e)
 Reimplemented Function More...
 
virtual void dragLeaveEvent (QDragLeaveEvent *e)
 Reimplemented Function More...
 
virtual void dragMoveEvent (QDragMoveEvent *e)
 Reimplemented Function More...
 
virtual void dropEvent (QDropEvent *e)
 Reimplemented Function More...
 
virtual void focusInEvent (QFocusEvent *e)
 Reimplemented Function More...
 
virtual void inputMethodEvent (QInputMethodEvent *)
 Reimplemented Function More...
 
QVariant inputMethodQuery (Qt::InputMethodQuery property) const
 This method is only relevant for input widgets. More...
 
virtual void insertFromMimeData (const QMimeData *source)
 This function inserts the contents of the MIME data object, specified by source, into the text edit at the current cursor position. More...
 
virtual void keyReleaseEvent (QKeyEvent *e)
 Reimplemented Function More...
 
virtual void mouseDoubleClickEvent (QMouseEvent *e)
 Reimplemented Function More...
 
 QTextEdit (QTextEditPrivate &dd, QWidget *parent)
 
virtual void resizeEvent (QResizeEvent *e)
 Reimplemented Function More...
 
virtual void scrollContentsBy (int dx, int dy)
 em>Reimplemented Function More...
 
virtual void showEvent (QShowEvent *)
 Reimplemented Function More...
 
virtual void timerEvent (QTimerEvent *e)
 
virtual void wheelEvent (QWheelEvent *e)
 Reimplemented Function More...
 
- Protected Functions inherited from QAbstractScrollArea
 QAbstractScrollArea (QAbstractScrollAreaPrivate &dd, QWidget *parent=0)
 Creates a new QAbstractScrollAreaPrivate, dd with the given parent. More...
 
void setViewportMargins (int left, int top, int right, int bottom)
 Sets the margins around the scrolling area to left, top, right and bottom. More...
 
void setViewportMargins (const QMargins &margins)
 Sets margins around the scrolling area. More...
 
virtual bool viewportEvent (QEvent *)
 The main event handler for the scrolling area (the viewport() widget). More...
 
- Protected Functions inherited from QFrame
void drawFrame (QPainter *)
 em>Reimplemented Function More...
 
 QFrame (QFramePrivate &dd, QWidget *parent=0, Qt::WindowFlags f=0)
 
- Protected Functions inherited from QWidget
virtual void actionEvent (QActionEvent *)
 This event handler is called with the given event whenever the widget's actions are changed. More...
 
virtual void closeEvent (QCloseEvent *)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system. More...
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window if window is 0, otherwise sets the widget's window to window. More...
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources. More...
 
virtual void enabledChange (bool)
 
virtual void enterEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. More...
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for Tab, and returns true if it can find a new widget, or false if it can't. More...
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for Shift+Tab, and returns true if it can find a new widget, or false if it can't. More...
 
virtual void fontChange (const QFont &)
 
virtual void hideEvent (QHideEvent *)
 This event handler can be reimplemented in a subclass to receive widget hide events. More...
 
virtual void languageChange ()
 
virtual void leaveEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. More...
 
virtual bool macEvent (EventHandlerCallRef, EventRef)
 This special event handler can be reimplemented in a subclass to receive native Macintosh events. More...
 
int metric (PaintDeviceMetric) const
 Internal implementation of the virtual QPaintDevice::metric() function. More...
 
virtual void moveEvent (QMoveEvent *)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. More...
 
virtual void paletteChange (const QPalette &)
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
virtual bool qwsEvent (QWSEvent *)
 This special event handler can be reimplemented in a subclass to receive native Qt for Embedded Linux events which are passed in the event parameter. More...
 
void resetInputContext ()
 This function can be called on the widget that currently has focus to reset the input method operating on it. More...
 
virtual void styleChange (QStyle &)
 
virtual void tabletEvent (QTabletEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive tablet events for the widget. More...
 
virtual void windowActivationChange (bool)
 
virtual bool winEvent (MSG *message, long *result)
 This special event handler can be reimplemented in a subclass to receive native Windows events which are passed in the message parameter. More...
 
virtual bool x11Event (XEvent *)
 This special event handler can be reimplemented in a subclass to receive native X11 events passed in the event parameter. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
- Protected Functions inherited from QPaintDevice
 QPaintDevice ()
 

Properties

bool openExternalLinks
 Specifies whether QTextBrowser should automatically open links to external sources using QDesktopServices::openUrl() instead of emitting the anchorClicked signal. More...
 
bool openLinks
 This property specifies whether QTextBrowser should automatically open links the user tries to activate by mouse or keyboard. More...
 
QStringList searchPaths
 the search paths used by the text browser to find supporting content More...
 
QUrl source
 the name of the displayed document. More...
 

Additional Inherited Members

- Public Types inherited from QTextEdit
enum  AutoFormattingFlag { AutoNone = 0, AutoBulletList = 0x00000001, AutoAll = 0xffffffff }
 
enum  LineWrapMode { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }
 
- Public Types inherited from QFrame
enum  Shadow { Plain = 0x0010, Raised = 0x0020, Sunken = 0x0030 }
 This enum type defines the types of shadow that are used to give a 3D effect to frames. More...
 
enum  Shape {
  NoFrame = 0, Box = 0x0001, Panel = 0x0002, WinPanel = 0x0003,
  HLine = 0x0004, VLine = 0x0005, StyledPanel = 0x0006
}
 This enum type defines the shapes of frame available. More...
 
enum  StyleMask { Shadow_Mask = 0x00f0, Shape_Mask = 0x000f }
 This enum defines two constants that can be used to extract the two components of frameStyle(): More...
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1, DrawChildren = 0x2, IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1, PdmHeight, PdmWidthMM, PdmHeightMM,
  PdmNumColors, PdmDepth, PdmDpiX, PdmDpiY,
  PdmPhysicalDpiX, PdmPhysicalDpiY
}
 
- Static Public Functions inherited from QWidget
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifer/handle id. More...
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input. More...
 
static QWidgetmouseGrabber ()
 Returns the widget that is currently grabbing the mouse input. More...
 
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Functions inherited from QPaintDevice
static QWSDisplayqwsDisplay ()
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Slots inherited from QAbstractScrollArea
void setupViewport (QWidget *viewport)
 This slot is called by QAbstractScrollArea after setViewport(viewport) has been called. More...
 
- Protected Slots inherited from QWidget
void updateMicroFocus ()
 Updates the widget's micro focus. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Variables inherited from QPaintDevice
ushort painters
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QTextBrowser class provides a rich text browser with hypertext navigation.

This class extends QTextEdit (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents.

If you want to provide your users with an editable rich text editor, use QTextEdit. If you want a text browser without hypertext navigation use QTextEdit, and use QTextEdit::setReadOnly() to disable editing. If you just need to display a small piece of rich text use QLabel.

Document Source and Contents

The contents of QTextEdit are set with setHtml() or setPlainText(), but QTextBrowser also implements the setSource() function, making it possible to use a named document as the source text. The name is looked up in a list of search paths and in the directory of the current document factory.

If a document name ends with an anchor (for example, "\c #anchor"), the text browser automatically scrolls to that position (using scrollToAnchor()). When the user clicks on a hyperlink, the browser will call setSource() itself with the link's href value as argument. You can track the current source by connecting to the sourceChanged() signal.

Navigation

QTextBrowser provides backward() and forward() slots which you can use to implement Back and Forward buttons. The home() slot sets the text to the very first document displayed. The anchorClicked() signal is emitted when the user clicks an anchor. To override the default navigation behavior of the browser, call the setSource() function to supply new document text in a slot connected to this signal.

If you want to load documents stored in the Qt resource system use qrc as the scheme in the URL to load. For example, for the document resource path :/docs/index.html use qrc:/docs/index.html as the URL with setSource(). To access local files, use file as the scheme in the URL.

See also
QTextEdit, QTextDocument

Definition at line 58 of file qtextbrowser.h.

Constructors and Destructors

◆ QTextBrowser()

QTextBrowser::QTextBrowser ( QWidget parent = 0)
explicit

Constructs an empty QTextBrowser with parent parent.

Definition at line 678 of file qtextbrowser.cpp.

679  : QTextEdit(*new QTextBrowserPrivate, parent)
680 {
681  Q_D(QTextBrowser);
682  d->init();
683 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
QTextEdit(QWidget *parent=0)
Constructs an empty QTextEdit with parent parent.
Definition: qtextedit.cpp:608
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ ~QTextBrowser()

QTextBrowser::~QTextBrowser ( )
virtual
Warning
This function is not part of the public interface.

Definition at line 702 of file qtextbrowser.cpp.

703 {
704 }

Functions

◆ anchorClicked

void QTextBrowser::anchorClicked ( const QUrl link)
signal

This signal is emitted when the user clicks an anchor.

The URL referred to by the anchor is passed in link.

Note that the browser will automatically handle navigation to the location specified by link unless the openLinks property is set to false or you call setSource() in a slot connected. This mechanism is used to override the default navigation features of the browser.

◆ backward

void QTextBrowser::backward ( )
virtualslot

Changes the document displayed to the previous document in the list of documents built by navigating links.

Does nothing if there is no previous document.

See also
forward(), backwardAvailable()

Definition at line 905 of file qtextbrowser.cpp.

Referenced by keyPressEvent().

906 {
907  Q_D(QTextBrowser);
908  if (d->stack.count() <= 1)
909  return;
910 
911  // Update the history entry
912  d->forwardStack.push(d->createHistoryEntry());
913  d->stack.pop(); // throw away the old version of the current entry
914  d->restoreHistoryEntry(d->stack.top()); // previous entry
915  emit backwardAvailable(d->stack.count() > 1);
916  emit forwardAvailable(true);
918 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
void historyChanged()
This signal is emitted when the history changes.
#define emit
Definition: qobjectdefs.h:76
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
void backwardAvailable(bool)
This signal is emitted when the availability of backward() changes.
void forwardAvailable(bool)
This signal is emitted when the availability of forward() changes.

◆ backwardAvailable

void QTextBrowser::backwardAvailable ( bool  available)
signal

This signal is emitted when the availability of backward() changes.

available is false when the user is at home(); otherwise it is true.

Referenced by backward(), clearHistory(), forward(), and setSource().

◆ backwardHistoryCount()

int QTextBrowser::backwardHistoryCount ( ) const

Returns the number of locations backward in the history.

Since
4.4

Definition at line 1261 of file qtextbrowser.cpp.

1262 {
1263  Q_D(const QTextBrowser);
1264  return d->stack.count()-1;
1265 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ clearHistory()

void QTextBrowser::clearHistory ( )

Clears the history of visited documents and disables the forward and backward navigation.

Since
4.2
See also
backward(), forward()

Definition at line 1191 of file qtextbrowser.cpp.

1192 {
1193  Q_D(QTextBrowser);
1194  d->forwardStack.clear();
1195  if (!d->stack.isEmpty()) {
1196  QTextBrowserPrivate::HistoryEntry historyEntry = d->stack.top();
1197  d->stack.resize(0);
1198  d->stack.push(historyEntry);
1199  d->home = historyEntry.url;
1200  }
1201  emit forwardAvailable(false);
1202  emit backwardAvailable(false);
1203  emit historyChanged();
1204 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
void historyChanged()
This signal is emitted when the history changes.
#define emit
Definition: qobjectdefs.h:76
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
void backwardAvailable(bool)
This signal is emitted when the availability of backward() changes.
void forwardAvailable(bool)
This signal is emitted when the availability of forward() changes.

◆ event()

bool QTextBrowser::event ( QEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1321 of file qtextbrowser.cpp.

1322 {
1323  return QTextEdit::event(e);
1324 }
virtual bool event(QEvent *e)
Definition: qtextedit.cpp:1071

◆ focusNextPrevChild()

bool QTextBrowser::focusNextPrevChild ( bool  next)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1070 of file qtextbrowser.cpp.

1071 {
1072  Q_D(QTextBrowser);
1073  if (d->control->setFocusToNextOrPreviousAnchor(next)) {
1074 #ifdef QT_KEYPAD_NAVIGATION
1075  // Might need to synthesize a highlight event.
1076  if (d->prevFocus != d->control->textCursor() && d->control->textCursor().hasSelection()) {
1077  const QString href = d->control->anchorAtCursor();
1078  QUrl url = d->resolveUrl(href);
1079  emit highlighted(url);
1080  emit highlighted(url.toString());
1081  }
1082  d->prevFocus = d->control->textCursor();
1083 #endif
1084  return true;
1085  } else {
1086 #ifdef QT_KEYPAD_NAVIGATION
1087  // We assume we have no highlight now.
1088  emit highlighted(QUrl());
1090 #endif
1091  }
1092  return QTextEdit::focusNextPrevChild(next);
1093 }
double d
Definition: qnumeric_p.h:62
QString toString(FormattingOptions options=None) const
Returns the human-displayable string representation of the URL.
Definition: qurl.cpp:5896
virtual bool focusNextPrevChild(bool next)
Reimplemented Function
Definition: qtextedit.cpp:1627
The QUrl class provides a convenient interface for working with URLs.
Definition: qurl.h:61
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_D(Class)
Definition: qglobal.h:2482
#define emit
Definition: qobjectdefs.h:76
void highlighted(const QUrl &)
This signal is emitted when the user has selected but not activated an anchor in the document...
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ focusOutEvent()

void QTextBrowser::focusOutEvent ( QFocusEvent ev)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1058 of file qtextbrowser.cpp.

1059 {
1060 #ifndef QT_NO_CURSOR
1061  Q_D(QTextBrowser);
1062  d->viewport->setCursor((!(d->control->textInteractionFlags() & Qt::TextEditable)) ? d->oldCursor : Qt::IBeamCursor);
1063 #endif
1065 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
virtual void focusOutEvent(QFocusEvent *e)
Reimplemented Function
Definition: qtextedit.cpp:1758
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ forward

void QTextBrowser::forward ( )
virtualslot

Changes the document displayed to the next document in the list of documents built by navigating links.

Does nothing if there is no next document.

See also
backward(), forwardAvailable()

Definition at line 927 of file qtextbrowser.cpp.

Referenced by keyPressEvent().

928 {
929  Q_D(QTextBrowser);
930  if (d->forwardStack.isEmpty())
931  return;
932  if (!d->stack.isEmpty()) {
933  // Update the history entry
934  d->stack.top() = d->createHistoryEntry();
935  }
936  d->stack.push(d->forwardStack.pop());
937  d->restoreHistoryEntry(d->stack.top());
938  emit backwardAvailable(true);
939  emit forwardAvailable(!d->forwardStack.isEmpty());
941 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
void historyChanged()
This signal is emitted when the history changes.
#define emit
Definition: qobjectdefs.h:76
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
void backwardAvailable(bool)
This signal is emitted when the availability of backward() changes.
void forwardAvailable(bool)
This signal is emitted when the availability of forward() changes.

◆ forwardAvailable

void QTextBrowser::forwardAvailable ( bool  available)
signal

This signal is emitted when the availability of forward() changes.

available is true after the user navigates backward() and false when the user navigates or goes forward().

Referenced by backward(), clearHistory(), forward(), and setSource().

◆ forwardHistoryCount()

int QTextBrowser::forwardHistoryCount ( ) const

Returns the number of locations forward in the history.

Since
4.4

Definition at line 1250 of file qtextbrowser.cpp.

1251 {
1252  Q_D(const QTextBrowser);
1253  return d->forwardStack.count();
1254 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ highlighted [1/2]

void QTextBrowser::highlighted ( const QUrl link)
signal

This signal is emitted when the user has selected but not activated an anchor in the document.

The URL referred to by the anchor is passed in link.

Referenced by focusNextPrevChild().

◆ highlighted [2/2]

void QTextBrowser::highlighted ( const QString link)
signal

Convenience signal that allows connecting to a slot that takes just a QString, like for example QStatusBar's message().

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ historyChanged

void QTextBrowser::historyChanged ( )
signal

This signal is emitted when the history changes.

Since
4.4
See also
historyTitle(), historyUrl()

Referenced by backward(), clearHistory(), forward(), and setSource().

◆ historyTitle()

QString QTextBrowser::historyTitle ( int  i) const

Returns the documentTitle() of the HistoryItem.

Input Return
{i} < 0 backward() history
{i} == 0 current, see QTextBrowser::source()
{i} > 0 forward() history
backaction.setToolTip(browser.historyTitle(-1));
forwardaction.setToolTip(browser.historyTitle(+1));
Since
4.4

Definition at line 1238 of file qtextbrowser.cpp.

1239 {
1240  Q_D(const QTextBrowser);
1241  return d->history(i).title;
1242 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ historyUrl()

QUrl QTextBrowser::historyUrl ( int  i) const

Returns the url of the HistoryItem.

Input Return
{i} < 0 backward() history

{i} == 0

current, see QTextBrowser::source()

{i} > 0

forward() history

Since
4.4

Definition at line 1218 of file qtextbrowser.cpp.

1219 {
1220  Q_D(const QTextBrowser);
1221  return d->history(i).url;
1222 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ home

void QTextBrowser::home ( )
virtualslot

Changes the document displayed to be the first document from the history.

Definition at line 947 of file qtextbrowser.cpp.

Referenced by keyPressEvent().

948 {
949  Q_D(QTextBrowser);
950  if (d->home.isValid())
951  setSource(d->home);
952 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
virtual void setSource(const QUrl &name)
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ isBackwardAvailable()

bool QTextBrowser::isBackwardAvailable ( ) const

Returns true if the text browser can go backward in the document history using backward().

Since
4.2
See also
backwardAvailable(), backward()

Definition at line 1157 of file qtextbrowser.cpp.

1158 {
1159  Q_D(const QTextBrowser);
1160  return d->stack.count() > 1;
1161 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ isForwardAvailable()

bool QTextBrowser::isForwardAvailable ( ) const

Returns true if the text browser can go forward in the document history using forward().

Since
4.2
See also
forwardAvailable(), forward()

Definition at line 1174 of file qtextbrowser.cpp.

1175 {
1176  Q_D(const QTextBrowser);
1177  return !d->forwardStack.isEmpty();
1178 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ keyPressEvent()

void QTextBrowser::keyPressEvent ( QKeyEvent ev)
protectedvirtual

The event ev is used to provide the following keyboard shortcuts:

Keypress Action
Alt+Left Arrow backward()
Alt+Right Arrow forward()
Alt+Up Arrow home()

Reimplemented from QTextEdit.

Definition at line 963 of file qtextbrowser.cpp.

964 {
965 #ifdef QT_KEYPAD_NAVIGATION
966  Q_D(QTextBrowser);
967  switch (ev->key()) {
968  case Qt::Key_Select:
969  if (QApplication::keypadNavigationEnabled()) {
970  if (!hasEditFocus()) {
971  setEditFocus(true);
972  return;
973  } else {
974  QTextCursor cursor = d->control->textCursor();
975  QTextCharFormat charFmt = cursor.charFormat();
976  if (!cursor.hasSelection() || charFmt.anchorHref().isEmpty()) {
977  ev->accept();
978  return;
979  }
980  }
981  }
982  break;
983  case Qt::Key_Back:
984  if (QApplication::keypadNavigationEnabled()) {
985  if (hasEditFocus()) {
986  setEditFocus(false);
987  ev->accept();
988  return;
989  }
990  }
992  return;
993  default:
994  if (QApplication::keypadNavigationEnabled() && !hasEditFocus()) {
995  ev->ignore();
996  return;
997  }
998  }
999 #endif
1000 
1001  if (ev->modifiers() & Qt::AltModifier) {
1002  switch (ev->key()) {
1003  case Qt::Key_Right:
1004  forward();
1005  ev->accept();
1006  return;
1007  case Qt::Key_Left:
1008  backward();
1009  ev->accept();
1010  return;
1011  case Qt::Key_Up:
1012  home();
1013  ev->accept();
1014  return;
1015  }
1016  }
1017 #ifdef QT_KEYPAD_NAVIGATION
1018  else {
1019  if (ev->key() == Qt::Key_Up) {
1020  d->keypadMove(false);
1021  return;
1022  } else if (ev->key() == Qt::Key_Down) {
1023  d->keypadMove(true);
1024  return;
1025  }
1026  }
1027 #endif
1029 }
double d
Definition: qnumeric_p.h:62
The QTextCharFormat class provides formatting information for characters in a QTextDocument.
Definition: qtextformat.h:372
QTextCharFormat charFormat() const
Returns the format of the character immediately before the cursor position().
virtual void forward()
Changes the document displayed to the next document in the list of documents built by navigating link...
QCursor cursor() const
QString anchorHref() const
Returns the text format&#39;s hypertext link, or an empty string if none has been set.
Definition: qtextformat.h:506
#define Q_D(Class)
Definition: qglobal.h:2482
Qt::KeyboardModifiers modifiers() const
Returns the keyboard modifier flags that existed immediately after the event occurred.
Definition: qevent.cpp:999
int key() const
Returns the code of the key that was pressed or released.
Definition: qevent.h:231
virtual void home()
Changes the document displayed to be the first document from the history.
bool hasSelection() const
Returns true if the cursor contains a selection; otherwise returns false.
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
The QTextCursor class offers an API to access and modify QTextDocuments.
Definition: qtextcursor.h:70
virtual void backward()
Changes the document displayed to the previous document in the list of documents built by navigating ...
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
void ignore()
Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
Definition: qcoreevent.h:310
void accept()
Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
Definition: qcoreevent.h:309
virtual void keyPressEvent(QKeyEvent *e)
Reimplemented Function
Definition: qtextedit.cpp:1210

◆ loadResource()

QVariant QTextBrowser::loadResource ( int  type,
const QUrl name 
)
virtual

This function is called when the document is loaded and for each image in the document.

The type indicates the type of resource to be loaded. An invalid QVariant is returned if the resource cannot be loaded.

The default implementation ignores type and tries to locate the resources by interpreting name as a file name. If it is not an absolute path it tries to find the file in the paths of the searchPaths property and in the same directory as the current source. On success, the result is a QVariant that stores a QByteArray with the contents of the file.

If you reimplement this function, you can return other QVariant types. The table below shows which variant types are supported depending on the resource type:

ResourceType QVariant::Type
QTextDocument::HtmlResource QString or QByteArray
QTextDocument::ImageResource QImage, QPixmap or QByteArray
QTextDocument::StyleSheetResource QString or QByteArray

Reimplemented from QTextEdit.

Definition at line 1129 of file qtextbrowser.cpp.

1130 {
1131  Q_D(QTextBrowser);
1132 
1133  QByteArray data;
1134  QString fileName = d->findFile(d->resolveUrl(name));
1135  QFile f(fileName);
1136  if (f.open(QFile::ReadOnly)) {
1137  data = f.readAll();
1138  f.close();
1139  } else {
1140  return QVariant();
1141  }
1142 
1143  return data;
1144 }
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
double d
Definition: qnumeric_p.h:62
The QByteArray class provides an array of bytes.
Definition: qbytearray.h:135
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_D(Class)
Definition: qglobal.h:2482
QWidgetData * data
Definition: qwidget.h:815
The QFile class provides an interface for reading from and writing to files.
Definition: qfile.h:65
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
static QString fileName(const QString &fileUrl)

◆ mouseMoveEvent()

void QTextBrowser::mouseMoveEvent ( QMouseEvent ev)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1034 of file qtextbrowser.cpp.

1035 {
1037 }
virtual void mouseMoveEvent(QMouseEvent *e)
Reimplemented Function
Definition: qtextedit.cpp:1587

◆ mousePressEvent()

void QTextBrowser::mousePressEvent ( QMouseEvent ev)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1042 of file qtextbrowser.cpp.

1043 {
1045 }
virtual void mousePressEvent(QMouseEvent *e)
Reimplemented Function
Definition: qtextedit.cpp:1575

◆ mouseReleaseEvent()

void QTextBrowser::mouseReleaseEvent ( QMouseEvent ev)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1050 of file qtextbrowser.cpp.

1051 {
1053 }
virtual void mouseReleaseEvent(QMouseEvent *e)
Reimplemented Function
Definition: qtextedit.cpp:1604

◆ openExternalLinks()

bool QTextBrowser::openExternalLinks ( ) const

Referenced by backwardHistoryCount().

◆ openLinks()

bool QTextBrowser::openLinks ( ) const

Referenced by setOpenExternalLinks().

◆ paintEvent()

void QTextBrowser::paintEvent ( QPaintEvent e)
protectedvirtual

Reimplemented Function

Reimplemented from QTextEdit.

Definition at line 1098 of file qtextbrowser.cpp.

1099 {
1100  Q_D(QTextBrowser);
1101  QPainter p(d->viewport);
1102  d->paint(&p, e);
1103 }
The QPainter class performs low-level painting on widgets and other paint devices.
Definition: qpainter.h:86
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ reload

void QTextBrowser::reload ( )
virtualslot

Reloads the current set source.

Definition at line 767 of file qtextbrowser.cpp.

768 {
769  Q_D(QTextBrowser);
770  QUrl s = d->currentURL;
771  d->currentURL = QUrl();
772  setSource(s);
773 }
double d
Definition: qnumeric_p.h:62
The QUrl class provides a convenient interface for working with URLs.
Definition: qurl.h:61
#define Q_D(Class)
Definition: qglobal.h:2482
virtual void setSource(const QUrl &name)
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ searchPaths()

QStringList QTextBrowser::searchPaths ( ) const

Referenced by ~QTextBrowser().

◆ setOpenExternalLinks()

void QTextBrowser::setOpenExternalLinks ( bool  open)

Definition at line 1287 of file qtextbrowser.cpp.

Referenced by QMessageBox::setInformativeText().

1288 {
1289  Q_D(QTextBrowser);
1290  d->openExternalLinks = open;
1291 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
int open(const char *, int,...)

◆ setOpenLinks()

void QTextBrowser::setOpenLinks ( bool  open)

Definition at line 1314 of file qtextbrowser.cpp.

1315 {
1316  Q_D(QTextBrowser);
1317  d->openLinks = open;
1318 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
int open(const char *, int,...)

◆ setSearchPaths()

void QTextBrowser::setSearchPaths ( const QStringList paths)

Definition at line 758 of file qtextbrowser.cpp.

759 {
760  Q_D(QTextBrowser);
761  d->searchPaths = paths;
762 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58

◆ setSource

void QTextBrowser::setSource ( const QUrl name)
virtualslot

Definition at line 775 of file qtextbrowser.cpp.

Referenced by home(), and reload().

776 {
777  Q_D(QTextBrowser);
778 
779  const QTextBrowserPrivate::HistoryEntry historyEntry = d->createHistoryEntry();
780 
781  d->setSource(url);
782 
783  if (!url.isValid())
784  return;
785 
786  // the same url you are already watching?
787  if (!d->stack.isEmpty() && d->stack.top().url == url)
788  return;
789 
790  if (!d->stack.isEmpty())
791  d->stack.top() = historyEntry;
792 
794  entry.url = url;
795  entry.title = documentTitle();
796  entry.hpos = 0;
797  entry.vpos = 0;
798  d->stack.push(entry);
799 
800  emit backwardAvailable(d->stack.count() > 1);
801 
802  if (!d->forwardStack.isEmpty() && d->forwardStack.top().url == url) {
803  d->forwardStack.pop();
804  emit forwardAvailable(d->forwardStack.count() > 0);
805  } else {
806  d->forwardStack.clear();
807  emit forwardAvailable(false);
808  }
809 
811 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482
QString documentTitle() const
Definition: qtextedit.h:170
void historyChanged()
This signal is emitted when the history changes.
#define emit
Definition: qobjectdefs.h:76
The QTextBrowser class provides a rich text browser with hypertext navigation.
Definition: qtextbrowser.h:58
void backwardAvailable(bool)
This signal is emitted when the availability of backward() changes.
void forwardAvailable(bool)
This signal is emitted when the availability of forward() changes.

◆ source()

QUrl QTextBrowser::source ( ) const

Referenced by ~QTextBrowser().

◆ sourceChanged

void QTextBrowser::sourceChanged ( const QUrl src)
signal

This signal is emitted when the source has changed, src being the new source.

Source changes happen both programmatically when calling setSource(), forward(), backword() or home() or when the user clicks on links or presses the equivalent key sequences.

Properties

◆ openExternalLinks

bool QTextBrowser::openExternalLinks
private

Specifies whether QTextBrowser should automatically open links to external sources using QDesktopServices::openUrl() instead of emitting the anchorClicked signal.

Since
4.2

Links are considered external if their scheme is neither file or qrc.

The default value is false.

Definition at line 67 of file qtextbrowser.h.

◆ openLinks

bool QTextBrowser::openLinks
private

This property specifies whether QTextBrowser should automatically open links the user tries to activate by mouse or keyboard.

Since
4.3

Regardless of the value of this property the anchorClicked signal is always emitted.

The default value is true.

Definition at line 68 of file qtextbrowser.h.

◆ searchPaths

QStringList QTextBrowser::searchPaths
private

the search paths used by the text browser to find supporting content

QTextBrowser uses this list to locate images and documents.

By default, this property contains an empty string list.

Definition at line 66 of file qtextbrowser.h.

◆ source

QUrl QTextBrowser::source
private

the name of the displayed document.

This is a an invalid url if no document is displayed or if the source is unknown.

When setting this property QTextBrowser tries to find a document with the specified name in the paths of the searchPaths property and directory of the current source, unless the value is an absolute file path. It also checks for optional anchors and scrolls the document accordingly

If the first tag in the document is <qt type="detail">, the document is displayed as a popup rather than as new document in the browser window itself. Otherwise, the document is displayed normally in the text browser with the text set to the contents of the named document with setHtml().

By default, this property contains an empty URL.

Definition at line 62 of file qtextbrowser.h.

Referenced by getImage(), and getPixmap().


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