qarbon.qt.gui.led

A LED (light-emitting diode) widget.

This widget represents a led. The led has a color and a status (On/Off).

Here is an example showing how to display all possible combinations of color, status:

from qarbon.external.qt import QtGui
from qarbon.qt.gui.application import Application
from qarbon.qt.gui.led import Led, LedStatus, LedColor

app = Application()
panel = QtGui.QWidget()
layout = QtGui.QGridLayout()
panel.setLayout(layout)
for i, color in enumerate(LedColor):
    led = Led()
    led.ledColor = color
    led.ledStatus = LedStatus.Off
    layout.addWidget(led, i, 0)
    led = Led()
    led.ledColor = color
    led.ledStatus = LedStatus.On
    layout.addWidget(led, i, 1)
panel.show()

app.exec_()

Classes

Led	A LED (light-emitting diode) like widget

class qarbon.qt.gui.led.LedColor

Bases: qarbon.external.enum._enum.Enum

possible led colors

class qarbon.qt.gui.led.LedStatus

Bases: qarbon.external.enum._enum.Enum

possible led status

class qarbon.qt.gui.led.Led(parent=None)

Bases: qarbon.qt.gui.pixmapwidget.PixmapWidget

A LED (light-emitting diode) like widget

DefaultLedPattern = 'qarbon:/led/led_{color}_{status}.png'

constant defining default led image filename pattern

DefaultLedColor = <LedColor.Green: 1>

constant defining default led color (green)

DefaultLedStatus = <LedStatus.On: 1>

constant defining default led status (On)

DefaultLedInverted = False

constant defining default led status invertion (False)

sizeHint()

minimumSizeHint()

Overwrite the default minimum size hint (0,0) to be (8, 8)

Returns:the minimum size hint 8, 8 Return type:QSize

toLedName(status=None, color=None, inverted=None)

Gives the led name for the given status and color. If status or color are not given, the current led status or color are used.

Parameters:

• status (bool) – the status
• color (str) – the color

Returns:

string containing the led name

Return type:

str

isLedColorValid(name)

Determines if the given color name is valid.

Parameters:color (str) – the color Returns:True is the given color name is valid or False otherwise Return type:bool

getLedPatternName()

Returns the current led pattern name :return: led pattern name :rtype: str

setLedPatternName(name)

Sets the led pattern name. Should be a string containing a path to valid images. The string can contain the keywords:

1. {status} - transformed to ‘on’ of ‘off’ according to the status
2. {color} - transformed to the current led color

Example: :leds/images256/led_{color}_{status}.png will be transformed to :leds/images256/led_red_on.png when the led status is True and the led color is red.

Parameters:name (str) – new pattern

resetLedPatternName()

Resets the led pattern to fwk4:/Leds/led_{color}_{status}.png.

getLedStatus()

Returns the led status :return: led status :rtype: bool

setLedStatus(status)

Sets the led status :param status: the new status :type status: bool

resetLedStatus()

Resets the led status

toggleLedStatus()

toggles the current status of the led

getLedInverted()

Returns if the led is inverted. :return: inverted mode :rtype: bool

setLedInverted(inverted)

Sets the led inverted mode :param status: the new inverted mode :type status: bool

resetLedInverted()

Resets the led inverted mode

getLedColor()

Returns the led color :return: led color :rtype: LedColor

setLedColor(color)

Sets the led color :param status: the new color :type status: LedColor

resetLedColor()

Resets the led color

classmethod getQtDesignerPluginInfo()

ledStatus = <PyQt4.QtCore.pyqtProperty object at 0x36ddc50>

This property holds the led status: False means OFF, True means ON

Access functions:

• Led.getLedStatus()
• Led.setLedStatus()
• Led.resetLedStatus()

ledColor = <PyQt4.QtCore.pyqtProperty object at 0x36e3050>

This property holds the led color

Access functions:

• Led.getLedColor()
• Led.setLedColor()
• Led.resetLedColor()

ledInverted = <PyQt4.QtCore.pyqtProperty object at 0x36e3090>

This property holds the led inverted: False means do not invert the

Access functions:

• Led.getLedInverted()
• Led.setLedInverted()
• Led.resetLedInverted()

ledPattern = <PyQt4.QtCore.pyqtProperty object at 0x36e30d0>

This property holds the led pattern name

Access functions:

• Led.getLedPatternName()
• Led.setLedPatternName()
• Led.resetLedPatternName()