TextFitProperties

Since: BlackBerry 10.2.0

#include <bb/cascades/TextFitProperties>

Represents the base auto fit properties of a text control.

The TextFitProperties configures how the control content adapts its size to the control size.


Overview

QML properties

maxFontSizeValue: float
minFontSizeValue: float
objectName: QStringInherited
parent: QObject [read-only]Inherited

Properties Index

floatmaxFontSizeValue
floatminFontSizeValue
QStringobjectNameInherited
QObjectparent [read-only]Inherited

Public Functions Index

floatmaxFontSizeValue () const
floatminFontSizeValue () const
Q_SLOT voidresetMaxFontSizeValue ()
Q_SLOT voidresetMinFontSizeValue ()
Q_SLOT voidsetMaxFontSizeValue (float maxFontSizeValue)
Q_SLOT voidsetMinFontSizeValue (float minFontSizeValue)
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

voidmaxFontSizeValueChanged (float maxFontSizeValue)
voidminFontSizeValueChanged (float minFontSizeValue)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

float maxFontSizeValue

The maximum font size value.

Note:

For each control the default maximum font size value is defined at system level. The system value takes precedence if maxFontSizeValue is bigger than system one.

Since:

BlackBerry 10.2.0

float minFontSizeValue

The minimum font size value.

This indicates the minimum font size in post script units.

The default value is -1.0 which means that the system default value will be used instead.

If both minFontSizeValue and maxFontSizeValue are specified then maxFontSizeValue must be greater than or equal to minFontSizeValue.

Note:

For each control the default minimal font size value is defined at system level. The system value takes precedence if minFontSizeValue is less than system one.

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

float maxFontSizeValue ()

Returns the maximum font size value.

Return:

The maximum font size value.

Since:

BlackBerry 10.2.0

float minFontSizeValue ()

Returns the minimum font size value.

Return:

The minimum font size value.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMaxFontSizeValue ()

Resets maxFontSizeValue to its default value.

The default value is -1.0.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMinFontSizeValue ()

Resets minFontSizeValue to its default value.

The default value is -1.0.

Since:

BlackBerry 10.2.0

Q_SLOT void setMaxFontSizeValue (
  • floatmaxFontSizeValue)

Sets the maximum font size value.

The value must be -1.0, 0.0f or positive otherwise it will be ignored. Use resetMaxFontSizeValue() to reset the property to the default value.

Parameters
maxFontSizeValue

The new maxFontSizeValue value

Since:

BlackBerry 10.2.0

Q_SLOT void setMinFontSizeValue (
  • floatminFontSizeValue)

Sets the minimum font size value.

The value must be -1.0, 0.0f or positive otherwise it will be ignored. Use resetMinFontSizeValue() to reset the property to the default value.

Parameters
minFontSizeValue

The new minFontSizeValue 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 maxFontSizeValueChanged (
  • floatmaxFontSizeValue)

Emitted when the maxFontSizeValue is changed.

Parameters
maxFontSizeValue

The new maxFontSizeValue.

Since:

BlackBerry 10.2.0

void minFontSizeValueChanged (
  • floatminFontSizeValue)

Emitted when the minFontSizeValue is changed.

Parameters
minFontSizeValue

The new minFontSizeValue.

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