class KLed

A round LED widget. More...

Definition#include <kled.h>
InheritsQWidget (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Slots

Protected Methods

Protected Members


Detailed Description

Display a round or rectangular light emmitting diode.

It is configurable to 5 colors, the 2 on/off states and 3 styles (or "looks");

It may display itself in a performant flat view, a round view with light spot or a round view sunken in the screen.

enum State {Off, On, NoOfStates }

Status of the light is on/off. NoOfStates gives the total number of states.

enum Shape {NoShape, Rectangular, Circular, NoOfShapes=Circular }

Shades of the lamp. NoOfShapes gives the total number of shapes.

enum Look {NoLook, Flat, Raised, Sunken, NoOfLooks=Sunken }

Display a flat, round or sunken LED.

Displaying the LED flat is less time and color consuming, but not so nice to see.

The sunken LED itself is (certainly) smaller than the round LED because of the 3 shading circles and is most time consuming. Makes sense for LED > 15x15 pixels.

Timings: ( AMD K5/133, Diamond Stealth 64 PCI Graphics, widgetsize 29x29 )

The widget will be updated on the next repaining event. NoOfLooks gives the total number Looks

 KLed (const QColor &col=Qt::green, QWidget *parent=0, const char *name=0)

Constructor with the ledcolor, the parent widget, and the name.

The State will be defaulted On and the Look round.

Parameters:
ledcolorInitial color of the LED.
parentWill be handed over to QWidget.
nameWill be handed over to QWidget.

 KLed (const QColor& col, KLed::State st, KLed::Look look, KLed::Shape shape, QWidget *parent=0, const char *name=0)

Constructor with the ledcolor, ledstate, ledlook, the parent widget, and the name.

Differs from above only in the parameters, which configure all settings.

Parameters:
ledcolorInitial color of the LED.
stateSets the State.
lookSets the Look.
parentWill be handed over to QWidget.
nameWill be handed over to QWidget.

KLed ()

Destructor

State  state ()

[const]

Hand back the current state of the widget (on/off).

const QColor  color ()

[const]

Hand back the color of the widget

Look  look ()

[const]

Hand back the look of the widget.

int  getDarkFactor ()

[const]

hands back the factor to darken the LED.

void  setState ( State state )

Sets the state of the widget to On or Off.

The widget will be painted immediately.

Parameters:
stateThe LED state: on or off.

See also: on(), off(), toggle(), toggleState()

void  setShape (Shape s)

Set the shape.

void  toggleState ()

Toggle the state of the LED from Off to On and vice versa.

The widget will be repainted when returning to the main event loop.

void  setColor (const QColor& color)

Set the color of the widget. The Color is shown with the KLed::On state. The KLed::Off state is shown with QColor.dark() method

The widget calls the update() method, so it will be updated when entering the main event loop.

Parameters:
colorNew color of the LED.

void  setDarkFactor (int darkfactor)

Set the factor to darken the LED in OFF state. Same as QColor::dark(). "darkfactor should be greater than 100, else the LED gets lighter in OFF state. Defaults to 300.

Parameters:
darkfactorsets the factor to darken the LED.

void  setLook ( Look look )

Set the look of the widget.

The look may be flat, round or sunken. The widget calls the update() method, so it will be updated when entering the main event loop.

Parameters:
lookNew look of the LED.

void  toggle ()

[slot]

Toggle the state of the led from Off to On or vice versa.

The widget repaints itself immediately.

void  on ()

[slot]

Sets the state of the widget to On.

The widget will be painted immediately.

See also: off(), toggle(), toggleState(), setState()

void  off ()

[slot]

Sets the state of the widget to Off.

The widget will be painted immediately.

See also: on(), toggle(), toggleState(), setState()