LedColor

Since: BlackBerry 10.0.0

#include <bb/device/LedColor>

To link against this class, add the following line to your .pro file: LIBS += -lbbdevice

The LedColor class provides a wrapper for the LedColor::Type enumeration.


Overview

Public Types Index

enum Type

None = 0x000000, Red = 0xff0000, Green = 0x00ff00, Blue = 0x0000ff, Yellow = Red | Green, Cyan = Green | Blue, Magenta = Blue | Red, White = Red | Green | Blue

Static Public Functions Index

bb::device::LedColor::TypefromBitset (bool red, bool green, bool blue)
QStringtoName (bb::device::LedColor::Type color)

Public Types

Type

The LedColor class provides a wrapper for the LedColor::Type enumeration.

Since:

BlackBerry 10.0.0

None = 0x000000

If this color is specified, the LED will not blink.

Red = 0xff0000

LED will blink red.

Since:

BlackBerry 10.0.0

Green = 0x00ff00

LED will blink green.

Since:

BlackBerry 10.0.0

Blue = 0x0000ff

LED will blink blue.

Since:

BlackBerry 10.0.0

Yellow = Red | Green

LED will blink yellow.

Since:

BlackBerry 10.0.0

Cyan = Green | Blue

LED will blink cyan.

Since:

BlackBerry 10.0.0

Magenta = Blue | Red

LED will blink magenta.

Since:

BlackBerry 10.0.0

White = Red | Green | Blue

LED will blink white.

Since:

BlackBerry 10.0.0

Static Public Functions

bb::device::LedColor::Type fromBitset (
  • boolred,
  • boolgreen,
  • boolblue )

Returns the color corresponding to the use of the colors provided.

Parameters
red

Whether the result should contain red.

green

Whether the result should contain green.

blue

Whether the result should contain blue.

Return:

Returns the color corresponding to the mix of colors provided, or LedColor::None if no colors are used.

Since:

BlackBerry 10.0.0

QString toName (

Returns a string corresponding to the color provided.

Parameters
color

The color to translate.

Return:

Returns the name of the color as listed in LedColor::Type, or the null QString for LedColor::None.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-29



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus