/usr/include/KF5/KIOFileWidgets/kencodingfiledialog.h is in libkf5kio-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | // -*- c++ -*-
/* This file is part of the KDE libraries
Copyright (C) 2003 Joseph Wenninger <jowenn@kde.org>
2003 Andras Mantia <amantia@freemail.hu>
2013 Teo Mrnjavac <teo@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef __KENCODINGFILEDIALOG_H__
#define __KENCODINGFILEDIALOG_H__
#include "kiofilewidgets_export.h"
#include <QFileDialog>
struct KEncodingFileDialogPrivate;
/**
* @class KEncodingFileDialog kencodingfiledialog.h <KEncodingFileDialog>
*
* Provides a user (and developer) friendly way to select files with support for
* choosing encoding.
* This class comes with a private constructor, the only way to show a file dialog
* is through its static methods.
*/
class KEncodingFileDialog : public QDialog
{
Q_OBJECT
public:
class KIOFILEWIDGETS_EXPORT Result
{
public:
QStringList fileNames;
QList<QUrl> URLs;
QString encoding;
};
/**
* Creates a modal file dialog and return the selected
* filename or an empty string if none was chosen additionally a chosen
* encoding value is returned.
*
* Note that with
* this method the user must select an existing filename.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getOpenFileNameAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
/**
* Creates a modal file dialog and returns the selected encoding and the selected
* filenames or an empty list if none was chosen.
*
* Note that with
* this method the user must select an existing filename.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getOpenFileNamesAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
/**
* Creates a modal file dialog and returns the selected encoding and
* URL or an empty string if none was chosen.
*
* Note that with
* this method the user must select an existing URL.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getOpenUrlAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
/**
* Creates a modal file dialog and returns the selected encoding
* URLs or an empty list if none was chosen.
*
* Note that with
* this method the user must select an existing filename.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getOpenUrlsAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
/**
* Creates a modal file dialog and returns the selected encoding and
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li a relative path or a filename determining the
* directory to start in and the file to be selected.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getSaveFileNameAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
/**
* Creates a modal file dialog and returns the selected encoding and
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param encoding The encoding shown in the encoding combo.
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li a relative path or a filename determining the
* directory to start in and the file to be selected.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*/
static KIOFILEWIDGETS_EXPORT Result getSaveUrlAndEncoding(const QString &encoding = QString(),
const QUrl &startDir = QUrl(),
const QString &filter = QString(),
QWidget *parent = nullptr,
const QString &caption = QString());
QSize sizeHint() const Q_DECL_OVERRIDE;
protected:
void hideEvent(QHideEvent *e) Q_DECL_OVERRIDE;
private Q_SLOTS:
void accept() Q_DECL_OVERRIDE;
void slotOk();
void slotCancel();
private:
/**
* Constructs a file dialog for text files with encoding selection possibility.
*
* @param startDir This can either be
* @li The URL of the directory to start in.
* @li QString() to start in the current working
* directory, or the last directory where a file has been
* selected.
* @li ':<keyword>' to start in the directory last used
* by a filedialog in the same application that specified
* the same keyword.
* @li '::<keyword>' to start in the directory last used
* by a filedialog in any application that specified the
* same keyword.
*
* @param encoding The encoding shown in the encoding combo. If it's
* QString(), the global default encoding will be shown.
*
* @param filter A shell glob or a mime-type-filter that specifies which files to display.
* The preferred option is to set a list of mimetype names, see setMimeFilter() for details.
* Otherwise you can set the text to be displayed for the each glob, and
* provide multiple globs, see setFilter() for details.
*
* @param caption The caption of the dialog
*
* @param type This can either be
* @li QFileDialog::AcceptOpen (open dialog, the default setting)
* @li QFileDialog::AcceptSave
* @param parent The parent widget of this dialog
*/
KEncodingFileDialog(const QUrl &startDir = QUrl(),
const QString &encoding = QString(),
const QString &filter = QString(),
const QString &caption = QString(),
QFileDialog::AcceptMode type = QFileDialog::AcceptOpen,
QWidget *parent = nullptr);
/**
* Destructs the file dialog.
*/
~KEncodingFileDialog();
/**
* @returns The selected encoding if the constructor with the encoding parameter was used, otherwise QString().
*/
QString selectedEncoding() const;
KEncodingFileDialogPrivate *const d;
};
#endif
|