SingleLineTextFilter

Since: BlackBerry 10.0.0

#include <bb/cascades/SingleLineTextFilter>

A text filter that prevents line breaks from being added to text in a text control.

If installed on a text control, a SingleLineTextFilter prevents the document from having explicit line breaks. Line breaks will be stripped away from content that is added to the document through pasting, binding, editing or other mechanisms. If two words are separated with a line break, the SingleLineTextFilter will ensure that the word separation is maintained, typically by inserting a white space. If the text doesn't fit on one single line, the layout may still display the text on multiple lines if the control allows for it. When this happens, automatic line breaks will be computed because the SingleLineTextFilter has removed all explicit line breaks.

Creating a TextArea with a SingleLineTextFilter, using the builder pattern:
TextArea *textArea = TextArea::create()
    .textFilter(SingleLineTextFilter::create())
    .text("This text\ncontains line\n breaks that 
          have been \nremoved by the filter.");
Setting the SingleLineTextFilter on a TextArea, in QML:
TextArea {
   textFilter: SingleLineTextFilter { }
   text: "This text\ncontains line\n breaks that 
          have been \nremoved by the filter."

   onTextFilterChanged: {
     if(textFilter) {
        console.debug("A filter was added.");
     }
   }
}


Overview

Inheritance

QML properties

Only has inherited QML properties

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

QML signals

Only has inherited QML signals

onCreationCompletedInherited: {}
onObjectNameChangedInherited: {}

Properties Index

Only has inherited properties

QStringobjectNameInherited
QObjectparent [read-only]Inherited

Public Functions Index

SingleLineTextFilter (BaseObject *parent=0)
virtual ~SingleLineTextFilter ()
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited

Static Public Functions Index

Buildercreate ()

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited

Signals Index

Only has inherited signals

voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

(Only has inherited properties)

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

SingleLineTextFilter (

Constructs a SingleLineTextFilter.

Since:

BlackBerry 10.0.0

virtual~SingleLineTextFilter ()

Destructor.

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

Static Public Functions

Builder create ()

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

(Only has inherited signals)

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