LabelAutoSizeProperties

Since: BlackBerry 10.1.0

#include <bb/cascades/LabelAutoSizeProperties>

Represents the auto size properties of a Label.

The LabelAutoSizeProperties configures how the Label adapts its size to its content.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::LabelAutoSizeProperties

QML properties

maxLineCount: int
objectName: QStringInherited
parent: QObject [read-only]Inherited

QML signals

Properties Index

intmaxLineCount
QStringobjectNameInherited
QObjectparent [read-only]Inherited

Public Functions Index

intmaxLineCount () const
Q_SLOT voidresetMaxLineCount ()
Q_SLOT voidsetMaxLineCount (int maxLineCount)
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

voidmaxLineCountChanged (int maxLineCount)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

int maxLineCount

The maximum number of lines that the Label can expand to.

When this value is set, a Label will automatically expand its height to accomodate additional text, up to the number of lines that the property specifies. The size of the control will not automatically increase in size past what is needed to show the specified number of lines.

There are other mechanisms that can affect the size of the control as well (layout and explicit sizing using preferred size properties for instance). This property does not limit such mechanisms from extending the size of the control past what is specified by this property.

Note:

Label's multiline property must be set to true in order to wrap the text on multiple lines.

Label {
    multiline: true
    autoSize {
        maxLineCount: 2
    }
}

The default value is -1

Since:

BlackBerry 10.1.0

QString objectNameInherited

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

int maxLineCount ()

Returns the maximum number of lines that the Label can expand to.

Return:

The maximum number of lines that the label can expand to.

Since:

BlackBerry 10.1.0

Q_SLOT void resetMaxLineCount ()

Resets maxLineCount to its default state.

The default state is -1.

Since:

BlackBerry 10.1.0

Q_SLOT void setMaxLineCount (
  • intmaxLineCount)

Sets the maximum number of lines that the Label should auto size to.

The value must be positive or it will be ignored. Use restMaxLineCount() to reset the property to the default value.

Parameters
maxLineCount

The new positive maxLineCount value

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 maxLineCountChanged (
  • intmaxLineCount)

Emitted when the maxLineCount is changed.

Parameters
maxLineCount

The new maxLineCount.

Since:

BlackBerry 10.1.0

void creationCompleted ()Inherited

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 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-03-13

comments powered by Disqus