diff options
Diffstat (limited to 'doc/man/man3/tqlabel.3qt')
| -rw-r--r-- | doc/man/man3/tqlabel.3qt | 106 |
1 files changed, 53 insertions, 53 deletions
diff --git a/doc/man/man3/tqlabel.3qt b/doc/man/man3/tqlabel.3qt index 838034f99..c3e5cc25c 100644 --- a/doc/man/man3/tqlabel.3qt +++ b/doc/man/man3/tqlabel.3qt @@ -1,5 +1,5 @@ '\" t -.TH QLabel 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQLabel 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,25 +7,25 @@ .ad l .nh .SH NAME -QLabel \- Text or image display +TQLabel \- Text or image display .SH SYNOPSIS -\fC#include <ntqlabel.h>\fR +\fC#include <tqlabel.h>\fR .PP Inherits QFrame. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQLabel\fR ( TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.BI "\fBTQLabel\fR ( TQWidget * parent, const char * name = 0, WFlags f = 0 )" .br .ti -1c -.BI "\fBQLabel\fR ( const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.BI "\fBTQLabel\fR ( const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" .br .ti -1c -.BI "\fBQLabel\fR ( TQWidget * buddy, const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.BI "\fBTQLabel\fR ( TQWidget * buddy, const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" .br .ti -1c -.BI "\fB~QLabel\fR ()" +.BI "\fB~TQLabel\fR ()" .br .ti -1c .BI "TQString \fBtext\fR () const" @@ -134,11 +134,11 @@ Inherits QFrame. .br .in -1c .SH DESCRIPTION -The QLabel widget provides a text or image display. +The TQLabel widget provides a text or image display. .PP -QLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of the label can be configured in various ways, and it can be used for specifying a focus accelerator key for another widget. +TQLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of the label can be configured in various ways, and it can be used for specifying a focus accelerator key for another widget. .PP -A QLabel can contain any of the following content types: <center>.nf +A TQLabel can contain any of the following content types: <center>.nf .TS l - l. Content Setting Plain text Pass a TQString to setText(). Rich text Pass a TQString that contains rich text to setText(). A pixmap Pass a TQPixmap to setPixmap(). A movie Pass a TQMovie to setMovie(). A number Pass an \fIint\fR or a \fIdouble\fR to setNum(), which converts the number to plain text. Nothing .TE @@ -147,11 +147,11 @@ l - l. Content Setting Plain text Pass a TQString to setText(). Rich text Pass a .PP When the content is changed using any of these functions, any previous content is cleared. .PP -The look of a QLabel can be tuned in several ways. All the settings of QFrame are available for specifying a widget frame. The positioning of the content within the QLabel widget area can be tuned with setAlignment() and setIndent(). For example, this code sets up a sunken panel with a two-line text in the bottom right corner (both lines being flush with the right side of the label): +The look of a TQLabel can be tuned in several ways. All the settings of QFrame are available for specifying a widget frame. The positioning of the content within the TQLabel widget area can be tuned with setAlignment() and setIndent(). For example, this code sets up a sunken panel with a two-line text in the bottom right corner (both lines being flush with the right side of the label): .PP .nf .br - QLabel *label = new QLabel( this ); + TQLabel *label = new TQLabel( this ); .br label->setFrameStyle( QFrame::Panel | QFrame::Sunken ); .br @@ -161,13 +161,13 @@ The look of a QLabel can be tuned in several ways. All the settings of QFrame ar .br .fi .PP -A QLabel is often used as a label for an interactive widget. For this use QLabel provides a useful mechanism for adding an accelerator key (see QAccel) that will set the keyboard focus to the other widget (called the QLabel's "buddy"). For example: +A TQLabel is often used as a label for an interactive widget. For this use TQLabel provides a useful mechanism for adding an accelerator key (see QAccel) that will set the keyboard focus to the other widget (called the TQLabel's "buddy"). For example: .PP .nf .br QLineEdit* phoneEdit = new QLineEdit( this, "phoneEdit" ); .br - QLabel* phoneLabel = new QLabel( phoneEdit, "&Phone:", this, "phoneLabel" ); + TQLabel* phoneLabel = new TQLabel( phoneEdit, "&Phone:", this, "phoneLabel" ); .br .fi .PP @@ -182,19 +182,19 @@ In this example, keyboard focus is transferred to the label's buddy (the QLineEd .PP See also QLineEdit, TQTextEdit, TQPixmap, TQMovie, GUI Design Handbook: Label, Basic Widgets, and Text Related Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QLabel::QLabel ( TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.SH "TQLabel::TQLabel ( TQWidget * parent, const char * name = 0, WFlags f = 0 )" Constructs an empty label. .PP The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. .PP See also alignment, setFrameStyle(), and indent. -.SH "QLabel::QLabel ( const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.SH "TQLabel::TQLabel ( const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" Constructs a label that displays the text, \fItext\fR. .PP The \fIparent\fR, \fIname\fR and widget flag \fIf\fR, arguments are passed to the QFrame constructor. .PP See also text, alignment, setFrameStyle(), and indent. -.SH "QLabel::QLabel ( TQWidget * buddy, const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" +.SH "TQLabel::TQLabel ( TQWidget * buddy, const TQString & text, TQWidget * parent, const char * name = 0, WFlags f = 0 )" Constructs a label that displays the text \fItext\fR. The label has a buddy widget, \fIbuddy\fR. .PP If the \fItext\fR contains an underlined letter (a letter preceded by an ampersand, &), and the text is in plain text format, when the user presses Alt+ the underlined letter, focus is passed to the buddy widget. @@ -202,11 +202,11 @@ If the \fItext\fR contains an underlined letter (a letter preceded by an ampersa The \fIparent\fR, \fIname\fR and widget flag, \fIf\fR, arguments are passed to the QFrame constructor. .PP See also text, setBuddy(), alignment, setFrameStyle(), and indent. -.SH "QLabel::~QLabel ()" +.SH "TQLabel::~TQLabel ()" Destroys the label. -.SH "int QLabel::alignment () const" +.SH "int TQLabel::alignment () const" Returns the alignment of the label's contents. See the "alignment" property for details. -.SH "bool QLabel::autoResize () const" +.SH "bool TQLabel::autoResize () const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Returns TRUE if auto-resizing is enabled, or FALSE if auto-resizing is disabled. @@ -214,46 +214,46 @@ Returns TRUE if auto-resizing is enabled, or FALSE if auto-resizing is disabled. Auto-resizing is disabled by default. .PP See also setAutoResize(). -.SH "TQWidget * QLabel::buddy () const" +.SH "TQWidget * TQLabel::buddy () const" Returns this label's buddy, or 0 if no buddy is currently set. .PP See also setBuddy(). -.SH "void QLabel::clear ()\fC [slot]\fR" +.SH "void TQLabel::clear ()\fC [slot]\fR" Clears any label contents. Equivalent to setText( "" ). -.SH "void QLabel::drawContents ( TQPainter * p )\fC [virtual protected]\fR" +.SH "void TQLabel::drawContents ( TQPainter * p )\fC [virtual protected]\fR" Draws the label contents using the painter \fIp\fR. .PP Reimplemented from QFrame. -.SH "bool QLabel::hasScaledContents () const" +.SH "bool TQLabel::hasScaledContents () const" Returns TRUE if the label will scale its contents to fill all available space; otherwise returns FALSE. See the "scaledContents" property for details. -.SH "int QLabel::indent () const" +.SH "int TQLabel::indent () const" Returns the label's text indent in pixels. See the "indent" property for details. -.SH "TQMovie * QLabel::movie () const" +.SH "TQMovie * TQLabel::movie () const" Returns a pointer to the label's movie, or 0 if no movie has been set. .PP See also setMovie(). -.SH "TQPicture * QLabel::picture () const" +.SH "TQPicture * TQLabel::picture () const" Returns the label's picture or 0 if the label doesn't have a picture. -.SH "TQPixmap * QLabel::pixmap () const" +.SH "TQPixmap * TQLabel::pixmap () const" Returns the label's pixmap. See the "pixmap" property for details. -.SH "void QLabel::setAlignment ( int )\fC [virtual]\fR" +.SH "void TQLabel::setAlignment ( int )\fC [virtual]\fR" Sets the alignment of the label's contents. See the "alignment" property for details. -.SH "void QLabel::setAutoResize ( bool enable )\fC [virtual]\fR" +.SH "void TQLabel::setAutoResize ( bool enable )\fC [virtual]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Enables auto-resizing if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. .PP -When auto-resizing is enabled the label will resize itself to fit the contents whenever the contents change. The top-left corner is not moved. This is useful for QLabel widgets that are not managed by a QLayout (e.g., top-level widgets). +When auto-resizing is enabled the label will resize itself to fit the contents whenever the contents change. The top-left corner is not moved. This is useful for TQLabel widgets that are not managed by a QLayout (e.g., top-level widgets). .PP Auto-resizing is disabled by default. .PP See also autoResize(), adjustSize(), and sizeHint. -.SH "void QLabel::setBuddy ( TQWidget * buddy )\fC [virtual]\fR" +.SH "void TQLabel::setBuddy ( TQWidget * buddy )\fC [virtual]\fR" Sets this label's buddy to \fIbuddy\fR. .PP When the user presses the accelerator key indicated by this label, the keyboard focus is transferred to the label's buddy widget. .PP -The buddy mechanism is only available for QLabels that contain plain text in which one letter is prefixed with an ampersand, &. This letter is set as the accelerator key. The letter is displayed underlined, and the '&' is not displayed (i.e. the ShowPrefix alignment flag is turned on; see setAlignment()). +The buddy mechanism is only available for TQLabels that contain plain text in which one letter is prefixed with an ampersand, &. This letter is set as the accelerator key. The letter is displayed underlined, and the '&' is not displayed (i.e. the ShowPrefix alignment flag is turned on; see setAlignment()). .PP In a dialog, you might create two data entry widgets and a label for each, and set up the geometry layout so each label is just to the left of its data entry widget (its "buddy"), for example: .PP @@ -261,13 +261,13 @@ In a dialog, you might create two data entry widgets and a label for each, and s .br QLineEdit *nameEd = new QLineEdit( this ); .br - QLabel *nameLb = new QLabel( "&Name:", this ); + TQLabel *nameLb = new TQLabel( "&Name:", this ); .br nameLb->setBuddy( nameEd ); .br QLineEdit *phoneEd = new QLineEdit( this ); .br - QLabel *phoneLb = new QLabel( "&Phone:", this ); + TQLabel *phoneLb = new TQLabel( "&Phone:", this ); .br phoneLb->setBuddy( phoneEd ); .br @@ -283,15 +283,15 @@ See also buddy(), text, QAccel, and alignment. .PP Examples: .)l addressbook/centralwidget.cpp, chart/optionsform.cpp, and regexptester/regexptester.cpp. -.SH "void QLabel::setFont ( const TQFont & f )\fC [virtual]\fR" -Sets the font used on the QLabel to font \fIf\fR. +.SH "void TQLabel::setFont ( const TQFont & f )\fC [virtual]\fR" +Sets the font used on the TQLabel to font \fIf\fR. .PP Example: menu/menu.cpp. .PP Reimplemented from TQWidget. -.SH "void QLabel::setIndent ( int )" +.SH "void TQLabel::setIndent ( int )" Sets the label's text indent in pixels. See the "indent" property for details. -.SH "void QLabel::setMovie ( const TQMovie & movie )\fC [virtual slot]\fR" +.SH "void TQLabel::setMovie ( const TQMovie & movie )\fC [virtual slot]\fR" Sets the label contents to \fImovie\fR. Any previous content is cleared. .PP The buddy accelerator, if any, is disabled. @@ -299,7 +299,7 @@ The buddy accelerator, if any, is disabled. The label resizes itself if auto-resizing is enabled. .PP See also movie() and setBuddy(). -.SH "void QLabel::setNum ( int num )\fC [virtual slot]\fR" +.SH "void TQLabel::setNum ( int num )\fC [virtual slot]\fR" Sets the label contents to plain text containing the textual representation of integer \fInum\fR. Any previous content is cleared. Does nothing if the integer's string representation is the same as the current contents of the label. .PP The buddy accelerator, if any, is disabled. @@ -307,7 +307,7 @@ The buddy accelerator, if any, is disabled. The label resizes itself if auto-resizing is enabled. .PP See also text, TQString::setNum(), and setBuddy(). -.SH "void QLabel::setNum ( double num )\fC [virtual slot]\fR" +.SH "void TQLabel::setNum ( double num )\fC [virtual slot]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Sets the label contents to plain text containing the textual representation of double \fInum\fR. Any previous content is cleared. Does nothing if the double's string representation is the same as the current contents of the label. @@ -317,29 +317,29 @@ The buddy accelerator, if any, is disabled. The label resizes itself if auto-resizing is enabled. .PP See also text, TQString::setNum(), and setBuddy(). -.SH "void QLabel::setPicture ( const TQPicture & picture )\fC [virtual slot]\fR" +.SH "void TQLabel::setPicture ( const TQPicture & picture )\fC [virtual slot]\fR" Sets the label contents to \fIpicture\fR. Any previous content is cleared. .PP The buddy accelerator, if any, is disabled. .PP See also picture() and setBuddy(). -.SH "void QLabel::setPixmap ( const TQPixmap & )\fC [virtual slot]\fR" +.SH "void TQLabel::setPixmap ( const TQPixmap & )\fC [virtual slot]\fR" Sets the label's pixmap. See the "pixmap" property for details. -.SH "void QLabel::setScaledContents ( bool )" +.SH "void TQLabel::setScaledContents ( bool )" Sets whether the label will scale its contents to fill all available space. See the "scaledContents" property for details. -.SH "void QLabel::setText ( const TQString & )\fC [virtual slot]\fR" +.SH "void TQLabel::setText ( const TQString & )\fC [virtual slot]\fR" Sets the label's text. See the "text" property for details. -.SH "void QLabel::setTextFormat ( TextFormat )" +.SH "void TQLabel::setTextFormat ( TextFormat )" Sets the label's text format. See the "textFormat" property for details. -.SH "TQString QLabel::text () const" +.SH "TQString TQLabel::text () const" Returns the label's text. See the "text" property for details. -.SH "TextFormat QLabel::textFormat () const" +.SH "TextFormat TQLabel::textFormat () const" Returns the label's text format. See the "textFormat" property for details. .SS "Property Documentation" .SH "Alignment alignment" This property holds the alignment of the label's contents. .PP -The alignment is a bitwise OR of TQt::AlignmentFlags and TQt::TextFlags values. The ExpandTabs, SingleLine and ShowPrefix flags apply only if the label contains plain text; otherwise they are ignored. The DontClip flag is always ignored. WordBreak applies to both rich text and plain text labels. The BreakAnywhere flag is not supported in QLabel. +The alignment is a bitwise OR of TQt::AlignmentFlags and TQt::TextFlags values. The ExpandTabs, SingleLine and ShowPrefix flags apply only if the label contains plain text; otherwise they are ignored. The DontClip flag is always ignored. WordBreak applies to both rich text and plain text labels. The BreakAnywhere flag is not supported in TQLabel. .PP If the label has a buddy, the ShowPrefix flag is forced to TRUE. .PP @@ -369,7 +369,7 @@ This property holds the label's pixmap. .PP If no pixmap has been set this will return an invalid pixmap. .PP -Setting the pixmap clears any previous content, and resizes the label if QLabel::autoResize() is TRUE. The buddy accelerator, if any, is disabled. +Setting the pixmap clears any previous content, and resizes the label if TQLabel::autoResize() is TRUE. The buddy accelerator, if any, is disabled. .PP Set this property's value with setPixmap() and get this property's value with pixmap(). .SH "bool scaledContents" @@ -387,13 +387,13 @@ This property holds the label's text. .PP If no text has been set this will return an empty string. Setting the text clears any previous content, unless they are the same. .PP -The text will be interpreted either as a plain text or as a rich text, depending on the text format setting; see setTextFormat(). The default setting is AutoText, i.e. QLabel will try to auto-detect the format of the text set. +The text will be interpreted either as a plain text or as a rich text, depending on the text format setting; see setTextFormat(). The default setting is AutoText, i.e. TQLabel will try to auto-detect the format of the text set. .PP If the text is interpreted as a plain text and a buddy has been set, the buddy accelerator key is updated from the new text. .PP The label resizes itself if auto-resizing is enabled. .PP -Note that Qlabel is well-suited to display small rich text documents, i.e. those small documents that get their document specific settings (font, text color, link color) from the label's palette and font properties. For large documents, use TQTextEdit in read-only mode instead. TQTextEdit will flicker less on resize and can also provide a scrollbar when necessary. +Note that TQLabel is well-suited to display small rich text documents, i.e. those small documents that get their document specific settings (font, text color, link color) from the label's palette and font properties. For large documents, use TQTextEdit in read-only mode instead. TQTextEdit will flicker less on resize and can also provide a scrollbar when necessary. .PP See also textFormat, setBuddy(), and alignment. .PP @@ -410,7 +410,7 @@ See also text. Set this property's value with setTextFormat() and get this property's value with textFormat(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqlabel.html +.BR http://doc.trolltech.com/tqlabel.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |