diff options
Diffstat (limited to 'doc/man/man3/tqprogressdialog.3qt')
| -rw-r--r-- | doc/man/man3/tqprogressdialog.3qt | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/doc/man/man3/tqprogressdialog.3qt b/doc/man/man3/tqprogressdialog.3qt index 5d261d81..5b5aace7 100644 --- a/doc/man/man3/tqprogressdialog.3qt +++ b/doc/man/man3/tqprogressdialog.3qt @@ -1,5 +1,5 @@ '\" t -.TH QProgressDialog 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQProgressDialog 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,22 +7,22 @@ .ad l .nh .SH NAME -QProgressDialog \- Feedback on the progress of a slow operation +TQProgressDialog \- Feedback on the progress of a slow operation .SH SYNOPSIS -\fC#include <ntqprogressdialog.h>\fR +\fC#include <tqprogressdialog.h>\fR .PP Inherits TQDialog. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQProgressDialog\fR ( TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.BI "\fBTQProgressDialog\fR ( TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" .br .ti -1c -.BI "\fBQProgressDialog\fR ( const TQString & labelText, const TQString & cancelButtonText, int totalSteps, TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.BI "\fBTQProgressDialog\fR ( const TQString & labelText, const TQString & cancelButtonText, int totalSteps, TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" .br .ti -1c -.BI "\fB~QProgressDialog\fR ()" +.BI "\fB~TQProgressDialog\fR ()" .br .ti -1c .BI "void \fBsetLabel\fR ( TQLabel * label )" @@ -31,7 +31,7 @@ Inherits TQDialog. .BI "void \fBsetCancelButton\fR ( TQPushButton * cancelButton )" .br .ti -1c -.BI "void \fBsetBar\fR ( QProgressBar * bar )" +.BI "void \fBsetBar\fR ( TQProgressBar * bar )" .br .ti -1c .BI "bool wasCancelled () const \fI(obsolete)\fR" @@ -137,23 +137,23 @@ Inherits TQDialog. .br .in -1c .SH DESCRIPTION -The QProgressDialog class provides feedback on the progress of a slow operation. +The TQProgressDialog class provides feedback on the progress of a slow operation. .PP A progress dialog is used to give the user an indication of how long an operation is going to take, and to demonstrate that the application has not frozen. It can also give the user an opportunity to abort the operation. .PP -A common problem with progress dialogs is that it is difficult to know when to use them; operations take different amounts of time on different hardware. QProgressDialog offers a solution to this problem: it estimates the time the operation will take (based on time for steps), and only shows itself if that estimate is beyond minimumDuration() (4 seconds by default). +A common problem with progress dialogs is that it is difficult to know when to use them; operations take different amounts of time on different hardware. TQProgressDialog offers a solution to this problem: it estimates the time the operation will take (based on time for steps), and only shows itself if that estimate is beyond minimumDuration() (4 seconds by default). .PP Use setTotalSteps() (or the constructor) to set the number of" steps" in the operation and call setProgress() as the operation progresses. The step value can be chosen arbitrarily. It can be the number of files copied, the number of bytes received, the number of iterations through the main loop of your algorithm, or some other suitable unit. Progress starts at 0, and the progress dialog shows that the operation has finished when you call setProgress() with totalSteps() as its argument. .PP The dialog automatically resets and hides itself at the end of the operation. Use setAutoReset() and setAutoClose() to change this behavior. .PP -There are two ways of using QProgressDialog: modal and modeless. +There are two ways of using TQProgressDialog: modal and modeless. .PP -Using a modal QProgressDialog is simpler for the programmer, but you must call QApplication::processEvents() or TQEventLoop::processEvents(ExcludeUserInput) to keep the event loop running to ensure that the application doesn't freeze. Do the operation in a loop, call setProgress() at intervals, and check for cancellation with wasCanceled(). For example: +Using a modal TQProgressDialog is simpler for the programmer, but you must call QApplication::processEvents() or TQEventLoop::processEvents(ExcludeUserInput) to keep the event loop running to ensure that the application doesn't freeze. Do the operation in a loop, call setProgress() at intervals, and check for cancellation with wasCanceled(). For example: .PP .nf .br -QProgressDialog progress( "Copying files...", "Abort Copy", numFiles, +TQProgressDialog progress( "Copying files...", "Abort Copy", numFiles, .br this, "progress", TRUE ); .br @@ -175,7 +175,7 @@ for ( int i = 0; i < numFiles; i++ ) { progress.setProgress( numFiles ); .fi .PP -A modeless progress dialog is suitable for operations that take place in the background, where the user is able to interact with the application. Such operations are typically based on TQTimer (or TQObject::timerEvent()), TQSocketNotifier, or TQUrlOperator; or performed in a separate thread. A QProgressBar in the status bar of your main window is often an alternative to a modeless progress dialog. +A modeless progress dialog is suitable for operations that take place in the background, where the user is able to interact with the application. Such operations are typically based on TQTimer (or TQObject::timerEvent()), TQSocketNotifier, or TQUrlOperator; or performed in a separate thread. A TQProgressBar in the status bar of your main window is often an alternative to a modeless progress dialog. .PP You need to have an event loop to be running, connect the canceled() signal to a slot that stops the operation, and call setProgress() at intervals. For example: .PP @@ -187,7 +187,7 @@ Operation::Operation( TQObject *parent = 0 ) .br { .br - pd = new QProgressDialog( "Operation in progress.", "Cancel", 100 ); + pd = new TQProgressDialog( "Operation in progress.", "Cancel", 100 ); .br connect( pd, TQ_SIGNAL(canceled()), this, TQ_SLOT(cancel()) ); .br @@ -237,9 +237,9 @@ In both modes the progress dialog may be customized by replacing the child widge .ce 1 .B "[Image Omitted]" .PP -See also TQDialog, QProgressBar, GUI Design Handbook: Progress Indicator, and Dialog Classes. +See also TQDialog, TQProgressBar, GUI Design Handbook: Progress Indicator, and Dialog Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QProgressDialog::QProgressDialog ( TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.SH "TQProgressDialog::TQProgressDialog ( TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" Constructs a progress dialog. .PP Default settings: @@ -253,7 +253,7 @@ The total number of steps is 100. The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and the widget flags, \fIf\fR, are passed to the TQDialog::TQDialog() constructor. If \fImodal\fR is FALSE (the default), you must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. .PP See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. -.SH "QProgressDialog::QProgressDialog ( const TQString & labelText, const TQString & cancelButtonText, int totalSteps, TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" +.SH "TQProgressDialog::TQProgressDialog ( const TQString & labelText, const TQString & cancelButtonText, int totalSteps, TQWidget * creator = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )" Constructs a progress dialog. .PP The \fIlabelText\fR is text used to remind the user what is progressing. @@ -265,82 +265,82 @@ The \fItotalSteps\fR is the total number of steps in the operation for which thi The \fIcreator\fR argument is the widget to use as the dialog's parent. The \fIname\fR, \fImodal\fR, and widget flags, \fIf\fR, are passed to the TQDialog::TQDialog() constructor. If \fImodal\fR is FALSE (the default), you will must have an event loop proceeding for any redrawing of the dialog to occur. If \fImodal\fR is TRUE, the dialog ensures that events are processed when needed. .PP See also labelText, setLabel(), setCancelButtonText(), setCancelButton(), and totalSteps. -.SH "QProgressDialog::~QProgressDialog ()" +.SH "TQProgressDialog::~TQProgressDialog ()" Destroys the progress dialog. -.SH "bool QProgressDialog::autoClose () const" +.SH "bool TQProgressDialog::autoClose () const" Returns TRUE if the dialog gets hidden by reset(); otherwise returns FALSE. See the "autoClose" property for details. -.SH "bool QProgressDialog::autoReset () const" +.SH "bool TQProgressDialog::autoReset () const" Returns TRUE if the progress dialog calls reset() as soon as progress() equals totalSteps(); otherwise returns FALSE. See the "autoReset" property for details. -.SH "void QProgressDialog::cancel ()\fC [slot]\fR" +.SH "void TQProgressDialog::cancel ()\fC [slot]\fR" Resets the progress dialog. wasCanceled() becomes TRUE until the progress dialog is reset. The progress dialog becomes hidden. -.SH "void QProgressDialog::canceled ()\fC [signal]\fR" +.SH "void TQProgressDialog::canceled ()\fC [signal]\fR" This signal is emitted when the cancel button is clicked. It is connected to the cancel() slot by default. .PP See also wasCanceled. -.SH "void QProgressDialog::cancelled ()\fC [signal]\fR" +.SH "void TQProgressDialog::cancelled ()\fC [signal]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Use canceled() instead. .PP Examples: .)l network/ftpclient/ftpmainwindow.ui.h and progress/progress.cpp. -.SH "void QProgressDialog::forceShow ()\fC [protected slot]\fR" +.SH "void TQProgressDialog::forceShow ()\fC [protected slot]\fR" Shows the dialog if it is still hidden after the algorithm has been started and minimumDuration milliseconds have passed. .PP See also minimumDuration. -.SH "TQString QProgressDialog::labelText () const" +.SH "TQString TQProgressDialog::labelText () const" Returns the label's text. See the "labelText" property for details. -.SH "int QProgressDialog::minimumDuration () const" +.SH "int TQProgressDialog::minimumDuration () const" Returns the time that must pass before the dialog appears. See the "minimumDuration" property for details. -.SH "int QProgressDialog::progress () const" +.SH "int TQProgressDialog::progress () const" Returns the current amount of progress made. See the "progress" property for details. -.SH "void QProgressDialog::reset ()\fC [slot]\fR" +.SH "void TQProgressDialog::reset ()\fC [slot]\fR" Resets the progress dialog. The progress dialog becomes hidden if autoClose() is TRUE. .PP See also autoClose and autoReset. .PP Example: network/ftpclient/ftpmainwindow.ui.h. -.SH "void QProgressDialog::setAutoClose ( bool b )" +.SH "void TQProgressDialog::setAutoClose ( bool b )" Sets whether the dialog gets hidden by reset() to \fIb\fR. See the "autoClose" property for details. -.SH "void QProgressDialog::setAutoReset ( bool b )" +.SH "void TQProgressDialog::setAutoReset ( bool b )" Sets whether the progress dialog calls reset() as soon as progress() equals totalSteps() to \fIb\fR. See the "autoReset" property for details. -.SH "void QProgressDialog::setBar ( QProgressBar * bar )" +.SH "void TQProgressDialog::setBar ( TQProgressBar * bar )" Sets the progress bar widget to \fIbar\fR. The progress dialog resizes to fit. The progress dialog takes ownership of the progress \fIbar\fR which will be deleted when necessary, so do not use a progress bar allocated on the stack. -.SH "void QProgressDialog::setCancelButton ( TQPushButton * cancelButton )" +.SH "void TQProgressDialog::setCancelButton ( TQPushButton * cancelButton )" Sets the cancel button to the push button, \fIcancelButton\fR. The progress dialog takes ownership of this button which will be deleted when necessary, so do not pass the address of an object that is on the stack, i.e. use new() to create the button. .PP See also setCancelButtonText(). -.SH "void QProgressDialog::setCancelButtonText ( const TQString & cancelButtonText )\fC [slot]\fR" +.SH "void TQProgressDialog::setCancelButtonText ( const TQString & cancelButtonText )\fC [slot]\fR" Sets the cancel button's text to \fIcancelButtonText\fR. .PP See also setCancelButton(). -.SH "void QProgressDialog::setLabel ( TQLabel * label )" +.SH "void TQProgressDialog::setLabel ( TQLabel * label )" Sets the label to \fIlabel\fR. The progress dialog resizes to fit. The label becomes owned by the progress dialog and will be deleted when necessary, so do not pass the address of an object on the stack. .PP See also labelText. .PP Example: progress/progress.cpp. -.SH "void QProgressDialog::setLabelText ( const TQString & )\fC [slot]\fR" +.SH "void TQProgressDialog::setLabelText ( const TQString & )\fC [slot]\fR" Sets the label's text. See the "labelText" property for details. -.SH "void QProgressDialog::setMinimumDuration ( int ms )\fC [slot]\fR" +.SH "void TQProgressDialog::setMinimumDuration ( int ms )\fC [slot]\fR" Sets the time that must pass before the dialog appears to \fIms\fR. See the "minimumDuration" property for details. -.SH "void QProgressDialog::setProgress ( int progress )\fC [slot]\fR" +.SH "void TQProgressDialog::setProgress ( int progress )\fC [slot]\fR" Sets the current amount of progress made to \fIprogress\fR. See the "progress" property for details. -.SH "void QProgressDialog::setProgress ( int progress, int totalSteps )\fC [slot]\fR" +.SH "void TQProgressDialog::setProgress ( int progress, int totalSteps )\fC [slot]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Sets the current amount of progress to \fIprogress\fR and the total number of steps to \fItotalSteps\fR. .PP See also totalSteps. -.SH "void QProgressDialog::setTotalSteps ( int totalSteps )\fC [slot]\fR" +.SH "void TQProgressDialog::setTotalSteps ( int totalSteps )\fC [slot]\fR" Sets the total number of steps to \fItotalSteps\fR. See the "totalSteps" property for details. -.SH "TQSize QProgressDialog::sizeHint () const\fC [virtual]\fR" +.SH "TQSize TQProgressDialog::sizeHint () const\fC [virtual]\fR" Returns a size that fits the contents of the progress dialog. The progress dialog resizes itself as required, so you should not need to call this yourself. -.SH "int QProgressDialog::totalSteps () const" +.SH "int TQProgressDialog::totalSteps () const" Returns the total number of steps. See the "totalSteps" property for details. -.SH "bool QProgressDialog::wasCanceled () const" +.SH "bool TQProgressDialog::wasCanceled () const" Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCanceled" property for details. -.SH "bool QProgressDialog::wasCancelled () const" +.SH "bool TQProgressDialog::wasCancelled () const" Returns TRUE if the dialog was canceled; otherwise returns FALSE. See the "wasCancelled" property for details. .SS "Property Documentation" .SH "bool autoClose" @@ -376,9 +376,9 @@ Set this property's value with setMinimumDuration() and get this property's valu .SH "int progress" This property holds the current amount of progress made. .PP -For the progress dialog to work as expected, you should initially set this property to 0 and finally set it to QProgressDialog::totalSteps(); you can call setProgress() any number of times in-between. +For the progress dialog to work as expected, you should initially set this property to 0 and finally set it to TQProgressDialog::totalSteps(); you can call setProgress() any number of times in-between. .PP -\fBWarning:\fR If the progress dialog is modal (see QProgressDialog::QProgressDialog()), this function calls QApplication::processEvents(), so take care that this does not cause undesirable re-entrancy in your code. For example, don't use a QProgressDialog inside a paintEvent()! +\fBWarning:\fR If the progress dialog is modal (see TQProgressDialog::TQProgressDialog()), this function calls QApplication::processEvents(), so take care that this does not cause undesirable re-entrancy in your code. For example, don't use a TQProgressDialog inside a paintEvent()! .PP See also totalSteps. .PP @@ -405,7 +405,7 @@ Use wasCanceled instead. Get this property's value with wasCancelled(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqprogressdialog.html +.BR http://doc.trolltech.com/tqprogressdialog.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |