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
QQuickFontDialog Class Reference

#include <qquickfontdialog_p.h>

Inheritance diagram for QQuickFontDialog:
Collaboration diagram for QQuickFontDialog:

Signals

void selectedFontChanged ()
void currentFontChanged ()
void optionsChanged ()
Signals inherited from QQuickAbstractDialog
void accepted ()
void rejected ()
void parentWindowChanged ()
void titleChanged ()
void flagsChanged ()
void modalityChanged ()
void visibleChanged ()
void resultChanged ()
 Q_REVISION (6, 10) void popupTypeChanged()
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

 QQuickFontDialog (QObject *parent=nullptr)
 A font dialog.
void setCurrentFont (const QFont &font)
QFont currentFont () const
 \qmlproperty font QtQuick.Dialogs::FontDialog::currentFont
void setSelectedFont (const QFont &font)
QFont selectedFont () const
 \qmlproperty font QtQuick.Dialogs::FontDialog::selectedFont
QFontDialogOptions::FontDialogOptions options () const
 \qmlproperty flags QtQuick.Dialogs::FontDialog::options
void setOptions (QFontDialogOptions::FontDialogOptions options)
void resetOptions ()
Public Member Functions inherited from QQuickAbstractDialog
 QQuickAbstractDialog (QQuickDialogType type, QObject *parent=nullptr)
 The base class of native dialogs.
 ~QQuickAbstractDialog ()
QPlatformDialogHelperhandle () const
QQmlListProperty< QObjectdata ()
QWindowparentWindow () const
 \qmlproperty Window QtQuick.Dialogs::Dialog::parentWindow
void setParentWindow (QWindow *window)
void resetParentWindow ()
QString title () const
 \qmlproperty string QtQuick.Dialogs::Dialog::title
void setTitle (const QString &title)
Qt::WindowFlags flags () const
 \qmlproperty Qt::WindowFlags QtQuick.Dialogs::Dialog::flags
void setFlags (Qt::WindowFlags flags)
Qt::WindowModality modality () const
 \qmlproperty Qt::WindowModality QtQuick.Dialogs::Dialog::modality
void setModality (Qt::WindowModality modality)
bool isVisible () const
 \qmlproperty bool QtQuick.Dialogs::Dialog::visible
void setVisible (bool visible)
int result () const
 \qmlproperty int QtQuick.Dialogs::Dialog::result
void setResult (int result)
QQuickPopup::PopupType popupType () const
 \qmlproperty enumeration QtQuick.Dialogs::Dialog::popupType
void setPopupType (QQuickPopup::PopupType popupType)
void resetPopupType ()
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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.
Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Protected Member Functions

bool useNativeDialog () const override
void onCreate (QPlatformDialogHelper *dialog) override
void onShow (QPlatformDialogHelper *dialog) override
Protected Member Functions inherited from QQuickAbstractDialog
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
bool create (CreateOptions=CreateOptions::TryAllDialogTypes)
void destroy ()
virtual void onHide (QPlatformDialogHelper *dialog)
virtual int dialogCode () const
QQuickItemfindParentItem () const
QWindowwindowForOpen () const
void deferredOpen (QWindow *window)
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)

Properties

QFont selectedFont
QFont currentFont
QFontDialogOptions::FontDialogOptions options
Properties inherited from QQuickAbstractDialog
QQmlListProperty< QObjectdata
 \qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data
QWindowparentWindow
QString title
Qt::WindowFlags flags
Qt::WindowModality modality
QQuickPopup::PopupType popupType
bool visible
int result
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Types inherited from QQuickAbstractDialog
enum  StandardCode { Rejected , Accepted }
Public Slots inherited from QQuickAbstractDialog
void open ()
 \qmlmethod void QtQuick.Dialogs::Dialog::open()
void close ()
 \qmlmethod void QtQuick.Dialogs::Dialog::close()
virtual void accept ()
 \qmlmethod void QtQuick.Dialogs::Dialog::accept()
virtual void reject ()
 \qmlmethod void QtQuick.Dialogs::Dialog::reject()
virtual void done (int result)
 \qmlmethod void QtQuick.Dialogs::Dialog::done(int result)
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 Types inherited from QQuickAbstractDialog
enum class  CreateOptions { TryAllDialogTypes = 0 , DontTryNativeDialog = 1 }
Protected Attributes inherited from QQuickAbstractDialog
int m_result = Rejected
QWindowm_parentWindow = nullptr
QString m_title
Qt::WindowFlags m_flags = Qt::Dialog
Qt::WindowModality m_modality = Qt::WindowModal
QQuickDialogType m_type = QQuickDialogType::FileDialog
QList< QObject * > m_data
std::unique_ptr< QPlatformDialogHelperm_handle
QQuickPopup::PopupType m_popupType = QQuickPopup::Window
bool m_visibleRequested = false
bool m_visible = false
bool m_complete = false
bool m_parentWindowExplicitlySet = false
bool m_firstShow = true
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 25 of file qquickfontdialog_p.h.

Constructor & Destructor Documentation

◆ QQuickFontDialog()

QT_BEGIN_NAMESPACE QQuickFontDialog::QQuickFontDialog ( QObject * parent = nullptr)
explicit

A font dialog.

\qmltype FontDialog
\inherits Dialog

! \nativetype QQuickFontDialog \inqmlmodule QtQuick.Dialogs

Since
6.2

The FontDialog type provides a QML API for font dialogs.

{The user is able to view and select different fonts via the font dialog}

To show a font dialog, construct an instance of FontDialog, set the desired properties, and call \l {Dialog::}{open()}. The \l currentFont property can be used to determine the currently selected font in the dialog. The \l selectedFont property is updated only after the final selection has been made by accepting the dialog.

MenuItem {
text: "Font"
onTriggered: fontDialog.open()
}
id: fontDialog
currentFont.family: document.font
}
MyDocument {
font: fontDialog.selectedFont
}
QString family() const
Returns the requested font family name.
Definition qfont.cpp:818
emscripten::val document()
Definition qwasmdom.h:49
GLenum GLuint id

Definition at line 65 of file qquickfontdialog.cpp.

Member Function Documentation

◆ currentFont()

QFont QQuickFontDialog::currentFont ( ) const

\qmlproperty font QtQuick.Dialogs::FontDialog::currentFont

Deprecated
[6.3] Use \l selectedFont instead.

This property holds the currently selected font in the dialog.

The currentFont property is updated while the user is selecting fonts in the dialog, even before the final selection has been made.

See also
selectedFont
Deprecated
[6.3] Use \l selectedFont instead.

This property holds the currently selected font in the dialog.

The currentFont property is updated while the user is selecting fonts in the dialog, even before the final selection has been made.

See also
selectedFont

Definition at line 83 of file qquickfontdialog.cpp.

◆ currentFontChanged

void QQuickFontDialog::currentFontChanged ( )
signal

◆ onCreate()

void QQuickFontDialog::onCreate ( QPlatformDialogHelper * dialog)
overrideprotectedvirtual

Called at the end of \l create().

Reimplemented from QQuickAbstractDialog.

Definition at line 173 of file qquickfontdialog.cpp.

◆ onShow()

void QQuickFontDialog::onShow ( QPlatformDialogHelper * dialog)
overrideprotectedvirtual

Called by \l open(), after the call to \l create() and before the handle/helper's show function is called.

Reimplemented from QQuickAbstractDialog.

Definition at line 184 of file qquickfontdialog.cpp.

◆ options()

QFontDialogOptions::FontDialogOptions QQuickFontDialog::options ( ) const

\qmlproperty flags QtQuick.Dialogs::FontDialog::options

This property holds the various options that affect the look and feel of the dialog.

By default, no options are set, meaning all font types are shown and the dialog displays standard \uicontrol Select and \uicontrol Cancel buttons.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Available options: \value FontDialog.ScalableFonts Show scalable fonts. \value FontDialog.NonScalableFonts Show non-scalable fonts. \value FontDialog.MonospacedFonts Show monospaced fonts. \value FontDialog.ProportionalFonts Show proportional fonts. \value FontDialog.NoButtons Don't display \uicontrol Open and \uicontrol Cancel buttons (useful for "live dialogs"). \value FontDialog.DontUseNativeDialog Forces the dialog to use a non-native quick implementation.

Definition at line 148 of file qquickfontdialog.cpp.

Referenced by testing.tools.test_runner._TestCaseRunner::_NewImageArtifact(), testing.tools.test_runner._TestCaseRunner::_RegenerateIfNeeded(), testing.tools.test_runner.TestRunner::IsSkiaGoldEnabled(), testing.tools.test_runner._TestCaseRunner::TestPixel(), and testing.tools.test_runner._TestCaseRunner::TestText().

Here is the caller graph for this function:

◆ optionsChanged

void QQuickFontDialog::optionsChanged ( )
signal

◆ resetOptions()

void QQuickFontDialog::resetOptions ( )

Definition at line 162 of file qquickfontdialog.cpp.

◆ selectedFont()

QFont QQuickFontDialog::selectedFont ( ) const

\qmlproperty font QtQuick.Dialogs::FontDialog::selectedFont

This property holds the currently selected font in the dialog.

The selectedFont property is updated while the user is selecting fonts in the dialog, even before the final selection has been made.

The \l {Dialog::}{accepted()} signal can be handled to get the final selection. When the user has clicked \uicontrol Select (or \uicontrol Open, depending on platform) to accept a font, a signal handler for the \l {Dialog::}{accepted()} signal can query the selectedFont property to get the final font that was selected by the user.

See also
currentFont, {Dialog::}{accepted()}

Definition at line 110 of file qquickfontdialog.cpp.

◆ selectedFontChanged

void QQuickFontDialog::selectedFontChanged ( )
signal

◆ setCurrentFont()

void QQuickFontDialog::setCurrentFont ( const QFont & font)

Definition at line 88 of file qquickfontdialog.cpp.

◆ setOptions()

void QQuickFontDialog::setOptions ( QFontDialogOptions::FontDialogOptions options)

Definition at line 153 of file qquickfontdialog.cpp.

◆ setSelectedFont()

void QQuickFontDialog::setSelectedFont ( const QFont & font)

Definition at line 115 of file qquickfontdialog.cpp.

◆ useNativeDialog()

bool QQuickFontDialog::useNativeDialog ( ) const
overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 167 of file qquickfontdialog.cpp.

Property Documentation

◆ currentFont

QFont QQuickFontDialog::currentFont
readwrite

Definition at line 29 of file qquickfontdialog_p.h.

◆ options

◆ selectedFont

QFont QQuickFontDialog::selectedFont
readwrite

Definition at line 28 of file qquickfontdialog_p.h.


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