TitleBarExpandableArea

Since: BlackBerry 10.1.0

#include <bb/cascades/TitleBarExpandableArea>

Describes an expandable area, such as FreeFormTitleBarProperties.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::TitleBarExpandableArea

QML properties

content: bb::cascades::Control
expanded: bool
indicatorVisibility: bb::cascades::TitleBarExpandableAreaIndicatorVisibility::Type
toggleArea: bb::cascades::TitleBarExpandableAreaToggleArea::Type
objectName: QStringInherited
parent: QObject [read-only]Inherited

Public Functions Index

virtual ~TitleBarExpandableArea ()
bb::cascades::Control *content () const
bb::cascades::TitleBarExpandableAreaIndicatorVisibility::TypeindicatorVisibility () const
boolisExpanded () const
Q_SLOT voidresetContent ()
Q_SLOT voidresetExpanded ()
Q_SLOT voidresetIndicatorVisibility ()
Q_SLOT voidresetToggleArea ()
Q_SLOT voidsetContent (bb::cascades::Control *content)
Q_SLOT voidsetExpanded (bool expanded)
Q_SLOT voidsetIndicatorVisibility (bb::cascades::TitleBarExpandableAreaIndicatorVisibility::Type visibility)
Q_SLOT voidsetToggleArea (bb::cascades::TitleBarExpandableAreaToggleArea::Type toggleArea)
bb::cascades::TitleBarExpandableAreaToggleArea::TypetoggleArea () const
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited

Signals Index

voidcontentChanged (bb::cascades::Control *newContent)
voidexpandedChanged (bool expanded)
voidindicatorVisibilityChanged (bb::cascades::TitleBarExpandableAreaIndicatorVisibility::Type visibility)
voidtoggleAreaChanged (bb::cascades::TitleBarExpandableAreaToggleArea::Type newToggleArea)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bb::cascades::Control content

The content of the expandable area of the TitleBar.

Since:

BlackBerry 10.1.0

bool expanded

The expanded state.

A value of true means that the expandable area is shown, false means that the expandable area is hidden.

The default value of this property is false.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableAreaIndicatorVisibility::Type indicatorVisibility

The visibility of the expandable indicator.

The indicator hints that the TitleBar can be expanded.

The default value of this property is Default, which makes the indicator visible if content is set.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableAreaToggleArea::Type toggleArea

The toggle area for expanding and collapsing the expandable area.

The toggle area is only active if the expandable indicator is visible.

The default value of this property is Default, which uses the entire title bar for toggling the expandable area if content is set.

Since:

BlackBerry 10.1.0

QString objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[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

Public Functions

virtual~TitleBarExpandableArea ()

Destructor.

bb::cascades::Control * content ()

Returns the expandable content of the TitleBar.

Return:

The expandable content of the TitleBar.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableAreaIndicatorVisibility::Type indicatorVisibility ()

Returns the visibility of the expandable indicator.

Return:

The visibility of the expandable indicator.

Since:

BlackBerry 10.1.0

bool isExpanded ()

Returns the current expanded state.

Return:

true if expanded, and false if collapsed.

Since:

BlackBerry 10.1.0

Q_SLOT void resetContent ()

Resets the expandable content of the TitleBar to 0.

Since:

BlackBerry 10.1.0

Q_SLOT void resetExpanded ()

Resets the expanded state to false, which collapses the expandable area.

The expandedChanged signal is emitted when the expanded state is reset.

Since:

BlackBerry 10.1.0

Q_SLOT void resetIndicatorVisibility ()

Resets the visibility of the expandable indicator to Default.

Since:

BlackBerry 10.1.0

Q_SLOT void resetToggleArea ()

Resets the toggle area for expanding and collapsing the expandable area to Default.

Since:

BlackBerry 10.1.0

Q_SLOT void setContent (

Sets the expandable content of the TitleBar.

Parameters
content

The expandable content of the TitleBar.

Since:

BlackBerry 10.1.0

Q_SLOT void setExpanded (
  • boolexpanded)

Sets the expanded state.

In the case of a successful expanded state change, the expandedChanged(bool) signal is emitted. It is possible to set the expanded state to true even if no content is set.
Parameters
expanded

The new state to set: true means expanded, false means collapsed.

Since:

BlackBerry 10.1.0

Q_SLOT void setIndicatorVisibility (

Sets the visibility of the expandable indicator.

Parameters
visibility

The visibility of the expandable indicator.

Since:

BlackBerry 10.1.0

Q_SLOT void setToggleArea (

Sets the toggle area for expanding and collapsing the expandable area.

Parameters
toggleArea

The toggle area for expanding and collapsing the expandable area.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableAreaToggleArea::Type toggleArea ()

Returns the toggle area for expanding and collapsing the expandable area.

Return:

The toggle area for expanding and collapsing the expandable area.

Since:

BlackBerry 10.1.0

void setObjectName (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

Constructs an instance of BaseObject's subclass.

Parameters
parent

An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

Signals

void contentChanged (

Emitted when the expandable content of the TitleBar changes.

Parameters
newContent

The new expandable content.

Since:

BlackBerry 10.1.0

void expandedChanged (
  • boolexpanded)

Emitted when the expanded state has been changed.

Parameters
expanded

The newly set expanded state

Since:

BlackBerry 10.1.0

void indicatorVisibilityChanged (

Emitted when the visibility of the expandable indicator changes.

Parameters
visibility

The new visibility.

Since:

BlackBerry 10.1.0

void toggleAreaChanged (

Emitted when the area for toggling the expandable content.

Parameters
newToggleArea

The new toggle area.

Since:

BlackBerry 10.1.0

void creationCompleted ()Inherited

Emitted 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 indicates 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 also:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-30



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

comments powered by Disqus