SystemUiButton

Since: BlackBerry 10.0.0

#include <bb/system/SystemUiButton>

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

The invokable buttons that are available for dialogs and toasts.

The presentation of the button is dependent on the class using it. For instance, some classes may choose to always show the button as enabled, or to not show buttons with null or empty labels.

Overview

Properties Index

bool	enabled
QString	label

Public Functions Index

	SystemUiButton (QObject *parent=0)
	SystemUiButton (const QString &label, QObject *parent=0)
virtual	~SystemUiButton ()
bool	enabled () const
QString	label () const
Q_INVOKABLE void	resetEnabled ()
Q_INVOKABLE void	resetLabel ()
void	setEnabled (bool value)
void	setLabel (const QString &text)

Signals Index

void	enabledChanged (bool value)
void	labelChanged (const QString &value)

Properties

bool enabled

Indicates whether the button is enabled and can be clicked.

Since:

BlackBerry 10.0.0

QString label

Represents the text of the button.

Since:

BlackBerry 10.0.0

Public Functions

SystemUiButton (
QObject *parent)

Constructs an instance of a button.

The enabled property will be set to true and the label property will be set to QString::null.

Parameters
parent	If not 0, the supplied parent will be responsible for deleting this instance.

Since:

BlackBerry 10.0.0

SystemUiButton (
const QString &label,
QObject *parent )

Constructs an instance of a button with the label provided.

The enabled property will be set to true.

Parameters
label	The label for the button.
parent	If not 0, the supplied parent will be responsible for deleting this instance.

Since:

BlackBerry 10.0.0

virtual~SystemUiButton ()

Destructor.

Since:

BlackBerry 10.0.0

bool enabled ()

Retrieves the enabled state of the button.

Return:

Returns whether the button should be enabled.

Since:

BlackBerry 10.0.0

QString label ()

Retrieves the label description that is associated with the button.

Return:

Returns the label of the button.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void resetEnabled ()

Resets the SystemUiButton::enabled property to true.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void resetLabel ()

Resets the label description to QString::null.

Since:

BlackBerry 10.0.0

void setEnabled (
boolvalue)

Enables or disables the button.

Parameters
value	The new enabled state of the button.

Since:

BlackBerry 10.0.0

void setLabel (
const QString &text)

Sets the label description to associate with the button.

Empty or NULL labels may not be shown.

Parameters
text	The new label text.

Since:

BlackBerry 10.0.0

Signals

void enabledChanged (
boolvalue)

Emitted when the enabled property is changed programmatically.

Parameters
value	The new value of the enabled property.

Since:

BlackBerry 10.0.0

void labelChanged (
const QString &value)

Emitted when the label property is changed programmatically.

Parameters
value	The new value of the label property.

Since:

BlackBerry 10.0.0

4. Educate yourself

The Documentation tab contains tons of examples, tutorials, and best practices to guide you along the path towards building an awesome app.

The documentation for your preferred focus always appears at the top of the left-hand navigation, but you can still access the rest of the documentation at the bottom.

5. Start developing

The Reference tab is where you'll find essential details about how to use our APIs.

You can use the left-hand navigation to choose how you would like to browse the reference: by module, by topic, or alphabetically. If you have an idea of what you are looking for, start typing it in the Filter box.

SystemUiButton

Overview

Properties Index

Public Functions Index

Signals Index

Properties

bool enabled

QString label

Public Functions

SystemUiButton (
QObject *parent)

SystemUiButton (
const QString &label,
QObject *parent )

virtual~SystemUiButton ()

bool enabled ()

QString label ()

Q_INVOKABLE void resetEnabled ()

Q_INVOKABLE void resetLabel ()

void setEnabled (
boolvalue)

void setLabel (
const QString &text)

Signals

void enabledChanged (
boolvalue)

void labelChanged (
const QString &value)

1. Choose your focus

2. Download the tools

3. Try the sample apps

4. Educate yourself

5. Start developing

SystemUiButton

Overview

Properties Index

Public Functions Index

Signals Index

Properties

bool enabled

QString label

Public Functions

SystemUiButton (QObject *parent)

SystemUiButton (const QString &label, QObject *parent )

virtual~SystemUiButton ()

bool enabled ()

QString label ()

Q_INVOKABLE void resetEnabled ()

Q_INVOKABLE void resetLabel ()

void setEnabled (boolvalue)

void setLabel (const QString &text)

Signals

void enabledChanged (boolvalue)

void labelChanged (const QString &value)

1. Choose your focus

2. Download the tools

3. Try the sample apps

4. Educate yourself

5. Start developing

SystemUiButton (
QObject *parent)

SystemUiButton (
const QString &label,
QObject *parent )

void setEnabled (
boolvalue)

void setLabel (
const QString &text)

void enabledChanged (
boolvalue)

void labelChanged (
const QString &value)