Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
qplatformdialoghelper.cpp
Go to the documentation of this file.
1// Copyright (C) 2018 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
5
6#include <QtCore/QCoreApplication>
7#include <QtCore/QList>
8#if QT_CONFIG(regularexpression)
9#include <QtCore/QRegularExpression>
10#endif
11#if QT_CONFIG(settings)
12#include <QtCore/QSettings>
13#endif
14#include <QtCore/QSharedData>
15#include <QtCore/QUrl>
16#include <QtCore/QVariant>
17#include <QtGui/QColor>
18#include <QtGui/QPixmap>
19
20#include <algorithm>
21
23
24using namespace Qt::StringLiterals;
25
27 QPlatformDialogHelper__StandardButton)
29 QPlatformDialogHelper__ButtonRole)
30
31
53static const int buttonRoleLayouts[2][6][14] =
54{
55 // Qt::Horizontal
56 {
57 // WinLayout
62
63 // MacLayout
69
70 // KdeLayout
74
75 // GnomeLayout
81
82 // AndroidLayout (neutral, stretch, dismissive, affirmative)
83 // https://material.io/guidelines/components/dialogs.html#dialogs-specs
89 },
90
91 // Qt::Vertical
92 {
93 // WinLayout
97
98 // MacLayout
102
103 // KdeLayout
107
108 // GnomeLayout
112
113 // AndroidLayout
114 // (affirmative
115 // dismissive
116 // neutral)
117 // https://material.io/guidelines/components/dialogs.html#dialogs-specs
121 }
122};
123
124
126{
127 qRegisterMetaType<StandardButton>();
128 qRegisterMetaType<ButtonRole>();
129}
130
134
139
145
146// Font dialog
147
149{
150public:
152
153 QFontDialogOptions::FontDialogOptions options;
155};
156
161
165
166namespace {
167 struct FontDialogCombined : QFontDialogOptionsPrivate, QFontDialogOptions
168 {
169 FontDialogCombined() : QFontDialogOptionsPrivate(), QFontDialogOptions(this) {}
170 FontDialogCombined(const FontDialogCombined &other)
172 };
173}
174
175// static
176QSharedPointer<QFontDialogOptions> QFontDialogOptions::create()
177{
179}
180
181QSharedPointer<QFontDialogOptions> QFontDialogOptions::clone() const
182{
183 return QSharedPointer<FontDialogCombined>::create(*static_cast<const FontDialogCombined*>(this));
184}
185
187{
188 return d->windowTitle;
189}
190
195
201
206
207void QFontDialogOptions::setOptions(FontDialogOptions options)
208{
209 if (options != d->options)
210 d->options = options;
211}
212
213QFontDialogOptions::FontDialogOptions QFontDialogOptions::options() const
214{
215 return d->options;
216}
217
227const QSharedPointer<QFontDialogOptions> &QPlatformFontDialogHelper::options() const
228{
229 return m_options;
230}
231
232void QPlatformFontDialogHelper::setOptions(const QSharedPointer<QFontDialogOptions> &options)
233{
234 m_options = options;
235}
236
237// Color dialog
238
240{
241public:
242 enum { CustomColorCount = 16, StandardColorCount = 6 * 8 };
243
245 inline void readSettings();
246 inline void writeSettings() const;
247
251};
252
254{
255 int i = 0;
256 for (int g = 0; g < 4; ++g)
257 for (int r = 0; r < 4; ++r)
258 for (int b = 0; b < 3; ++b)
259 standardRgb[i++] = qRgb(r * 255 / 3, g * 255 / 3, b * 255 / 2);
260 std::fill(customRgb, customRgb + CustomColorCount, 0xffffffff);
261 readSettings();
262}
263
265{
266#if QT_CONFIG(settings)
268 for (int i = 0; i < int(CustomColorCount); ++i) {
269 const QVariant v = settings.value("Qt/customColors/"_L1 + QString::number(i));
270 if (v.isValid())
271 customRgb[i] = v.toUInt();
272 }
273#endif
274}
275
277{
278#if QT_CONFIG(settings)
279 if (customSet) {
280 const_cast<QColorDialogStaticData*>(this)->customSet = false;
282 for (int i = 0; i < int(CustomColorCount); ++i)
283 settings.setValue("Qt/customColors/"_L1 + QString::number(i), customRgb[i]);
284 }
285#endif
286}
287
288Q_GLOBAL_STATIC(QColorDialogStaticData, qColorDialogStaticData)
289
291{
292public:
294 // Write out settings around destruction of dialogs
295 ~QColorDialogOptionsPrivate() { qColorDialogStaticData()->writeSettings(); }
296
297 QColorDialogOptions::ColorDialogOptions options;
299};
300
301QColorDialogOptions::QColorDialogOptions(QColorDialogOptionsPrivate *dd)
302 : d(dd)
303{
304}
305
306QColorDialogOptions::~QColorDialogOptions()
307{
308}
309
310namespace {
311 struct ColorDialogCombined : QColorDialogOptionsPrivate, QColorDialogOptions
312 {
313 ColorDialogCombined() : QColorDialogOptionsPrivate(), QColorDialogOptions(this) {}
314 ColorDialogCombined(const ColorDialogCombined &other)
315 : QColorDialogOptionsPrivate(other), QColorDialogOptions(this) {}
316 };
317}
318
319// static
320QSharedPointer<QColorDialogOptions> QColorDialogOptions::create()
321{
323}
324
325QSharedPointer<QColorDialogOptions> QColorDialogOptions::clone() const
326{
327 return QSharedPointer<ColorDialogCombined>::create(*static_cast<const ColorDialogCombined*>(this));
328}
329
330QString QColorDialogOptions::windowTitle() const
331{
332 return d->windowTitle;
333}
334
335void QColorDialogOptions::setWindowTitle(const QString &title)
336{
337 d->windowTitle = title;
338}
339
340void QColorDialogOptions::setOption(QColorDialogOptions::ColorDialogOption option, bool on)
341{
342 if (!(d->options & option) != !on)
343 setOptions(d->options ^ option);
344}
345
346bool QColorDialogOptions::testOption(QColorDialogOptions::ColorDialogOption option) const
347{
348 return d->options & option;
349}
350
351void QColorDialogOptions::setOptions(ColorDialogOptions options)
352{
353 if (options != d->options)
354 d->options = options;
355}
356
357QColorDialogOptions::ColorDialogOptions QColorDialogOptions::options() const
358{
359 return d->options;
360}
361
362int QColorDialogOptions::customColorCount()
363{
365}
366
367QRgb QColorDialogOptions::customColor(int index)
368{
370 return qRgb(255, 255, 255);
371 return qColorDialogStaticData()->customRgb[index];
372}
373
374QRgb *QColorDialogOptions::customColors()
375{
376 return qColorDialogStaticData()->customRgb;
377}
378
379void QColorDialogOptions::setCustomColor(int index, QRgb color)
380{
382 return;
383 qColorDialogStaticData()->customSet = true;
384 qColorDialogStaticData()->customRgb[index] = color;
385}
386
387QRgb *QColorDialogOptions::standardColors()
388{
389 return qColorDialogStaticData()->standardRgb;
390}
391
392QRgb QColorDialogOptions::standardColor(int index)
393{
395 return qRgb(255, 255, 255);
396 return qColorDialogStaticData()->standardRgb[index];
397}
398
399void QColorDialogOptions::setStandardColor(int index, QRgb color)
400{
402 return;
403 qColorDialogStaticData()->standardRgb[index] = color;
404}
405
415const QSharedPointer<QColorDialogOptions> &QPlatformColorDialogHelper::options() const
416{
417 return m_options;
418}
419
420void QPlatformColorDialogHelper::setOptions(const QSharedPointer<QColorDialogOptions> &options)
421{
422 m_options = options;
423}
424
425// File dialog
426
450
455
459
460namespace {
461 struct FileDialogCombined : QFileDialogOptionsPrivate, QFileDialogOptions
462 {
463 FileDialogCombined() : QFileDialogOptionsPrivate(), QFileDialogOptions(this) {}
464 FileDialogCombined(const FileDialogCombined &other) : QFileDialogOptionsPrivate(other), QFileDialogOptions(this) {}
465 };
466}
467
468// static
469QSharedPointer<QFileDialogOptions> QFileDialogOptions::create()
470{
472}
473
474QSharedPointer<QFileDialogOptions> QFileDialogOptions::clone() const
475{
476 return QSharedPointer<FileDialogCombined>::create(*static_cast<const FileDialogCombined*>(this));
477}
478
480{
481 return d->windowTitle;
482}
483
488
494
499
500void QFileDialogOptions::setOptions(FileDialogOptions options)
501{
502 if (options != d->options)
503 d->options = options;
504}
505
506QFileDialogOptions::FileDialogOptions QFileDialogOptions::options() const
507{
508 return d->options;
509}
510
511QDir::Filters QFileDialogOptions::filter() const
512{
513 return d->filters;
514}
515
517{
518 d->filters = filters;
519}
520
525
530
535
540
545
550
551void QFileDialogOptions::setSidebarUrls(const QList<QUrl> &urls)
552{
553 d->sidebarUrls = urls;
554}
555
557{
558 return d->sidebarUrls;
559}
560
574
579
586
592
601{
602 return QCoreApplication::translate("QFileDialog", "All Files (*)");
603}
604
609
614
616{
617 d->defaultSuffix = suffix;
618 if (d->defaultSuffix.size() > 1 && d->defaultSuffix.startsWith(u'.'))
619 d->defaultSuffix.remove(0, 1); // Silently change ".txt" -> "txt".
620}
621
626
631
633{
634 return d->history;
635}
636
642
647
649{
650 return unsigned(label) < unsigned(DialogLabelCount) && !d->labels[label].isEmpty();
651}
652
657
662
667
672
677
682
684{
685 return d->initiallySelectedFiles;
686}
687
692
693// Schemes supported by the application
695{
696 d->supportedSchemes = schemes;
697}
698
703
708
713
714// Return true if the URL is supported by the filedialog implementation *and* by the application.
716{
717 return url.isLocalFile();
718}
719
729const QSharedPointer<QFileDialogOptions> &QPlatformFileDialogHelper::options() const
730{
731 return m_options;
732}
733
734void QPlatformFileDialogHelper::setOptions(const QSharedPointer<QFileDialogOptions> &options)
735{
736 m_options = options;
737}
738
740"^(.*)\\(([a-zA-Z0-9_.,*? +;#\\-\\[\\]@\\{\\}/!<>\\$%&=^~:\\|]*)\\)$";
741
742// Makes a list of filters from a normal filter string "Image Files (*.png *.jpg)"
744{
745#if QT_CONFIG(regularexpression)
747 Q_ASSERT(regexp.isValid());
748 QString f = filter;
749 QRegularExpressionMatch match = regexp.match(filter);
750 if (match.hasMatch())
751 f = match.captured(2);
752 return f.split(u' ', Qt::SkipEmptyParts);
753#else
755 return QStringList();
756#endif
757}
758
759// Message dialog
760
785
790
794
795namespace {
796 struct MessageDialogCombined : QMessageDialogOptionsPrivate, QMessageDialogOptions
797 {
798 MessageDialogCombined() : QMessageDialogOptionsPrivate(), QMessageDialogOptions(this) {}
799 MessageDialogCombined(const MessageDialogCombined &other)
801 };
802}
803
804// static
805QSharedPointer<QMessageDialogOptions> QMessageDialogOptions::create()
806{
808}
809
810QSharedPointer<QMessageDialogOptions> QMessageDialogOptions::clone() const
811{
812 return QSharedPointer<MessageDialogCombined>::create(*static_cast<const MessageDialogCombined*>(this));
813}
814
819
824
829
834
839
841{
842 return d->iconPixmap;
843}
844
846{
847 return d->text;
848}
849
851{
852 d->text = text;
853}
854
859
864
869
871{
873}
874
875void QMessageDialogOptions::setStandardButtons(QPlatformDialogHelper::StandardButtons buttons)
876{
877 d->buttons = buttons;
878}
879
880QPlatformDialogHelper::StandardButtons QMessageDialogOptions::standardButtons() const
881{
882 return d->buttons;
883}
884
886 void *buttonImpl, int buttonId)
887{
888 const CustomButton b(buttonId ? buttonId : d->nextCustomButtonId++, label, role, buttonImpl);
890 return b.id;
891}
892
895 return a.id == b.id;
896}
897
902
903const QList<QMessageDialogOptions::CustomButton> &QMessageDialogOptions::customButtons()
904{
905 return d->customButtons;
906}
907
912
914{
915 const int i = int(d->customButtons.indexOf(CustomButton(id)));
916 return (i < 0 ? nullptr : &d->customButtons.at(i));
917}
918
924
929
934
939
941{
942 return d->defaultButtonId;
943}
944
949
951{
952 return d->escapeButtonId;
953}
954
960
965
966void QMessageDialogOptions::setOptions(QMessageDialogOptions::Options options)
967{
968 if (options != d->options)
969 d->options = options;
970}
971
972QMessageDialogOptions::Options QMessageDialogOptions::options() const
973{
974 return d->options;
975}
976
977
979{
980 switch (button) {
981 case Ok:
982 case Save:
983 case Open:
984 case SaveAll:
985 case Retry:
986 case Ignore:
987 return AcceptRole;
988
989 case Cancel:
990 case Close:
991 case Abort:
992 return RejectRole;
993
994 case Discard:
995 return DestructiveRole;
996
997 case Help:
998 return HelpRole;
999
1000 case Apply:
1001 return ApplyRole;
1002
1003 case Yes:
1004 case YesToAll:
1005 return YesRole;
1006
1007 case No:
1008 case NoToAll:
1009 return NoRole;
1010
1011 case RestoreDefaults:
1012 case Reset:
1013 return ResetRole;
1014
1015 default:
1016 break;
1017 }
1018 return InvalidRole;
1019}
1020
1022{
1023 if (policy == UnknownLayout) {
1024#if defined (Q_OS_MACOS)
1025 policy = MacLayout;
1026#elif defined (Q_OS_LINUX) || defined (Q_OS_UNIX)
1027 policy = KdeLayout;
1028#elif defined (Q_OS_ANDROID)
1030#else
1031 policy = WinLayout;
1032#endif
1033 }
1034 return buttonRoleLayouts[orientation == Qt::Vertical][policy];
1035}
1036
1046const QSharedPointer<QMessageDialogOptions> &QPlatformMessageDialogHelper::options() const
1047{
1048 return m_options;
1049}
1050
1051void QPlatformMessageDialogHelper::setOptions(const QSharedPointer<QMessageDialogOptions> &options)
1052{
1053 m_options = options;
1054}
1055
1057
1058#include "moc_qplatformdialoghelper.cpp"
QColorDialogOptionsPrivate()=default
QColorDialogOptions::ColorDialogOptions options
QRgb standardRgb[StandardColorCount]
QRgb customRgb[CustomColorCount]
static QString translate(const char *context, const char *key, const char *disambiguation=nullptr, int n=-1)
\threadsafe
@ AllEntries
Definition qdir.h:26
@ AllDirs
Definition qdir.h:40
@ NoDotAndDotDot
Definition qdir.h:44
QFileDialogOptions::FileDialogOptions options
QString labels[QFileDialogOptions::DialogLabelCount]
QFileDialogOptions::ViewMode viewMode
QFileDialogOptions::AcceptMode acceptMode
QFileDialogOptions::FileMode fileMode
QStringList mimeTypeFilters() const
QList< QUrl > initiallySelectedFiles() const
void setHistory(const QStringList &paths)
bool isLabelExplicitlySet(DialogLabel label)
void setSupportedSchemes(const QStringList &schemes)
QDir::Filters filter() const
QSharedPointer< QFileDialogOptions > clone() const
QString initiallySelectedNameFilter() const
void setWindowTitle(const QString &)
QString labelText(DialogLabel label) const
void setNameFilters(const QStringList &filters)
void setOptions(FileDialogOptions options)
QStringList supportedSchemes() const
AcceptMode acceptMode() const
void setInitiallySelectedNameFilter(const QString &)
void setInitiallySelectedMimeTypeFilter(const QString &)
QList< QUrl > sidebarUrls() const
void setViewMode(ViewMode mode)
void setMimeTypeFilters(const QStringList &filters)
QStringList nameFilters() const
FileDialogOptions options() const
void setLabelText(DialogLabel label, const QString &text)
QStringList history() const
static QSharedPointer< QFileDialogOptions > create()
void setFileMode(FileMode mode)
void setOption(FileDialogOption option, bool on=true)
QFileDialogOptions(QFileDialogOptionsPrivate *dd)
QString initiallySelectedMimeTypeFilter() const
void setAcceptMode(AcceptMode mode)
void setSidebarUrls(const QList< QUrl > &urls)
void setInitialDirectory(const QUrl &)
void setFilter(QDir::Filters filters)
bool testOption(FileDialogOption option) const
static QString defaultNameFilterString()
void setDefaultSuffix(const QString &suffix)
void setInitiallySelectedFiles(const QList< QUrl > &)
QFontDialogOptions::FontDialogOptions options
QFontDialogOptionsPrivate()=default
void setOptions(FontDialogOptions options)
QFontDialogOptions(QFontDialogOptionsPrivate *dd)
QSharedPointer< QFontDialogOptions > clone() const
void setWindowTitle(const QString &)
bool testOption(FontDialogOption option) const
static QSharedPointer< QFontDialogOptions > create()
FontDialogOptions options() const
void setOption(FontDialogOption option, bool on=true)
bool removeOne(const AT &t)
Definition qlist.h:598
void append(parameter_type t)
Definition qlist.h:458
void clear()
Definition qlist.h:434
QList< QMessageDialogOptions::CustomButton > customButtons
QPlatformDialogHelper::StandardButtons buttons
QMessageDialogOptions::StandardIcon icon
QMessageDialogOptions::Options options
StandardIcon standardIcon() const
bool testOption(Option option) const
void setWindowTitle(const QString &)
void setOptions(Options options)
static QSharedPointer< QMessageDialogOptions > create()
void setInformativeText(const QString &text)
Qt::CheckState checkBoxState() const
void setDetailedText(const QString &text)
void setText(const QString &text)
int addButton(const QString &label, QPlatformDialogHelper::ButtonRole role, void *buttonImpl=nullptr, int buttonId=0)
void setStandardButtons(QPlatformDialogHelper::StandardButtons buttons)
const CustomButton * customButton(int id)
const QList< CustomButton > & customButtons()
void setCheckBox(const QString &label, Qt::CheckState state)
QPlatformDialogHelper::StandardButtons standardButtons() const
QMessageDialogOptions(QMessageDialogOptionsPrivate *dd)
void setOption(Option option, bool on=true)
QSharedPointer< QMessageDialogOptions > clone() const
void setStandardIcon(StandardIcon icon)
void setIconPixmap(const QPixmap &pixmap)
Returns a copy of the pixmap that is transformed using the given transformation transform and transfo...
Definition qpixmap.h:27
const QSharedPointer< QColorDialogOptions > & options() const
void setOptions(const QSharedPointer< QColorDialogOptions > &options)
The QPlatformDialogHelper class allows for platform-specific customization of dialogs.
static QVariant defaultStyleHint(QPlatformDialogHelper::StyleHint hint)
StyleHint
This enum type specifies platform-specific style hints.
static const int * buttonLayout(Qt::Orientation orientation=Qt::Horizontal, ButtonLayout policy=UnknownLayout)
static ButtonRole buttonRole(StandardButton button)
virtual QVariant styleHint(StyleHint hint) const
void setOptions(const QSharedPointer< QFileDialogOptions > &options)
virtual bool isSupportedUrl(const QUrl &url) const
static QStringList cleanFilterList(const QString &filter)
virtual void selectMimeTypeFilter(const QString &filter)
const QSharedPointer< QFileDialogOptions > & options() const
virtual QString selectedMimeTypeFilter() const
void setOptions(const QSharedPointer< QFontDialogOptions > &options)
const QSharedPointer< QFontDialogOptions > & options() const
void setOptions(const QSharedPointer< QMessageDialogOptions > &options)
const QSharedPointer< QMessageDialogOptions > & options() const
\inmodule QtCore \reentrant
\inmodule QtCore \reentrant
\inmodule QtCore
Definition qsettings.h:30
void setValue(QAnyStringView key, const QVariant &value)
Sets the value of setting key to value.
QVariant value(QAnyStringView key, const QVariant &defaultValue) const
Returns the value for setting key.
\inmodule QtCore
Definition qshareddata.h:19
static QSharedPointer create(Args &&...arguments)
This is an overloaded member function, provided for convenience. It differs from the above function o...
\inmodule QtCore
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129
bool startsWith(const QString &s, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
Returns true if the string starts with s; otherwise returns false.
Definition qstring.cpp:5455
static QString fromLatin1(QByteArrayView ba)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition qstring.cpp:5871
bool isEmpty() const noexcept
Returns true if the string has no characters; otherwise returns false.
Definition qstring.h:192
qsizetype size() const noexcept
Returns the number of characters in this string.
Definition qstring.h:186
static QString number(int, int base=10)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition qstring.cpp:8084
QString & remove(qsizetype i, qsizetype len)
Removes n characters from the string, starting at the given position index, and returns a reference t...
Definition qstring.cpp:3466
\inmodule QtCore
Definition qurl.h:94
bool isLocalFile() const
Definition qurl.cpp:3445
\inmodule QtCore
Definition qvariant.h:65
uint toUInt(bool *ok=nullptr) const
Returns the variant as an unsigned int if the variant has userType() \l QMetaType::UInt,...
#define this
Definition dialogs.cpp:9
QString text
QPushButton * button
[2]
else opt state
[0]
Combined button and popup list for selecting options.
CheckState
@ Unchecked
Orientation
Definition qnamespace.h:98
@ Vertical
Definition qnamespace.h:100
@ SkipEmptyParts
Definition qnamespace.h:128
@ Ok
Definition qbezier.cpp:173
SharedPointerFileDialogOptions m_options
QList< QString > QStringList
Constructs a string list that contains the given string, str.
#define Q_GLOBAL_STATIC(TYPE, NAME,...)
#define QT_IMPL_METATYPE_EXTERN_TAGGED(TYPE, TAG)
Definition qmetatype.h:1384
GLboolean GLboolean GLboolean b
GLsizei const GLfloat * v
[13]
GLenum mode
GLboolean GLboolean GLboolean GLboolean a
[7]
GLuint index
[2]
GLboolean r
[2]
GLenum GLuint id
[7]
GLfloat GLfloat f
GLuint color
[2]
GLsizei const GLuint * paths
GLuint GLsizei const GLchar * label
[43]
GLint GLint GLint GLint GLint GLint GLint GLbitfield GLenum filter
GLboolean GLboolean g
GLuint GLenum option
static bool operator==(const QMessageDialogOptions::CustomButton &a, const QMessageDialogOptions::CustomButton &b)
#define Q_ASSERT(cond)
Definition qrandom.cpp:47
QT_BEGIN_NAMESPACE typedef unsigned int QRgb
Definition qrgb.h:13
constexpr QRgb qRgb(int r, int g, int b)
Definition qrgb.h:30
#define QStringLiteral(str)
static QT_BEGIN_NAMESPACE QVariant hint(QPlatformIntegration::StyleHint h)
#define Q_UNUSED(x)
static bool match(const uchar *found, uint foundLen, const char *target, uint targetLen)
unsigned int uint
Definition qtypes.h:34
QSettings settings("MySoft", "Star Runner")
[0]
QUrl url("example.com")
[constructor-url-reference]
QString title
[35]
QSharedPointer< T > other(t)
[5]
QStringList files
[8]
const QStringList filters({"Image files (*.png *.xpm *.jpg)", "Text files (*.txt)", "Any files (*)" })
[6]
widget render & pixmap
QSizePolicy policy
qsizetype indexOf(const AT &t, qsizetype from=0) const noexcept
Definition qlist.h:962