Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuickFontLoader Class Reference

#include <qquickfontloader_p.h>

+ Inheritance diagram for QQuickFontLoader:
+ Collaboration diagram for QQuickFontLoader:

Public Types

enum  Status { Null = 0 , Ready , Loading , Error }
 

Signals

void sourceChanged ()
 
void nameChanged ()
 
void fontChanged ()
 
void statusChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickFontLoader (QObject *parent=nullptr)
 \qmltype FontLoader \nativetype QQuickFontLoader \inqmlmodule QtQuick
 
QUrl source () const
 \qmlproperty url QtQuick::FontLoader::source The URL of the font to load.
 
void setSource (const QUrl &url)
 
QString name () const
 \qmlproperty string QtQuick::FontLoader::name \readonly
 
QFont font () const
 \qmlproperty font QtQuick::FontLoader::font
 
Status status () const
 \qmlproperty enumeration QtQuick::FontLoader::status
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Properties

QUrl source
 
QString name
 
Status status
 
QFont font
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 28 of file qquickfontloader_p.h.

Member Enumeration Documentation

◆ Status

Enumerator
Null 
Ready 
Loading 
Error 

Definition at line 41 of file qquickfontloader_p.h.

Constructor & Destructor Documentation

◆ QQuickFontLoader()

QQuickFontLoader::QQuickFontLoader ( QObject * parent = nullptr)

\qmltype FontLoader \nativetype QQuickFontLoader \inqmlmodule QtQuick

Allows fonts to be loaded by URL.

The FontLoader type is used to load fonts by URL.

The \l status indicates when the font has been loaded, which is useful for fonts loaded from remote sources.

For example: \qml import QtQuick 2.0

Column { FontLoader { id: webFont; source: "http://www.mysite.com/myfont.ttf" }

Text { text: "Fancy font"; font: webFont.font } } \endqml

See also
{Qt Quick Examples - Text#Fonts}{Qt Quick Examples - Text Fonts}

Definition at line 165 of file qquickfontloader.cpp.

Member Function Documentation

◆ font()

QFont QQuickFontLoader::font ( ) const

\qmlproperty font QtQuick::FontLoader::font

Since
6.0

This property holds a default query for the loaded font.

You can use this to select the font if other properties than just the family name are needed to disambiguate. You can either specify the font using individual properties:

\qml Item { width: 200; height: 50

FontLoader { id: webFont source: "http://www.mysite.com/myfont.ttf" } Text { text: "Fancy font" font.family: webFont.font.family font.weight: webFont.font.weight font.styleName: webFont.font.styleName font.pixelSize: 24 } } \endqml

Or you can set the full font query directly:

\qml Item { width: 200; height: 50

FontLoader { id: webFont source: "http://www.mysite.com/myfont.ttf" } Text { text: "Fancy font" font: webFont.font } } \endqml

In this case, the default font query will be used with no modifications (so font size, for instance, will be the system default).

Definition at line 324 of file qquickfontloader.cpp.

◆ fontChanged

void QQuickFontLoader::fontChanged ( )
signal

◆ name()

QString QQuickFontLoader::name ( ) const

\qmlproperty string QtQuick::FontLoader::name \readonly

This property holds the name of the font family. It is set automatically when a font is loaded using the \l source property.

This is equivalent to the family property of the FontLoader's \l font property.

Use this to set the font.family property of a Text item.

Example: \qml Item { width: 200; height: 50

FontLoader { id: webFont source: "http://www.mysite.com/myfont.ttf" } Text { text: "Fancy font" font.family: webFont.name } } \endqml

Definition at line 357 of file qquickfontloader.cpp.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

+ Here is the caller graph for this function:

◆ nameChanged

void QQuickFontLoader::nameChanged ( )
signal

◆ setSource()

void QQuickFontLoader::setSource ( const QUrl & url)

Definition at line 181 of file qquickfontloader.cpp.

◆ source()

QUrl QQuickFontLoader::source ( ) const

\qmlproperty url QtQuick::FontLoader::source The URL of the font to load.

Definition at line 175 of file qquickfontloader.cpp.

◆ sourceChanged

void QQuickFontLoader::sourceChanged ( )
signal

◆ status()

QQuickFontLoader::Status QQuickFontLoader::status ( ) const

\qmlproperty enumeration QtQuick::FontLoader::status

This property holds the status of font loading. It can be one of:

\value FontLoader.Null no font has been set \value FontLoader.Ready the font has been loaded \value FontLoader.Loading the font is currently being loaded \value FontLoader.Error an error occurred while loading the font

Use this status to provide an update or respond to the status change in some way. For example, you could:

\list

  • Trigger a state change: \qml State { name: 'loaded'; when: loader.status == FontLoader.Ready } \endqml
  • Implement an onStatusChanged signal handler: \qml FontLoader { id: loader onStatusChanged: if (loader.status == FontLoader.Ready) console.log('Loaded') } \endqml
  • Bind to the status value: \qml Text { text: loader.status == FontLoader.Ready ? 'Loaded' : 'Not loaded' } \endqml \endlist

Definition at line 396 of file qquickfontloader.cpp.

◆ statusChanged

void QQuickFontLoader::statusChanged ( )
signal

Property Documentation

◆ font

QFont QQuickFontLoader::font
read

Definition at line 36 of file qquickfontloader_p.h.

◆ name

QString QQuickFontLoader::name
read

◆ source

QUrl QQuickFontLoader::source
readwrite

Definition at line 33 of file qquickfontloader_p.h.

◆ status

Status QQuickFontLoader::status
read

Definition at line 35 of file qquickfontloader_p.h.


The documentation for this class was generated from the following files: