Tab

#include <bb/cascades/Tab>

A tab that can be added to a TabbedPane.

The Tab objects in the TabbedPane are added to the Action bar, which is a horizontal bar displayed at the bottom of the screen. By pressing the tabs on the Action bar the user can switch the content that is currently being displayed on the screen. The Tab objects take an AbstractPane as their content. If the content is not 0, it will be displayed in the TabbedPane when the corresponding tab is selected.

Even though a Tab takes AbstractPane as its content, not all classes deriving from AbstractPane are valid as the content. The valid classes are Page and NavigationPane.

QML example:

TabbedPane {
    Tab {
        title : "tab1"
        description : "This is only shown in the side bar"
        imageSource : "tab.png"
        Page {}
    }
}

C++ example:

TabbedPane* tabbedPane = TabbedPane::create();
Page* page = Page::create();
Tab* tab = Tab::create()
             .title("tab1")
             .description("This is only shown in the side bar")
             .image(Image("tab.png");
tab->setContent(page);
tabbedPane->add(tab);

Since:

BlackBerry 10.0.0

Inheritance

bb::cascades::BaseObject
	bb::cascades::UIObject
		bb::cascades::AbstractActionItem
			bb::cascades::Tab

QML properties

description	: QString
content	: bb::cascades::AbstractPane
newContentAvailable	: bool
unreadContentCount	: int
attachedObjects	: QDeclarativeListProperty< QObject > [read-only]
enabled	: bool
image	: bb::cascades::Image
imageSource	: QUrl
objectName	: QString
parent	: QObject [read-only]
shortcuts	: QDeclarativeListProperty< bb::cascades::AbstractShortcut > [read-only]
title	: QString

QML signals

onDescriptionChanged	: {}
onContentChanged	: {}
onNewContentAvailableChanged	: {}
onUnreadContentCountChanged	: {}
onCreationCompleted	: {}
onEnabledChanged	: {}
onImageChanged	: {}
onImageSourceChanged	: {}
onObjectNameChanged	: {}
onTitleChanged	: {}
onTriggered	: {}

Properties Index

QString	description
bb::cascades::AbstractPane	content
bool	newContentAvailable
int	unreadContentCount
QDeclarativeListProperty< QObject >	attachedObjects [read-only]
bool	enabled
QVariant	image
QUrl	imageSource
QString	objectName
QObject	parent [read-only]
QDeclarativeListProperty< bb::cascades::AbstractShortcut >	shortcuts [read-only]
QString	title

Public Functions Index

	Tab (TabbedPane *parent=0)
virtual	~Tab ()
Q_SLOT void	setDescription (const QString &description)
Q_SLOT void	resetDescription ()
QString	description () const
bb::cascades::AbstractPane *	content () const
Q_SLOT void	setContent (bb::cascades::AbstractPane *content)
Q_SLOT void	resetContent ()
Q_SLOT void	setNewContentAvailable (bool isNewContentAvailable)
Q_SLOT void	resetNewContentAvailable ()
bool	isNewContentAvailable () const
Q_SLOT void	setUnreadContentCount (int unreadContentCount)
Q_SLOT void	resetUnreadContentCount ()
int	unreadContentCount () const
Q_INVOKABLE void	addShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_INVOKABLE void	disableAllShortcuts ()
Q_INVOKABLE void	enableAllShortcuts ()
virtual bool	event (QEvent *event)
bb::cascades::Image	image () const
QUrl	imageSource () const
bool	isEnabled () const
Q_INVOKABLE void	removeAllShortcuts ()
Q_INVOKABLE bool	removeShortcut (bb::cascades::AbstractShortcut *shortcut)
Q_SLOT void	resetEnabled ()
Q_SLOT void	resetImage ()
Q_SLOT void	resetImageSource ()
Q_SLOT void	resetTitle ()
Q_SLOT void	setEnabled (bool enabled)
Q_SLOT void	setImage (const bb::cascades::Image &image)
Q_SLOT void	setImageSource (const QUrl &source)
void	setObjectName (const QString &name)
Q_SLOT void	setTitle (const QString &title)
Q_INVOKABLE bb::cascades::AbstractShortcut *	shortcutAt (int index) const
Q_INVOKABLE int	shortcutCount () const
const QString	title () const
virtual Q_INVOKABLE QString	toDebugString () const

Static Public Functions Index

Builder

create ()

Protected Functions Index

Only has inherited protected functions

	BaseObject (QObject *parent=0)
virtual void	connectNotify (const char *signal)
virtual void	disconnectNotify (const char *signal)

Signals Index

void	descriptionChanged (QString description)
void	contentChanged (bb::cascades::AbstractPane *content)
void	newContentAvailableChanged (bool isNewContentAvailable)
void	unreadContentCountChanged (int unreadContentCount)
void	creationCompleted ()
void	enabledChanged (bool enabled)
void	imageChanged (const bb::cascades::Image &image)
void	imageSourceChanged (const QUrl &imageSource)
void	objectNameChanged (const QString &objectName)
void	titleChanged (const QString &title)
void	triggered ()

Properties

QString description

The description text to be displayed for tabs placed in the side bar of a TabbedPane.

The description text displayed for tabs placed in the side bar. The description is not shown for tabs placed on the Action bar. The default value is QString::Null, indicating that no description is set.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractPane content

The content to show when the tab is activated.

The content to display in the TabbedPane when this Tab becomes active. Valid content is NavigationPane and Page. If 0 the content displayed in the TabbedPane will remain unchanged. The default value is 0.

This is the default property of the tab, so it does not need to be explicitly declared in the QML.

Tab {
    Page {
        Container {}
    }
}

Since:

BlackBerry 10.0.0

bool newContentAvailable

A visual notification to show on the tab if there is new content.

The default value is false, indicating that there is no new content.

Since:

BlackBerry 10.0.0

int unreadContentCount

The unread content count to show on the Tab in the Side bar.

If value is between 1 and 9999, the number is displayed on the tab in the Side bar. If the value is 10000 or greater the text "9999+" is showing. If the value is 0 or less the number is not displayed.

The default value is 0.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< QObject > attachedObjects[read-only]

A hierarchical list of the UIObject's attached objects.

This QDeclarativeListProperty can contain any QObject. When a QObject is added to property, the UIObject takes ownership of the attached object.

This feature is typically used from QML to specify business logic object or any other shared objects for the subnodes of this UIObject. In C++ the same functionality can be achived by setting a parent of a QObject to be attached to the QObject which is going to own it.

QML usage example (MyObject is a custom class registered for QML using the qmlRegisterType() function):

Container {
    Label { text: "Title: " + myObject.title } 
    Label { text: "Subject: " + myObject.subject }
    attachedObjects: [
        MyObject { id: myObject
            title: "Hello World"
            subject: "Nice Day"
        }
    ]
}

Since:

BlackBerry 10.0.0

bool enabled

Indicates whether the action is enabled.

When an action is disabled, it will be dimmed and it will not be possible for the user to press on it and it will not emit the triggered signal.

Since:

BlackBerry 10.0.0

QVariant image

The image set on the action.

The default value is an empty image, indicating no image is set.

Since:

BlackBerry 10.0.0

QUrl imageSource

The image set on the action.

If no image is set, an invalid QUrl will be returned. When changing the image source the imageSourceChanged() signal will be emitted.

Since:

BlackBerry 10.0.0

QString objectName

This property is overridden from QObject.

As the objectName property is overridden from the QObject class, this signal will not be emitted if setObjectName() function is called directly on QObject.

The default value of this property is QString::null.

See:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parent[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcuts[read-only]

A list of shortcuts that can be triggered via user actions.

The order in which they are added will determine which shortcut will be triggered in case of an overlap. Predefined shortcuts take precedence over shortcuts defined via QString in case of a collision.

See:

AbstractShortcut

Since:

BlackBerry 10.1.0

QString title

A string that will be displayed with the action.

The default value is QString::Null, indicating that no text is set.

Since:

BlackBerry 10.0.0

Public Functions

Tab (
TabbedPane *parent)

Constructs a new Tab object and adds it to an optional TabbedPane.

The ownership of the tab is transferred to the parent if a parent is specified.

Parameters
parent	The TabbedPane to add this tab to. This parameter is optional.

Since:

BlackBerry 10.0.0

virtual~Tab ()

Destructor.

Since:

BlackBerry 10.0.0

Q_SLOT void setDescription (
const QString &description)

Sets the description text of this Tab.

The description text displayed for tabs placed in the side bar. The description is not shown for tabs placed on the Action bar.

Parameters
description	The description of this Tab.

Since:

BlackBerry 10.0.0

Q_SLOT void resetDescription ()

Resets the description text of this Tab to QString::Null.

Since:

BlackBerry 10.0.0

QString description ()

Gets the description text of this Tab.

Return:

The description text of this Tab.

Since:

BlackBerry 10.0.0

bb::cascades::AbstractPane * content ()

Gets the content of this Tab.

Ownership will not be transferred.

Return:

The content of this Tab.

Since:

BlackBerry 10.0.0

Q_SLOT void setContent (
bb::cascades::AbstractPane *content)

Sets the content of this Tab.

Ownership of the content will always be transferred to this Tab. If this Tab already has content, the old content is still owned by this Tab and will be destroyed when this Tab is destroyed.

If content was successfully set using this function, the contentChanged() signal is emitted.

Parameters
content	The content to set. Can be 0 to remove content (old content will still be owned by this Tab).

Since:

BlackBerry 10.0.0

Q_SLOT void resetContent ()

Resets the content for this Tab.

This function resets the content for this Tab. Content will be removed and content property set to 0. This is equivalent to calling setContent(0). When this function completes, the contentChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void setNewContentAvailable (
boolisNewContentAvailable)

Sets the newContentAvailable flag of this Tab.

The newContentAvailable indicator is shown on the top right corner of the Tab icon. It will show on the Tab in the sidebar and on the Action bar if the Tab is forced to the Action bar.

Parameters
isNewContentAvailable	The flag to tell if there is new content or not.

Since:

BlackBerry 10.0.0

Q_SLOT void resetNewContentAvailable ()

Resets the flag to false, which means no new content in the tab.

Since:

BlackBerry 10.0.0

bool isNewContentAvailable ()

Gets the newContentAvailable flag of this Tab.

Return:

The newContentAvailable flag of this Tab.

Since:

BlackBerry 10.0.0

Q_SLOT void setUnreadContentCount (
intunreadContentCount)

Sets the unread content count to show on the Tab.

If value is between 1 and 9999, that number is displayed on the tab in the Side bar. If the value is 10000 or greater the text "9999+" is shown. If the value is 0 or less the number is not displayed.

Parameters
unreadContentCount	The number to show on the tab.

Since:

BlackBerry 10.0.0

Q_SLOT void resetUnreadContentCount ()

Hides the unread content count by resetting it to 0.

Since:

BlackBerry 10.0.0

int unreadContentCount ()

Gets the unread content count shown on the Tab.

Return:

The unread content count shown on the Tab. 0 if no content count is shown.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

Adds a shortcut to the AbstractActionItem.

AbstractActionItem will always take ownership, as shortcuts should never be shared. If the shortcut already belongs to the AbstractActionItem or the shortcut is 0, nothing will happen. The order in which shortcuts are added will determine which shortcut will be triggered in case of an overlap.

Parameters
shortcut	The AbstractShortcut to add to the AbstractActionItem.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void disableAllShortcuts ()

Disables all shortcuts attached to the AbstractActionItem.

Shortcuts that are attached afterward will use the default enabled state.

Since:

BlackBerry 10.1.0

Q_INVOKABLE void enableAllShortcuts ()

Enables all shortcuts attached to the AbstractActionItem.

Since:

BlackBerry 10.1.0

virtual bool event (
QEvent *event)

Overloaded to implement the event mechanism in Cascades.

Warning:

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
event	The received event.

Return:

True if the received event was recognized and processed, false otherwise.

Since:

BlackBerry 10.0.0

bb::cascades::Image image ()

Returns the image to display on the action item.

Return:

The image for the item or an empty image.

Since:

BlackBerry 10.0.0

QUrl imageSource ()

Returns the image source.

Return:

The source of the displayed image.

Since:

BlackBerry 10.0.0

bool isEnabled ()

Returns the enabled state of the action.

Return:

true if the control is enabled, false otherwise.

Since:

BlackBerry 10.0.0

Q_INVOKABLE void removeAllShortcuts ()

Removes all of a AbstractActionItem's shortcuts and frees up their memory.

Since:

BlackBerry 10.1.0

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

Removes a shortcut from the AbstractActionItem.

Once the shortcut is removed, the AbstractActionItem no longer references it, but it is still owned by the AbstractActionItem. It is up to the application to either delete the removed shortcut, transfer its ownership (by setting its parent) to another object, or leave it as a child of the AbstractActionItem (in which case it will be deleted with the AbstractActionItem).

Parameters
shortcut	The AbstractShortcut to remove.

Return:

true if the shortcut was owned by the AbstractActionItem, false otherwise.

Since:

BlackBerry 10.1.0

Q_SLOT void resetEnabled ()

Resets the enabled state of the action to true.

After the operation is completed and the enabled state is changed, the enabledChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetImage ()

Resets the image, meaning no image is set for the action.

After the operation is completed and the image is changed, the imageChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void resetImageSource ()

Resets the Image on the action to its default, meaning that no image is set.

This function emits an imageSourceChanged() signal if the currently set image source changes.

Since:

BlackBerry 10.0.0

Q_SLOT void resetTitle ()

Resets the title on the action to QString::Null.

After the operation is completed, and the title is changed, the titleChanged() signal is emitted.

Since:

BlackBerry 10.0.0

Q_SLOT void setEnabled (
boolenabled)

Sets the enabled state of the action.

After the operation is completed and the enabled state is changed, the enabledChanged() signal is emitted.

Parameters
enabled	If true the action is enabled and if false the action is disabled.

Since:

BlackBerry 10.0.0

Q_SLOT void setImage (
const bb::cascades::Image &image)

Sets the image to display on the action item.

After the operation is completed and the image is changed, the imageChanged() signal is emitted.

Parameters
image	The image to display.

Since:

BlackBerry 10.0.0

Q_SLOT void setImageSource (
const QUrl &source)

Sets the Image for the action.

An invalid QUrl indicates no image. This function emits an imageSourceChanged() signal if the currently set image source changes.

Parameters
source	The image URL.

Since:

BlackBerry 10.0.0

void setObjectName (
const QString &name)

Sets the objectName property.

Parameters
name	The new name for the object.

Since:

BlackBerry 10.0.0

Q_SLOT void setTitle (
const QString &title)

Sets the title on the action.

After the operation is completed, and the title changed, the titleChanged() signal is emitted.

Parameters
title	The title of the action.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (
intindex)

Returns a shortcut at the specified index.

Ownership of the shortcut remains with the AbstractActionItem.

Parameters
index	The index of the shortcut.

Return:

The requested shortcut if the index was valid, 0 otherwise.

Since:

BlackBerry 10.1.0

Q_INVOKABLE int shortcutCount ()

Returns the number of shortcuts.

Return:

The number of shortcuts.

Since:

BlackBerry 10.1.0

const QString title ()

Gets the title of the action.

Return:

The title of the action.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Static Public Functions

Builder create ()

Creates and returns a builder for constructing a Tab object.

Using the builder to create a Tab object.

Example:

Tab::create()
    .title("tab1")
    .subtitle("This is only shown in the overflow menu")
    .image(Image("tab.png"));
    .content(Page::create());

Return:

A builder used for constructing a Tab object.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (
QObject *parent)

Constructs an instance of BaseObject's subclass.

Parameters
parent	An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

virtual void connectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The connected signal.

Since:

BlackBerry 10.0.0

virtual void disconnectNotify (
const char *signal)

Overloaded to implement the event mechanism in Cascades.

If this function is overridden, it must be called by the derived class for events to work properly in Cascades.

Parameters
signal	The disconnected signal.

Since:

BlackBerry 10.0.0

Signals

void descriptionChanged (
QStringdescription)

Emitted when the description of this Tab changes.

Parameters
description	The new description.

Since:

BlackBerry 10.0.0

void contentChanged (
bb::cascades::AbstractPane *content)

Emitted when the content of this Tab has changed.

Parameters
content	The new content of this Tab.

Since:

BlackBerry 10.0.0

void newContentAvailableChanged (
boolisNewContentAvailable)

Emitted when the newContentAvailable flag of this Tab changes.

Parameters
isNewContentAvailable	The new value of the newContentAvailable flag.

Since:

BlackBerry 10.0.0

void unreadContentCountChanged (
intunreadContentCount)

Emitted when the newContentCount value of this Tab changes.

Parameters
unreadContentCount	The new value of the unreadContentCount flag.

Since:

BlackBerry 10.0.0

void creationCompleted ()

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node, or when an object is being constructed using its builder class.

This signal is emitted only when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class. This signal is emitted to indicate that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See:

QmlDocument

Since:

BlackBerry 10.0.0

void enabledChanged (
boolenabled)

Emitted when the enabled property on the action changes.

Parameters
enabled	If true the action is enabled, if false the action is disabled.

Since:

BlackBerry 10.0.0

void imageChanged (
const bb::cascades::Image &image,
)

Emitted when the image for the action changes.

Parameters
image	The new image or an empty image if changed to no image.

Since:

BlackBerry 10.0.0

void imageSourceChanged (
const QUrl &imageSource)

Emitted when the image source changes.

Parameters
imageSource	The new image source or an invalid QUrl if no source is set.

Since:

BlackBerry 10.0.0

void objectNameChanged (
const QString &objectName)

This signal is emitted when the objectName property is changed.

See:

QObject, BaseObject::objectName.

Since:

BlackBerry 10.0.0

void titleChanged (
const QString &title)

Emitted when the title has changed.

Parameters
title	The new title.

Since:

BlackBerry 10.0.0

void triggered ()

Emitted when the ActionItem is triggered by user.

Since:

BlackBerry 10.0.0

Tab

Inheritance

QML properties

QML signals

Properties Index

Public Functions Index

Static Public Functions Index

Protected Functions Index

Signals Index

Properties

QString description

bb::cascades::AbstractPane content

bool newContentAvailable

int unreadContentCount

QDeclarativeListProperty< QObject > attachedObjects[read-only]

bool enabled

QVariant image

QUrl imageSource

QString objectName

QObject parent[read-only]

QDeclarativeListProperty< bb::cascades::AbstractShortcut > shortcuts[read-only]

QString title

Public Functions

Tab (TabbedPane *parent)

virtual~Tab ()

Q_SLOT void setDescription (const QString &description)

Q_SLOT void resetDescription ()

QString description ()

bb::cascades::AbstractPane * content ()

Q_SLOT void setContent (bb::cascades::AbstractPane *content)

Q_SLOT void resetContent ()

Q_SLOT void setNewContentAvailable (boolisNewContentAvailable)

Q_SLOT void resetNewContentAvailable ()

bool isNewContentAvailable ()

Q_SLOT void setUnreadContentCount (intunreadContentCount)

Q_SLOT void resetUnreadContentCount ()

int unreadContentCount ()

Q_INVOKABLE void addShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_INVOKABLE void disableAllShortcuts ()

Q_INVOKABLE void enableAllShortcuts ()

virtual bool event (QEvent *event)

bb::cascades::Image image ()

QUrl imageSource ()

bool isEnabled ()

Q_INVOKABLE void removeAllShortcuts ()

Q_INVOKABLE bool removeShortcut (bb::cascades::AbstractShortcut *shortcut)

Q_SLOT void resetEnabled ()

Q_SLOT void resetImage ()

Q_SLOT void resetImageSource ()

Q_SLOT void resetTitle ()

Q_SLOT void setEnabled (boolenabled)

Q_SLOT void setImage (const bb::cascades::Image &image)

Q_SLOT void setImageSource (const QUrl &source)

void setObjectName (const QString &name)

Q_SLOT void setTitle (const QString &title)

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (intindex)

Q_INVOKABLE int shortcutCount ()

const QString title ()

virtual Q_INVOKABLE QString toDebugString ()

Static Public Functions

Builder create ()

Protected Functions

BaseObject (QObject *parent)

virtual void connectNotify (const char *signal)

virtual void disconnectNotify (const char *signal)

Signals

void descriptionChanged (QStringdescription)

void contentChanged (bb::cascades::AbstractPane *content)

void newContentAvailableChanged (boolisNewContentAvailable)

void unreadContentCountChanged (intunreadContentCount)

void creationCompleted ()

void enabledChanged (boolenabled)

void imageChanged (const bb::cascades::Image &image, )

void imageSourceChanged (const QUrl &imageSource)

void objectNameChanged (const QString &objectName)

void titleChanged (const QString &title)

void triggered ()

Tab (
TabbedPane *parent)

Q_SLOT void setDescription (
const QString &description)

Q_SLOT void setContent (
bb::cascades::AbstractPane *content)

Q_SLOT void setNewContentAvailable (
boolisNewContentAvailable)

Q_SLOT void setUnreadContentCount (
intunreadContentCount)

Q_INVOKABLE void addShortcut (
bb::cascades::AbstractShortcut *shortcut)

virtual bool event (
QEvent *event)

Q_INVOKABLE bool removeShortcut (
bb::cascades::AbstractShortcut *shortcut)

Q_SLOT void setEnabled (
boolenabled)

Q_SLOT void setImage (
const bb::cascades::Image &image)

Q_SLOT void setImageSource (
const QUrl &source)

void setObjectName (
const QString &name)

Q_SLOT void setTitle (
const QString &title)

Q_INVOKABLE bb::cascades::AbstractShortcut * shortcutAt (
intindex)

BaseObject (
QObject *parent)

virtual void connectNotify (
const char *signal)

virtual void disconnectNotify (
const char *signal)

void descriptionChanged (
QStringdescription)

void contentChanged (
bb::cascades::AbstractPane *content)

void newContentAvailableChanged (
boolisNewContentAvailable)

void unreadContentCountChanged (
intunreadContentCount)

void enabledChanged (
boolenabled)

void imageChanged (
const bb::cascades::Image &image,
)

void imageSourceChanged (
const QUrl &imageSource)

void objectNameChanged (
const QString &objectName)

void titleChanged (
const QString &title)