FocusHighlightEffect

Since: BlackBerry 10.3.1

#include <bb/cascades/FocusHighlightEffect>

A focus highlight effect that can be set on images and other controls.

This effect represents the "focus highlight" effect that's used when a user focuses on a control by using the trackpad.

Here are some examples of how icons appear using different colors and styles of highlights:

Sets of icons that use different focus highlight effects.

And here's an example of how to attach the effect to a control:

        ImageView {
            imageSource: "asset:///ca_camera_inactive.png"
            effects: [
                FocusHighlightEffect {
                    enabled: true
                    baseColor: Color.Blue
                    style: FocusHighlightEffectStyle.LinearGradient
                }
            ]
        }


Overview

QML properties

baseColor: bb::cascades::Color | bb::cascades::ColorPaint
style: bb::cascades::FocusHighlightEffectStyle::Type
attachedObjects: QDeclarativeListProperty< QObject > [read-only]Inherited
enabled: boolInherited
objectName: QStringInherited
parent: QObject [read-only]Inherited
ui: bb::cascades::UIConfig [read-only]Inherited

Properties Index

Public Functions Index

FocusHighlightEffect (VisualNode *parent=0)
virtual ~FocusHighlightEffect ()
QVariantbaseColor () const
Q_SLOT voidresetBaseColor ()
Q_SLOT voidresetStyle ()
Q_SLOT voidsetBaseColor (const ColorPaint &color)
Q_SLOT voidsetStyle (bb::cascades::FocusHighlightEffectStyle::Type style)
bb::cascades::FocusHighlightEffectStyle::Typestyle () const
virtual boolevent (QEvent *event)Inherited
boolisEnabled () const Inherited
Q_SLOT voidresetEnabled ()Inherited
Q_SLOT voidsetEnabled (bool enabled)Inherited
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Q_INVOKABLE bb::cascades::UIConfig *ui () const Inherited

Static Public Functions Index

Buildercreate ()

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

voidbaseColorChanged (const bb::cascades::ColorPaint &baseColor)
voidstyleChanged (bb::cascades::FocusHighlightEffectStyle::Type newStyle)
voidcreationCompleted ()Inherited
voidenabledChanged (bool enabled)Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

QVariant baseColor

A color to use as the base for this FocusHighlightEffect.

Since:

BlackBerry 10.3.1

bb::cascades::FocusHighlightEffectStyle::Type style

Specifies the style of the FocusHighlightEffect (flat or gradient).

You should note that not all VisualNode types support all styles. See FocusHighlightEffectStyle for more information. The default value is FocusHighlightEffectStyle::Flat.

Since:

BlackBerry 10.3.1

QDeclarativeListProperty< QObject > attachedObjectsInherited[read-only]

A hierarchical list of the UIObject's attached objects.

Since:

BlackBerry 10.0.0

bool enabledInherited

Whether the effect is enabled out or not.

Since:

BlackBerry 10.3.1

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

FocusHighlightEffect (

Constructs an FocusHighlightEffect object.

When you add a focus highlight effect to a control using VisualNode::addEffect(), the control assumes ownership of this instance unless it was previously added to a different control, in which case ownership stays with the original control.

Parameters
parent

The parent visual node. This parameter is optional and defaults to 0 if not specified. When the effect is assigned to a node, this value is updated.

Since:

BlackBerry 10.3.1

virtual~FocusHighlightEffect ()

Destructor.

QVariant baseColor ()

Returns the base color for the FocusHighlightEffect.

The returned QVariant will either be invalid or contain values of type Color or ColorPaint. An invalid QVariant signifies that a color has not been set.

Use QVariant::canConvert<Type T>() to find the type, and then use QVariant::value<Type T>() to get the value.

Return:

The Color or ColorPaint that is displayed on the FocusHighlightEffect, or an invalid QVariant.

Since:

BlackBerry 10.3.1

Q_SLOT void resetBaseColor ()

Resets the color for this FocusHighlightEffect to an invalid QVariant.

Since:

BlackBerry 10.3.1

Q_SLOT void resetStyle ()

Resets the current style to the default style FocusHighlightEffectStyle::Flat.

Since:

BlackBerry 10.3.1

Q_SLOT void setBaseColor (

Sets the base color for the FocusHighlightEffect.

Parameters
color

The Color or ColorPaint to display on this FocusHighlightEffect.

Since:

BlackBerry 10.3.1

Q_SLOT void setStyle (

Sets the style of the FocusHighlightEffect.

The styleChanged() signal will be emitted if operation was successful.

Parameters
style

The style of the FocusHighlightEffect.

Since:

BlackBerry 10.3.1

bb::cascades::FocusHighlightEffectStyle::Type style ()

Returns the current style of the FocusHighlightEffect.

The default style is FocusHighlightEffectStyle::Flat.

Return:

The style of the FocusHighlightEffect.

Since:

BlackBerry 10.3.1

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

bool isEnabled ()Inherited

Specifies whether the effect is enabled or not.

If the enabled property is set to false, the effect is not rendered. The default enabled value is true.

Since:

BlackBerry 10.3.1

Return:

true if the effect is enabled, false otherwise.

Since:

BlackBerry 10.3.1

Q_SLOT void resetEnabled ()Inherited

Resets the effect to be enabled.

If the enabled property is set to false, the effect is not rendered. The default enabled value is true.

Since:

BlackBerry 10.3.1

Since:

BlackBerry 10.3.1

Q_SLOT void setEnabled (
  • boolenabled)
Inherited

Sets whether the effect should be enabled or not.

If the enabled property is set to false, the effect is not rendered. The default enabled value is true.

Since:

BlackBerry 10.3.1

Parameters
enabled

true to make the effect enabled, false otherwise.

Since:

BlackBerry 10.3.1

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

Static Public Functions

Builder create ()

Creates and returns a builder for constructing an FocusHighlightEffect.

Using the builder to create an FocusHighlightEffect object:
 FocusHighlightEffect* pFocusHighlightEffect = FocusHighlightEffect::create()
Return:

A builder used for constructing an FocusHighlightEffect object.

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

Emitted when the color for this FocusHighlightEffect changes.

Parameters
baseColor

The new base color for this FocusHighlightEffect

Since:

BlackBerry 10.3.1

void styleChanged (

Emitted when the style has changed.

Parameters
newStyle

The new selected style of the FocusHighlightEffect.

Since:

BlackBerry 10.3.1

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 enabledChanged (
  • boolenabled)
Inherited

Emitted when the enabled property of the effect is changed.

If the enabled property is set to false, the effect is not rendered. The default enabled value is true.

Since:

BlackBerry 10.3.1

Parameters
enabled

The new enabled value for the effect.

Since:

BlackBerry 10.3.1

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2015-03-26



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

comments powered by Disqus