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/ntqprogressbar.html | 224 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 doc/html/ntqprogressbar.html (limited to 'doc/html/ntqprogressbar.html') diff --git a/doc/html/ntqprogressbar.html b/doc/html/ntqprogressbar.html new file mode 100644 index 000000000..b6617acba --- /dev/null +++ b/doc/html/ntqprogressbar.html @@ -0,0 +1,224 @@ + + + + + +TQProgressBar Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQProgressBar Class Reference

+ +

The TQProgressBar widget provides a horizontal progress bar. +More... +

#include <ntqprogressbar.h> +

Inherits TQFrame. +

List of all member functions. +

Public Members

+ +

Public Slots

+ +

Properties

+ +

Protected Members

+ +

Detailed Description

+ + +The TQProgressBar widget provides a horizontal progress bar. +

+ +

A progress bar is used to give the user an indication of the +progress of an operation and to reassure them that the application +is still running. +

The progress bar uses the concept of steps; you give it the +total number of steps and the number of steps completed so far and +it will display the percentage of steps that have been completed. +You can specify the total number of steps in the constructor or +later with setTotalSteps(). The current number of steps is set +with setProgress(). The progress bar can be rewound to the +beginning with reset(). +

If the total is given as 0 the progress bar shows a busy indicator +instead of a percentage of steps. This is useful, for example, +when using TQFtp or TQHttp to download items when they are unable to +determine the size of the item being downloaded. +

See also TQProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. + +

+

See also TQProgressDialog, GUI Design Handbook: Progress Indicator, and Advanced Widgets. + +

Member Function Documentation

+

TQProgressBar::TQProgressBar ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 ) +

+Constructs a progress bar. +

The total number of steps is set to 100 by default. +

The parent, name and widget flags, f, are passed on to +the TQFrame::TQFrame() constructor. +

See also totalSteps. + +

TQProgressBar::TQProgressBar ( int totalSteps, TQWidget * parent = 0, const char * name = 0, WFlags f = 0 ) +

+Constructs a progress bar. +

The totalSteps is the total number of steps that need to be +completed for the operation which this progress bar represents. +For example, if the operation is to examine 50 files, this value +would be 50. Before examining the first file, call setProgress(0); +call setProgress(50) after examining the last file. +

The parent, name and widget flags, f, are passed to the +TQFrame::TQFrame() constructor. +

See also totalSteps and progress. + +

bool TQProgressBar::centerIndicator () const +

Returns TRUE if the indicator string should be centered; otherwise returns FALSE. +See the "centerIndicator" property for details. +

bool TQProgressBar::indicatorFollowsStyle () const +

Returns TRUE if the display of the indicator string should follow the GUI style; otherwise returns FALSE. +See the "indicatorFollowsStyle" property for details. +

bool TQProgressBar::percentageVisible () const +

Returns TRUE if the current progress value is displayed; otherwise returns FALSE. +See the "percentageVisible" property for details. +

int TQProgressBar::progress () const +

Returns the current amount of progress. +See the "progress" property for details. +

const TQString & TQProgressBar::progressString () const +

Returns the amount of progress as a string. +See the "progressString" property for details. +

void TQProgressBar::reset () [slot] +

+Reset the progress bar. The progress bar "rewinds" and shows no +progress. + +

Examples: fileiconview/mainwindow.cpp and progressbar/progressbar.cpp. +

void TQProgressBar::setCenterIndicator ( bool on ) +

Sets whether the indicator string should be centered to on. +See the "centerIndicator" property for details. +

bool TQProgressBar::setIndicator ( TQString & indicator, int progress, int totalSteps ) [virtual protected] +

+This method is called to generate the text displayed in the center +(or in some styles, to the left) of the progress bar. +

The progress may be negative, indicating that the progress bar +is in the "reset" state before any progress is set. +

The default implementation is the percentage of completion or +blank in the reset state. The percentage is calculated based on +the progress and totalSteps. You can set the indicator +text if you wish. +

To allow efficient repainting of the progress bar, this method +should return FALSE if the string is unchanged from the last call +to this function. + +

void TQProgressBar::setIndicatorFollowsStyle ( bool ) +

Sets whether the display of the indicator string should follow the GUI style. +See the "indicatorFollowsStyle" property for details. +

void TQProgressBar::setPercentageVisible ( bool ) +

Sets whether the current progress value is displayed. +See the "percentageVisible" property for details. +

void TQProgressBar::setProgress ( int progress ) [virtual slot] +

Sets the current amount of progress to progress. +See the "progress" property for details. +

void TQProgressBar::setProgress ( int progress, int totalSteps ) [slot] +

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

Sets the amount of progress to progress and the total number of +steps to totalSteps. +

See also totalSteps. + +

void TQProgressBar::setTotalSteps ( int totalSteps ) [virtual slot] +

Sets the total number of steps to totalSteps. +See the "totalSteps" property for details. +

int TQProgressBar::totalSteps () const +

Returns the total number of steps. +See the "totalSteps" property for details. +

Property Documentation

+

bool centerIndicator

+

This property holds whether the indicator string should be centered. +

Changing this property sets TQProgressBar::indicatorFollowsStyle +to FALSE. The default is TRUE. + +

Set this property's value with setCenterIndicator() and get this property's value with centerIndicator(). +

bool indicatorFollowsStyle

+

This property holds whether the display of the indicator string should follow the GUI style. +

The default is TRUE. +

See also centerIndicator. + +

Set this property's value with setIndicatorFollowsStyle() and get this property's value with indicatorFollowsStyle(). +

bool percentageVisible

+

This property holds whether the current progress value is displayed. +

The default is TRUE. +

See also centerIndicator and indicatorFollowsStyle. + +

Set this property's value with setPercentageVisible() and get this property's value with percentageVisible(). +

int progress

+

This property holds the current amount of progress. +

This property is -1 if progress counting has not started. + +

Set this property's value with setProgress() and get this property's value with progress(). +

TQString progressString

+

This property holds the amount of progress as a string. +

This property is TQString::null if progress counting has not started. + +

Get this property's value with progressString(). +

int totalSteps

+

This property holds the total number of steps. +

If totalSteps is 0, the progress bar will display a busy +indicator. +

See also +

Set this property's value with setTotalSteps() and get this property's value with totalSteps(). + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.3