From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqsimplerichtext.html | 223 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 223 insertions(+) create mode 100644 doc/html/ntqsimplerichtext.html (limited to 'doc/html/ntqsimplerichtext.html') diff --git a/doc/html/ntqsimplerichtext.html b/doc/html/ntqsimplerichtext.html new file mode 100644 index 000000000..3bba1f9a5 --- /dev/null +++ b/doc/html/ntqsimplerichtext.html @@ -0,0 +1,223 @@ + + + + + +TQSimpleRichText Class + + + + + + + +

TQSimpleRichText Class Reference

+ +

The TQSimpleRichText class provides a small displayable piece of rich text. +More... +

#include <ntqsimplerichtext.h> +

List of all member functions. +

Public Members

TQSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 )
TQSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE )
~TQSimpleRichText ()
void setWidth ( int w )
void setWidth ( TQPainter * p, int w )
void setDefaultFont ( const TQFont & f )
int width () const
int widthUsed () const
int height () const
void adjustSize ()
void draw ( TQPainter * p, int x, int y, const TQRect & clipRect, const TQColorGroup & cg, const TQBrush * paper = 0 ) const
void draw ( TQPainter * p, int x, int y, const TQRegion & clipRegion, const TQColorGroup & cg, const TQBrush * paper = 0 ) const (obsolete)
TQString context () const
TQString anchorAt ( const TQPoint & pos ) const
bool inText ( const TQPoint & pos ) const

Detailed Description

+ + +The TQSimpleRichText class provides a small displayable piece of rich text. +

+ +

This class encapsulates simple rich text usage in which a string +is interpreted as rich text and can be drawn. This is particularly +useful if you want to display some rich text in a custom widget. A +TQStyleSheet is needed to interpret the tags and format the rich +text. TQt provides a default HTML-like style sheet, but you may +define custom style sheets. +

Once created, the rich text object can be queried for its width(), +height(), and the actual width used (see widthUsed()). Most +importantly, it can be drawn on any given TQPainter with draw(). +TQSimpleRichText can also be used to implement hypertext or active +text facilities by using anchorAt(). A hit test through inText() +makes it possible to use simple rich text for text objects in +editable drawing canvases. +

Once constructed from a string the contents cannot be changed, +only resized. If the contents change, just throw the rich text +object away and make a new one with the new contents. +

For large documents use TQTextEdit or TQTextBrowser. For very small +items of rich text you can use a TQLabel. +

If you are using TQSimpleRichText to print in high resolution you +should call setWidth(TQPainter, int) so that the content will be +laid out properly on the page. +

Member Function Documentation

TQSimpleRichText::TQSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context = TQString::null, const TQStyleSheet * sheet = 0 ) +

+Constructs a TQSimpleRichText from the rich text string text and +the font fnt. +

The font is used as a basis for the text rendering. When using +rich text rendering on a widget w, you would normally specify +the widget's font, for example: +

+    TQSimpleRichText myrichtext( contents, mywidget->font() );
+

+ +

context is the optional context of the rich text object. This +becomes important if text contains relative references, for +example within image tags. TQSimpleRichText always uses the default +mime source factory (see TQMimeSourceFactory::defaultFactory()) +to resolve those references. The context will then be used to +calculate the absolute path. See +TQMimeSourceFactory::makeAbsolute() for details. +

The sheet is an optional style sheet. If it is 0, the default +style sheet will be used (see TQStyleSheet::defaultSheet()). + +

TQSimpleRichText::TQSimpleRichText ( const TQString & text, const TQFont & fnt, const TQString & context, const TQStyleSheet * sheet, const TQMimeSourceFactory * factory, int pageBreak = -1, const TQColor & linkColor = TQt::blue, bool linkUnderline = TRUE ) +

+Constructs a TQSimpleRichText from the rich text string text and +the font fnt. +

This is a slightly more complex constructor for TQSimpleRichText +that takes an additional mime source factory factory, a page +break parameter pageBreak and a bool linkUnderline. linkColor is only provided for compatibility, but has no effect, +as TQColorGroup's TQColorGroup::link() color is used now. +

The sheet is an optional style sheet. If it is 0, the default +style sheet will be used (see TQStyleSheet::defaultSheet()). +

This constructor is useful for creating a TQSimpleRichText object +suitable for printing. Set pageBreak to be the height of the +contents area of the pages. + +

TQSimpleRichText::~TQSimpleRichText () +

+Destroys the rich text object, freeing memory. + +

void TQSimpleRichText::adjustSize () +

+Adjusts the richt text object to a reasonable size. +

TQString TQSimpleRichText::anchorAt ( const TQPoint & pos ) const +

+Returns the anchor at the requested position, pos. An empty +string is returned if no anchor is specified for this position. + +

TQString TQSimpleRichText::context () const +

+Returns the context of the rich text object. If no context has +been specified in the constructor, a null string is returned. The +context is the path to use to look up relative links, such as +image tags and anchor references. + +

void TQSimpleRichText::draw ( TQPainter * p, int x, int y, const TQRect & clipRect, const TQColorGroup & cg, const TQBrush * paper = 0 ) const +

+Draws the formatted text with painter p, at position (x, y), clipped to clipRect. The clipping rectangle is given in the +rich text object's coordinates translated by (x, y). Passing +an null rectangle results in no clipping. Colors from the color +group cg are used as needed, and if not 0, *paper is used as +the background brush. +

Note that the display code is highly optimized to reduce flicker, +so passing a brush for paper is preferable to simply clearing +the area to be painted and then calling this without a brush. + +

Examples: action/application.cpp, application/application.cpp, helpviewer/helpwindow.cpp, and mdi/application.cpp. +

void TQSimpleRichText::draw ( TQPainter * p, int x, int y, const TQRegion & clipRegion, const TQColorGroup & cg, const TQBrush * paper = 0 ) const +

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code. +

Use the version with clipRect instead. The region version has +problems with larger documents on some platforms (on X11 regions +internally are represented with 16bit coordinates). + +

int TQSimpleRichText::height () const +

+Returns the height of the rich text object in pixels. +

bool TQSimpleRichText::inText ( const TQPoint & pos ) const +

+Returns TRUE if pos is within a text line of the rich text +object; otherwise returns FALSE. + +

void TQSimpleRichText::setDefaultFont ( const TQFont & f ) +

+Sets the default font for the rich text object to f + +

void TQSimpleRichText::setWidth ( TQPainter * p, int w ) +

+Sets the width of the rich text object to w pixels, +recalculating the layout as if it were to be drawn with painter p. +

Passing a painter is useful when you intend drawing on devices +other than the screen, for example a TQPrinter. +

void TQSimpleRichText::setWidth ( int w ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Sets the width of the rich text object to w pixels. +

int TQSimpleRichText::width () const +

+Returns the set width of the rich text object in pixels. +

int TQSimpleRichText::widthUsed () const +

+Returns the width in pixels that is actually used by the rich text +object. This can be smaller or wider than the set width. +

It may be wider, for example, if the text contains images or +non-breakable words that are already wider than the available +space. It's smaller when the object only consists of lines that do +not fill the width completely. +