API¶

PyQtLineEditProgressBar

This module subclasses Qt’s QtLineEdit widget to manage a progress bar that is displayed as the background color of the QtLineEdit widget.

REFERENCE¶

The idea for this package came from a discussion on StackOverflow.

GPL LICENSE¶

This file is part of the PyQtLineEditProgressBar package.

PyQtLineEditProgressBar is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PyQtLineEditProgressBar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PyQtLineEditProgressBar in the file named LICENSE. If not, see <https://www.gnu.org/licenses/>.

Class PyQtLineEditProgressBar¶

class pyqtlineeditprogressbar.__init__.PyQtLineEditProgressBar(contents=None, parent=None, read_only=True, progressbar_color='#aaff7f', behavior='starts-empty-fills-left-to-right', text_for_bounding_rect=None)[source]¶

Bases: PyQt5.QtWidgets.QLineEdit

__init__(contents=None, parent=None, read_only=True, progressbar_color='#aaff7f', behavior='starts-empty-fills-left-to-right', text_for_bounding_rect=None)[source]¶

Constructor for the PyQtLineEditProgressBar Class

Parameters

contents (str, optional) – Text displayed in the LineEdit widget (optional, can be set later with setText() method).
parent (widget reference, optional) – The parent widget.
read_only (bool, optional) – Defaults to True which makes the LineEdit widget read only.
progressbar_color (str, optional) –
This must be a string describing a color, such as #1435fe. This field is validated using the colour package. Any color specifier accepted by colour will pass input validation.

If you’re not feeling creative enough to specify your own custom color via the progressbar_color parameter, there are six built-in color constants that can be specified here:

pyqtlineeditprogressbar.DEFAULT_COLOR_GREEN pyqtlineeditprogressbar.DEFAULT_COLOR_RED pyqtlineeditprogressbar.DEFAULT_COLOR_ORANGE pyqtlineeditprogressbar.DEFAULT_COLOR_BLUE pyqtlineeditprogressbar.DEFAULT_COLOR_YELLOW pyqtlineeditprogressbar.DEFAULT_COLOR_PURPLE

If not specified, DEFAULT_COLOR_GREEN, is used.

See the Introduction for a visual of the colors.
behavior (str, optional) –
A rather complicated looking string that identifies one of the four possible behaviors of the progress bar:

pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_RIGHT_TO_LEFT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_RIGHT_TO_LEFT

See the Introduction for a visual of the above four behaviors.
text_for_bounding_rect (str, optional) –
If you have trouble in layout sizing the LineEdit widget’s width, and the contents of this LineEdit widget have a fixed format, then this parameter may be specified to be used by the overridden sizeHint() method to access the Qt Font Metrics sub-system to specify a width width for the font being used. For example:

text_for_bounding_rect=” 888/888 [88] “

If not specified, then the standard Qt sizeHint() is called.

Returns

An initialized PyQtLineEditProgressBar object with all the power of a normal QLineEdit widget plus a progressbar!!

Return type

PyQtLineEditProgressBar object

__module__ = 'pyqtlineeditprogressbar.__init__'¶

getBehavior()[source]¶

Returns the how the ProgressBar is configured to behave.

Parameters

None – Nothing

Returns

A string describing how the ProgressBar is configured to behave. It will be one four string values:

pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_RIGHT_TO_LEFT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_RIGHT_TO_LEFT

Return type

str

getProgressBarColor()[source]¶: Returns the color value associated with the ProgressBar.

getValue()[source]¶

Returns the current value of the ProgressBar, which is between 0.0 and 1.0.

Parameters: None – Nothing
Returns: Current value of the ProgressBar, between 0.0 and 1.0.
Return type: float

removeProgressBar()[source]¶

This method removes the ProgressBar from the LineEdit background.

Parameters: None – Nothing
Returns: Nothing
Return type: None

setProgressBarBehavior(behavior)[source]¶

Configures the behavior of the ProgressBar based on the value of the behavior parameter.

Parameters

behavior (str) –

Must be one of four constant string values that describe the behavior of the ProgressBar:

pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_RIGHT_TO_LEFT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_LEFT_TO_RIGHT pyqtlineeditprogressbar.STARTS_FULL_EMPTIES_RIGHT_TO_LEFT

Returns

Nothing

Return type

None

Note

If the behavior is not one of the four acceptable values, it will be set to the default value of pyqtlineeditprogressbar.STARTS_EMPTY_FILLS_LEFT_TO_RIGHT.

setProgressBarColor(color_text)[source]¶

Iniitalize the color used for the ProgressBar.

Parameters

color_text (str) –

A string describing a color value that is verifiable by the colour package.

Returns

Nothing

Return type

None

Note

If this method detects an invalid color_text parameter has been specified, the color will be set to the default color which is pyqtlineeditprogressbar.DEFAULT_COLOR_GREEN.

sizeHint()[source]¶

This overrides QLineEdit’s sizeHint() method only if the constructor parameter text_for_bounding_rect is specified. In which case the text_for_bounding_rect is used to produce a bounding rectangle that is used to return a QSize item from sizeHint(); otherwise, Qt’s standard sizeHint() method is called.

Parameters: None – Nothing
Returns: The width, height size hint for the PyQtLineEditProgressBar widget.
Return type: QSize object

updateProgress(delta_float)[source]¶

This is the method that needs to be called periodically to update the LineEdit’s progressbar.

Parameters

delta_float (float) –

A float that must be between 0.0 and 1.0. Represents the incremental progress of the progress bar for a single progress bar update cycle.

For example, if the progress bar represents 6 seconds of work and its updated every second, then delta_float = 1/6.

Returns

Nothing

Return type

None