TextAreaAutoSizeProperties

Since: BlackBerry 10.2.0

#include <bb/cascades/TextAreaAutoSizeProperties>

Represents the auto size properties of a TextArea.

The TextAreaAutoSizeProperties configures how the TextArea adapts its size to its content.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::TextAreaAutoSizeProperties

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 visible lines that the TextArea can expand to.

Since:

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

int maxLineCount ()

Returns the maximum number of visible lines that the TextArea can expand to.

Return:

The maximum number of lines that the TextArea can expand to, or -1 if no limit is set.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMaxLineCount ()

Resets maxLineCount to its default state.

The default state is -1.

Since:

BlackBerry 10.2.0

Q_SLOT void setMaxLineCount (
  • intmaxLineCount)

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

The value must be -1 or greater than 0, otherwise it will be ignored. The value -1 is equivalent to calling resetMaxLineCount.

Parameters
maxLineCount

The new maxLineCount value

Since:

BlackBerry 10.2.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, or -1 if the maximum line count has been reset.

Since:

BlackBerry 10.2.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-06-24



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

comments powered by Disqus