/usr/include/kfiledialog.h is in kdelibs5-dev 4:4.13.3-0ubuntu0.5.
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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 | // -*- c++ -*-
/* This file is part of the KDE libraries
Copyright (C) 1997, 1998 Richard Moore <rich@kde.org>
1998 Stephan Kulow <coolo@kde.org>
1998 Daniel Grana <grana@ie.iwi.unibe.ch>
2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
2001 Frerich Raabe <raabe@kde.org>
2007 David Faure <faure@kde.org>
2009 David Jarvie <djarvie@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 KFILEDIALOG_H
#define KFILEDIALOG_H
#include <kdialog.h>
#include <kfile.h>
#include <kurl.h>
#include <kmimetype.h>
class KAbstractFileWidget;
class KFileWidget;
class KActionCollection;
class KUrlComboBox;
class KFileFilterCombo;
class KPushButton;
class KToolBar;
class KPreviewWidgetBase;
class KFileDialogPrivate;
/**
* Provides a user (and developer) friendly way to
* select files and directories.
*
* The widget can be used as a drop in replacement for the
* QFileDialog widget, but has greater functionality and a nicer GUI.
*
* You will usually want to use one of the static methods
* getOpenFileName(), getSaveFileName(), getOpenUrl()
* or for multiple files getOpenFileNames() or getOpenUrls().
*
* The dialog has been designed to allow applications to customize it
* by subclassing. It uses geometry management to ensure that subclasses
* can easily add children that will be incorporated into the layout.
*
* \image html kfiledialog.png "KDE File Dialog"
*
* @short A file selection dialog.
*
* @author Richard J. Moore <rich@kde.org>, Carsten Pfeiffer <pfeiffer@kde.org>
*/
class KIO_EXPORT KFileDialog : public KDialog
{
Q_OBJECT
public:
/**
* Defines some default behavior of the filedialog.
* E.g. in mode @p Opening and @p Saving, the selected files/urls will
* be added to the "recent documents" list. The Saving mode also implies
* setKeepLocation() being set.
*
* @p Other means that no default actions are performed.
*
* @see setOperationMode
* @see operationMode
*/
enum OperationMode { Other = 0, Opening, Saving };
/**
* Defines the options to use when calling getSave* functions.
* @since 4.4
*/
enum Option {
ConfirmOverwrite = 0x01, /**< Confirm whether to overwrite file to save. */
ShowInlinePreview = 0x02 /**< Always show an inline preview. */
};
Q_DECLARE_FLAGS(Options, Option)
/**
* Constructs a file dialog.
*
* @param startDir Specifies the starting directory and/or initially selected
* file name, or a last used directory and optional file name
* using the @c kfiledialog:/// syntax.
* Refer to the KFileWidget documentation for more information
* on this parameter.
*
* @param filter A shell glob or a mimetype filter that specifies
* which files to display. For better consistency across applications,
* it is recommended to use a mimetype filter.
* See setFilter() and setMimeFilter() for details on how to use this argument.
*
* @param parent The parent widget of this dialog
*
* @param widget A widget, or a widget of widgets, for displaying custom
* data in the dialog. This can be used, for example, to
* display a check box with the caption "Open as read-only".
* When creating this widget, you don't need to specify a parent,
* since the widget's parent will be set automatically by KFileDialog.
*
* @see KFileWidget::KFileWidget()
*/
KFileDialog( const KUrl& startDir, const QString& filter,
QWidget *parent, QWidget* widget = 0 );
/**
* Destructs the file dialog.
*/
~KFileDialog();
/**
* @returns The selected fully qualified filename.
*/
KUrl selectedUrl() const;
/**
* @returns The list of selected URLs.
*/
KUrl::List selectedUrls() const;
/**
* @returns the currently shown directory.
*/
KUrl baseUrl() const;
/**
* Returns the full path of the selected file in the local filesystem.
* (Local files only)
*/
QString selectedFile() const;
/**
* Returns a list of all selected local files.
*/
QStringList selectedFiles() const;
/**
* Sets the directory to view.
*
* @param url URL to show.
* @param clearforward Indicates whether the forward queue
* should be cleared.
*/
void setUrl(const KUrl &url, bool clearforward = true);
/**
* Sets the file name to preselect to @p name
*
* This takes absolute URLs and relative file names.
*/
void setSelection(const QString& name);
/**
* Sets the operational mode of the filedialog to @p Saving, @p Opening
* or @p Other. This will set some flags that are specific to loading
* or saving files. E.g. setKeepLocation() makes mostly sense for
* a save-as dialog. So setOperationMode( KFileDialog::Saving ); sets
* setKeepLocation for example.
*
* The mode @p Saving, together with a default filter set via
* setMimeFilter() will make the filter combobox read-only.
*
* The default mode is @p Opening.
*
* Call this method right after instantiating KFileDialog.
*
* @see operationMode
* @see KFileDialog::OperationMode
*/
void setOperationMode( KFileDialog::OperationMode );
/**
* @returns the current operation mode, Opening, Saving or Other. Default
* is Other.
*
* @see operationMode
* @see KFileDialog::OperationMode
*/
OperationMode operationMode() const;
/**
* Sets whether the filename/url should be kept when changing directories.
* This is for example useful when having a predefined filename where
* the full path for that file is searched.
*
* This is implicitly set when operationMode() is KFileDialog::Saving
*
* getSaveFileName() and getSaveUrl() set this to true by default, so that
* you can type in the filename and change the directory without having
* to type the name again.
*/
void setKeepLocation( bool keep );
/**
* @returns whether the contents of the location edit are kept when
* changing directories.
*/
bool keepsLocation() const;
/**
* Sets the filter to be used to @p filter.
*
* The filter can be either set as a space-separated list of
* mimetypes, which is recommended, or as a list of shell globs
* separated by @c '\\n'.
*
* If the filter contains an unescaped @c '/', a mimetype filter is assumed.
* If you would like a @c '/' visible in your filter it can be escaped with
* a @c '\'. You can specify multiple mimetypes like this (separated with
* space):
*
* \code
* kfile->setFilter( "image/png text/html text/plain" );
* \endcode
*
* When showing the filter to the user, the mimetypes will be automatically
* translated into their description like `PNG image'. Multiple mimetypes
* will be automatically summarized to a filter item `All supported files'.
* To add a filter item for all files matching @c '*', add @c all/allfiles
* as mimetype.
*
* If the filter contains no unescaped @c '/', it is assumed that
* the filter contains conventional shell globs. Several filter items
* to select from can be separated by @c '\\n'. Every
* filter entry is defined through @c namefilter|text to display.
* If no @c '|' is found in the expression, just the namefilter is
* shown. Examples:
*
* \code
* kfile->setFilter("*.cpp|C++ Source Files\n*.h|Header files");
* kfile->setFilter("*.cpp");
* kfile->setFilter("*.cpp|Sources (*.cpp)");
* kfile->setFilter("*.cpp|" + i18n("Sources (*.cpp)"));
* kfile->setFilter("*.cpp *.cc *.C|C++ Source Files\n*.h *.H|Header files");
* \endcode
*
* Note: The text to display is not parsed in any way. So, if you
* want to show the suffix to select by a specific filter, you must
* repeat it.
*
* For better consistency across applications, it is recommended to use a
* mimetype filter.
*
* @see filterChanged
* @see setMimeFilter
*/
void setFilter(const QString& filter);
/**
* Returns the current filter as entered by the user or one of the
* predefined set via setFilter().
*
* @see setFilter()
* @see filterChanged()
*/
QString currentFilter() const;
/**
* Returns the mimetype for the desired output format.
*
* This is only valid if setMimeFilter() has been called
* previously.
*
* @see setFilterMimeType()
*/
KMimeType::Ptr currentFilterMimeType();
/**
* Sets the filter up to specify the output type.
*
* @param types a list of mimetypes that can be used as output format
* @param defaultType the default mimetype to use as output format, if any.
* If @p defaultType is set, it will be set as the current item.
* Otherwise, a first item showing all the mimetypes will be created.
* Typically, @p defaultType should be empty for loading and set for saving.
*
* Do not use in conjunction with setFilter()
*/
void setMimeFilter( const QStringList& types,
const QString& defaultType = QString() );
/**
* The mimetype for the desired output format.
*
* This is only valid if setMimeFilter() has been called
* previously.
*
* @see setMimeFilter()
*/
QString currentMimeFilter() const;
/**
* Clears any mime- or namefilter. Does not reload the directory.
*/
void clearFilter();
/**
* Adds a preview widget and enters the preview mode.
*
* In this mode the dialog is split and the right part contains your
* preview widget.
*
* Ownership is transferred to KFileDialog. You need to create the
* preview-widget with "new", i.e. on the heap.
*
* @param w The widget to be used for the preview.
*/
void setPreviewWidget(KPreviewWidgetBase *w);
/**
* Forces the inline previews to be shown or hidden, depending on @p show.
*
* @param show Whether to show inline previews or not.
* @since 4.2
*/
void setInlinePreviewShown(bool show);
/**
* Sets whether the dialog should ask before accepting the selected file
* when KFileDialog::OperationMode is set to Saving.
*
* In this case a KMessageBox appears for confirmation.
*
* @param enable Set this to true to enable checking.
* @since 4.2
*/
void setConfirmOverwrite(bool enable);
/** @see QWidget::sizeHint() */
virtual QSize sizeHint() const;
/**
* Creates a modal file dialog and return the selected
* filename or an empty string if none was chosen.
*
* Note that with
* this method the user must select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static QString getOpenFileName( const KUrl& startDir= KUrl(),
const QString& filter= QString(),
QWidget *parent= 0,
const QString& caption = QString() );
/**
* Use this version only if you have no QWidget available as
* parent widget. This can be the case if the parent widget is
* a widget in another process or if the parent widget is a
* non-Qt widget. For example, in a GTK program.
*/
static QString getOpenFileNameWId( const KUrl& startDir,
const QString& filter,
WId parent_id, const QString& caption );
/**
* Creates a modal file dialog and returns the selected
* filenames or an empty list if none was chosen.
*
* Note that with
* this method the user must select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static QStringList getOpenFileNames( const KUrl& startDir= KUrl(),
const QString& filter = QString(),
QWidget *parent = 0,
const QString& caption= QString() );
/**
* Creates a modal file dialog and returns the selected
* URL or an empty string if none was chosen.
*
* Note that with
* this method the user must select an existing URL.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static KUrl getOpenUrl( const KUrl& startDir = KUrl(),
const QString& filter = QString(),
QWidget *parent= 0,
const QString& caption = QString() );
/**
* Creates a modal file dialog and returns the selected
* URLs or an empty list if none was chosen.
*
* Note that with
* this method the user must select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static KUrl::List getOpenUrls( const KUrl& startDir = KUrl(),
const QString& filter = QString(),
QWidget *parent = 0,
const QString& caption = QString() );
/**
* Creates a modal file dialog and returns the selected
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static QString getSaveFileName( const KUrl& startDir = KUrl(),
const QString& filter = QString(),
QWidget *parent = 0,
const QString& caption = QString() );
/**
* Creates a modal file dialog and returns the selected
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
* @param options Dialog options.
*
* @see KFileWidget::KFileWidget()
*
* @since 4.4
*/
static QString getSaveFileName( const KUrl& startDir,
const QString& filter,
QWidget *parent,
const QString& caption,
Options options );
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*/
static QString getSaveFileNameWId( const KUrl &startDir, const QString& filter,
WId parent_id,
const QString& caption );
/**
* This function accepts the window id of the parent window, instead
* of QWidget*. It should be used only when necessary.
*
* @since 4.4
*/
static QString getSaveFileNameWId( const KUrl &startDir, const QString& filter,
WId parent_id,
const QString& caption,
Options options );
/**
* Creates a modal file dialog and returns the selected
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
*
* @see KFileWidget::KFileWidget()
*/
static KUrl getSaveUrl( const KUrl& startDir = KUrl(),
const QString& filter = QString(),
QWidget *parent = 0,
const QString& caption = QString() );
/**
* Creates a modal file dialog and returns the selected
* filename or an empty string if none was chosen.
*
* Note that with this
* method the user need not select an existing filename.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param filter A shell glob or a mimetype 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.
* @param options Dialog options.
*
* @see KFileWidget::KFileWidget()
*
* @since 4.4
*/
static KUrl getSaveUrl( const KUrl& startDir,
const QString& filter,
QWidget *parent,
const QString& caption,
Options options );
/**
* Creates a modal directory-selection dialog and returns the selected
* directory (local only) or an empty string if none was chosen.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
* @return the path to an existing local directory.
*
* @see KFileWidget::KFileWidget()
*/
static QString getExistingDirectory( const KUrl& startDir = KUrl(),
QWidget * parent = 0,
const QString& caption= QString() );
/**
* Creates a modal directory-selection dialog and returns the selected
* directory or an empty string if none was chosen.
* This version supports remote urls.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
* @return the url to an existing directory (local or remote).
*
* @see KFileWidget::KFileWidget()
*/
static KUrl getExistingDirectoryUrl( const KUrl& startDir = KUrl(),
QWidget * parent = 0,
const QString& caption= QString() );
/**
* Creates a modal file dialog with an image previewer and returns the
* selected url or an empty string if none was chosen.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param parent The widget the dialog will be centered on initially.
* @param caption The name of the dialog widget.
*
* @see KFileWidget::KFileWidget()
*/
static KUrl getImageOpenUrl( const KUrl& startDir = KUrl(),
QWidget *parent = 0,
const QString& caption = QString() );
/**
* Sets the mode of the dialog.
*
* The mode is defined as (in kfile.h):
* \code
* enum Mode {
* File = 1,
* Directory = 2,
* Files = 4,
* ExistingOnly = 8,
* LocalOnly = 16
* };
* \endcode
* You can OR the values, e.g.
* \code
* KFile::Modes mode = KFile::Files |
* KFile::ExistingOnly |
* KFile::LocalOnly );
* setMode( mode );
* \endcode
*/
void setMode( KFile::Modes m );
/**
* Returns the mode of the filedialog.
* @see setMode()
*/
KFile::Modes mode() const;
/**
* Sets the text to be displayed in front of the selection.
*
* The default is "Location".
* Most useful if you want to make clear what
* the location is used for.
*/
void setLocationLabel(const QString& text);
/**
* Returns the KFileWidget that implements most of this file dialog.
* If you link to libkfile you can cast this to a KFileWidget*.
*/
KAbstractFileWidget* fileWidget();
/**
* Returns a pointer to the toolbar.
*
* You can use this to insert custom
* items into it, e.g.:
* \code
* yourAction = new KAction( i18n("Your Action"), 0,
* this, SLOT( yourSlot() ),
* this, "action name" );
* yourAction->plug( kfileDialog->toolBar() );
* \endcode
*/
KToolBar *toolBar() const;
/**
* @returns a pointer to the OK-Button in the filedialog. You may use it
* e.g. to set a custom text to it.
*/
KPushButton *okButton() const;
/**
* @returns a pointer to the Cancel-Button in the filedialog. You may use
* it e.g. to set a custom text to it.
*/
KPushButton *cancelButton() const;
/**
* @returns the combobox used to type the filename or full location of the file.
* You need to link to libkfile to use this widget.
*/
KUrlComboBox *locationEdit() const;
/**
* @returns the combobox that contains the filters
* You need to link to libkfile to use this widget.
*/
KFileFilterCombo *filterWidget() const;
/**
* @returns a pointer to the action collection, holding all the used KActions.
*/
KActionCollection *actionCollection() const;
/**
* This method implements the logic to determine the user's default directory
* to be listed. E.g. the documents directory, home directory or a recently
* used directory.
*
* @param startDir Starting directory or @c kfiledialog:/// URL.
* Refer to the KFileWidget documentation for more information
* on this parameter.
* @param recentDirClass If the @c kfiledialog:/// syntax is used, this
* will return the string to be passed to KRecentDirs::dir() and
* KRecentDirs::add().
* @return The URL that should be listed by default (e.g. by KFileDialog or
* KDirSelectDialog).
*
* @see KFileWidget::KFileWidget()
* @see KFileWidget::getStartUrl( const KUrl& startDir, QString& recentDirClass );
*/
static KUrl getStartUrl( const KUrl& startDir, QString& recentDirClass );
/**
* @internal
* Used by KDirSelectDialog to share the dialog's start directory.
*/
static void setStartDir( const KUrl& directory );
#ifdef Q_WS_WIN
public Q_SLOTS:
int exec();
#endif
Q_SIGNALS:
/**
* Emitted when the user selects a file. It is only emitted in single-
* selection mode. The best way to get notified about selected file(s)
* is to connect to the okClicked() signal inherited from KDialog
* and call selectedFile(), selectedFiles(),
* selectedUrl() or selectedUrls().
*
* \since 4.4
*/
void fileSelected(const KUrl&);
/**
* @deprecated, connect to fileSelected(const KUrl&) instead
*/
QT_MOC_COMPAT void fileSelected(const QString&); // TODO KDE5: remove
/**
* Emitted when the user highlights a file.
*
* \since 4.4
*/
void fileHighlighted(const KUrl&);
/**
* @deprecated, connect to fileSelected(const KUrl&) instead
*/
QT_MOC_COMPAT void fileHighlighted(const QString&); // TODO KDE5: remove
/**
* Emitted when the user hilights one or more files in multiselection mode.
*
* Note: fileHighlighted() or fileSelected() are @em not
* emitted in multiselection mode. You may use selectedItems() to
* ask for the current highlighted items.
* @see fileSelected
*/
void selectionChanged();
/**
* Emitted when the filter changed, i.e. the user entered an own filter
* or chose one of the predefined set via setFilter().
*
* @param filter contains the new filter (only the extension part,
* not the explanation), i.e. "*.cpp" or "*.cpp *.cc".
*
* @see setFilter()
* @see currentFilter()
*/
void filterChanged( const QString& filter );
protected:
/**
* Reimplemented to animate the cancel button.
*/
virtual void keyPressEvent( QKeyEvent *e );
/**
* Reimplemented for saving the dialog geometry.
*/
virtual void hideEvent( QHideEvent *event );
protected Q_SLOTS:
virtual void slotOk();
virtual void accept();
virtual void slotCancel();
private:
Q_DISABLE_COPY(KFileDialog)
KFileDialogPrivate * const d;
};
#endif
|