FreeFormTitleBarKindProperties

Since: BlackBerry 10.1.0

#include <bb/cascades/FreeFormTitleBarKindProperties>

A class that groups properties associated with the FreeForm type of TitleBar.

FreeFormTitleBarKindProperties has two properties that determine the visual components for of a free-form TitleBar. The default property content contains the content displayed directly on the title bar. The group property expandableArea contains content that can be expanded and collapsed by tapping the title bar.


Overview

QML properties

content: bb::cascades::Control
expandableArea: bb::cascades::TitleBarExpandableArea [read-only]
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

QML signals

onContentChanged: {}
onCreationCompletedInherited: {}
onObjectNameChangedInherited: {}

Properties Index

Public Functions Index

FreeFormTitleBarKindProperties ()
virtual ~FreeFormTitleBarKindProperties ()
bb::cascades::Control *content () const
bb::cascades::TitleBarExpandableArea *expandableArea () const
Q_SLOT voidresetContent ()
Q_SLOT voidsetContent (bb::cascades::Control *content)
virtual boolevent (QEvent *event)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited
virtual voidconnectNotify (const char *signal)Inherited
virtual voiddisconnectNotify (const char *signal)Inherited

Signals Index

voidcontentChanged (bb::cascades::Control *newContent)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bb::cascades::Control content

The content of the TitleBar if the kind property is FreeForm.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableArea expandableArea[read-only]

A group property for properties associated with the expandable area.

If the TitleBar::kind property is FreeForm, the title bar will use the properties from expandableArea to create a drop-down like title bar.

 TitleBar {
     kind: TitleBarKind.FreeForm
     kindProperties: FreeFormTitleBarKindProperties {
         Container {
             layout: StackLayout { orientation: LayoutOrientation.LeftToRight }
             leftPadding: 10
             Label {
                 text: "Tap the indicator to expand and collapse"
                 textStyle {
                     color: Color.White
                 }
                 verticalAlignment: VerticalAlignment.Center
             }
         }
         expandableArea {
             content: Label {
                 text: "This is the expandable area"
             }
             expanded: true
             toggleArea: TitleBarExpandableAreaToggleArea.IndicatorOnly
         }
     }
 }
Since:

BlackBerry 10.1.0

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.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

bb::cascades::UIConfig uiInherited[read-only]

An object that gives access to unit conversion routines.

QML use:
        // Size using design units
        Container {
            preferredWidth: ui.du(12)
            preferredHeight: ui.du(5)
        }

        // Size using design units, snap to whole pixels
        Container {
            preferredWidth: ui.sdu(13.5)
            preferredHeight: ui.sdu(7.5)
        }

        // Size using absolute pixel values
        Container {
            preferredWidth: ui.px(150)
            preferredHeight: ui.px(50)
        }
C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Since:

Blackberry 10.3.0

Public Functions

FreeFormTitleBarKindProperties ()

Constructs a FreeFormTitleBarKindProperties.

Since:

BlackBerry 10.1.0

virtual~FreeFormTitleBarKindProperties ()

Destructor.

Since:

BlackBerry 10.1.0

bb::cascades::Control * content ()

Returns the free-form content of the TitleBar.

Return:

The free-form content of the TitleBar.

Since:

BlackBerry 10.1.0

bb::cascades::TitleBarExpandableArea * expandableArea ()

Returns the expandableArea of the TitleBar.

Return:

The expandable area of the TitleBar.

Since:

BlackBerry 10.1.0

Q_SLOT void resetContent ()

Resets the free-form content of the TitleBar to 0.

Since:

BlackBerry 10.1.0

Q_SLOT void setContent (

Sets the free-form content of the TitleBar.

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

Parameters
content

The free-form content of the TitleBar.

Since:

BlackBerry 10.1.0

virtual bool event (Inherited

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

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

Q_INVOKABLE bb::cascades::UIConfig * ui ()Inherited

Returns the UIConfig for this ui object.

The UIConfig can be used to perform unit conversions from design units (du) and snapped design units (sdu) to pixels.

Ownership remains with Cascades.

C++ use:
Container *container1 = Container::create().background(Color::Red);
UIConfig *ui = container1->ui();
container1->setPreferredWidth(ui->du(12));
container1->setPreferredHeight(ui->du(5));

Container *container2 = Container::create().background(Color::Green);
container2->setPreferredWidth(ui->sdu(13.5));
container2->setPreferredHeight(ui->sdu(7.5));

Container *container3 = Container::create().background(Color::Blue);
container3->setPreferredWidth(ui->px(150));
container3->setPreferredHeight(ui->sdu(50));
Return:

The UIConfig for this ui object.

Since:

BlackBerry 10.3.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

virtual void connectNotify (
  • const char *signal)
Inherited

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)
Inherited

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 contentChanged (

Emitted when the free-form content of the TitleBar changes.

Parameters
newContent

The new free-form content.

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