/usr/include/KF5/KIOFileWidgets/kdiroperator.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 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 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 | // -*- c++ -*-
/* This file is part of the KDE libraries
Copyright (C) 1999 Stephan Kulow <coolo@kde.org>
2000,2001 Carsten Pfeiffer <pfeiffer@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 KDIROPERATOR_H_
#define KDIROPERATOR_H_
#include <QWidget>
#include <QtCore/QStack>
#include <QStyleOptionViewItem>
#include <ktoggleaction.h>
#include <kcompletion.h>
#include <kdirlister.h>
#include <kfileitem.h>
#include <kfile.h>
#include "kiofilewidgets_export.h"
class QAbstractItemView;
class QModelIndex;
class QProgressBar;
class KActionCollection;
class KActionMenu;
class KConfigGroup;
class KDirLister;
class KPreviewWidgetBase;
class KFilePreviewGenerator;
namespace KIO
{
class CopyJob;
class DeleteJob;
}
/**
* @class KDirOperator kdiroperator.h <KDirOperator>
*
* This widget works as a network transparent filebrowser. You specify a URL
* to display and this url will be loaded via KDirLister. The user can
* browse through directories, highlight and select files, delete or rename
* files.
*
* It supports different views, e.g. a detailed view (see KFileDetailView),
* a simple icon view (see KFileIconView), a combination of two views,
* separating directories and files ( KCombiView).
*
* Additionally, a preview view is available (see KFilePreview), which can
* show either a simple or detailed view and additionally a preview widget
* (see setPreviewWidget()). KImageFilePreview is one implementation
* of a preview widget, that displays previews for all supported filetypes
* utilizing KIO::PreviewJob.
*
* Currently, those classes don't support Drag&Drop out of the box -- there
* you have to use your own view-classes. You can use some DnD-aware views
* from Björn Sahlström <bjorn@kbear.org> until they will be integrated
* into this library. See http://devel-home.kde.org/~pfeiffer/DnD-classes.tar.gz
*
* This widget is the one used in the KFileWidget.
*
* Basic usage is like this:
* \code
* KDirOperator *op = new KDirOperator(QUrl("file:///home/gis"), this);
* // some signals you might be interested in
* connect(op, SIGNAL(urlEntered(const QUrl&)),
* SLOT(urlEntered(const QUrl&)));
* connect(op, SIGNAL(fileHighlighted(const KFileItem &)),
* SLOT(fileHighlighted(const KFileItem &)));
* connect(op, SIGNAL(fileSelected(const KFileItem &)),
* SLOT(fileSelected(const KFileItem &)));
* connect(op, SIGNAL(finishedLoading()),
* SLOT(slotLoadingFinished()));
*
* KConfigGroup grp(KSharedConfig::openConfig(),"Your KDiroperator ConfigGroup" );
* op->readConfig( &grp);
* op->setView(KFile::Default);
* \endcode
*
* This will create a childwidget of 'this' showing the directory contents
* of /home/gis in the default-view. The view is determined by the readConfig()
* call, which will read the KDirOperator settings, the user left your program
* with (and which you saved with op->writeConfig()).
*
* @short A widget for displaying files and browsing directories.
* @author Stephan Kulow <coolo@kde.org>, Carsten Pfeiffer <pfeiffer@kde.org>
*/
class KIOFILEWIDGETS_EXPORT KDirOperator : public QWidget
{
Q_OBJECT
public:
/**
* The various action types. These values can be or'd together
*/
enum ActionType {
SortActions = 1,
ViewActions = 2,
NavActions = 4,
FileActions = 8,
AllActions = 15
};
/**
* Constructs the KDirOperator with no initial view. As the views are
* configurable, call readConfig() to load the user's configuration
* and then setView to explicitly set a view.
*
* This constructor doesn't start loading the url, setView will do it.
*/
explicit KDirOperator(const QUrl &urlName = QUrl(),
QWidget *parent = nullptr);
/**
* Destroys the KDirOperator.
*/
virtual ~KDirOperator();
/**
* Enables/disables showing hidden files.
*/
virtual void setShowHiddenFiles(bool s);
/**
* @returns true when hidden files are shown or false otherwise.
*/
bool showHiddenFiles() const;
/**
* Stops loading immediately. You don't need to call this, usually.
*/
void close();
/**
* Sets a filter like "*.cpp *.h *.o". Only files matching that filter
* will be shown.
*
* @see KDirLister::setNameFilter
* @see nameFilter
*/
void setNameFilter(const QString &filter);
/**
* @returns the current namefilter.
* @see setNameFilter
*/
QString nameFilter() const;
/**
* Sets a list of mimetypes as filter. Only files of those mimetypes
* will be shown.
*
* Example:
* \code
* QStringList filter;
* filter << "text/html" << "image/png" << "inode/directory";
* dirOperator->setMimefilter( filter );
* \endcode
*
* Node: Without the mimetype inode/directory, only files would be shown.
* Call updateDir() to apply it.
*
* @see KDirLister::setMimeFilter
* @see mimeFilter
*/
void setMimeFilter(const QStringList &mimetypes);
/**
* @returns the current mime filter.
*/
QStringList mimeFilter() const;
/**
* Only show the files in a given set of mimetypes.
* This is useful in specialized applications (while file managers, on
* the other hand, want to show all mimetypes). Internally uses
* KNewFileMenu::setSupportedMimeTypes
*
* Example:
* \code
* QStringList mimeTypes;
* mimeTypes << "text/html" << "inode/directory";
* dirOperator->setNewFileMenuSupportedMimeTypes(mimeTypes);
* \endcode
*
* Note: If the list is empty, all options will be shown. Otherwise,
* without the mimetype inode/directory, only file options will be shown.
*
* @see KNewFileMenu::setSupportedMimeTypes
* @see newFileMenuSupportedMimeTypes
* @since 4.5
*/
void setNewFileMenuSupportedMimeTypes(const QStringList &mime);
/**
* @returns the current Supported Mimes Types.
* @since 4.5
*/
QStringList newFileMenuSupportedMimeTypes() const;
/**
* Clears both the namefilter and mimetype filter, so that all files and
* directories will be shown. Call updateDir() to apply it.
*
* @see setMimeFilter
* @see setNameFilter
*/
void clearFilter();
/**
* @returns the current url
*/
QUrl url() const;
/**
* Sets a new url to list.
* @param clearforward specifies whether the "forward" history should be cleared.
* @param url the URL to set
*/
virtual void setUrl(const QUrl &url, bool clearforward);
/**
* Clears the current selection and attempts to set @p url
* the current url file.
*/
void setCurrentItem(const QUrl &url);
/**
* Clears the current selection and attempts to set @p item
* as the current item.
*/
void setCurrentItem(const KFileItem &item);
/**
* Clears the current selection and attempts to set @p urls
* the current url files.
* @since 4.2
*/
void setCurrentItems(const QList<QUrl> &urls);
/**
* Clears the current selection and attempts to set @p items
* as the current items.
* @since 4.2
*/
void setCurrentItems(const KFileItemList &items);
/**
* Sets a new view to be used for showing and browsing files.
* Note: this will read the current url() to fill the view.
*
* @see KFileTreeView
* @see view
*/
virtual void setView(QAbstractItemView *view);
/**
* @returns the currently used view.
* @see setView
*/
QAbstractItemView *view() const;
/**
* Sets one of the predefined fileviews.
* @see KFile::FileView
*/
virtual void setView(KFile::FileView viewKind);
/**
* Returns the current view mode.
* @returns KFile::FileView
* @see KFile::FileView
* @since 5.0
*/
KFile::FileView viewMode() const;
/**
* Sets the way to sort files and directories.
*/
void setSorting(QDir::SortFlags);
/**
* @returns the current way of sorting files and directories
*/
QDir::SortFlags sorting() const;
/**
* @returns true if we are displaying the root directory of the current url
*/
bool isRoot() const;
/**
* @returns the object listing the directory
*/
KDirLister *dirLister() const;
/**
* @returns the progress widget, that is shown during directory listing.
* You can for example reparent() it to put it into a statusbar.
*/
QProgressBar *progressBar() const;
/**
* Sets the listing/selection mode for the views, an OR'ed combination of
* @li File
* @li Directory
* @li Files
* @li ExistingOnly
* @li LocalOnly
*
* You cannot mix File and Files of course, as the former means
* single-selection mode, the latter multi-selection.
*/
virtual void setMode(KFile::Modes m);
/**
* @returns the listing/selection mode.
*/
KFile::Modes mode() const;
/**
* Sets a preview-widget to be shown next to the file-view.
* The ownership of @p w is transferred to KDirOperator, so don't
* delete it yourself!
*/
virtual void setPreviewWidget(KPreviewWidgetBase *w);
/**
* @returns a list of all currently selected items. If there is no view,
* or there are no selected items, an empty list is returned.
*/
KFileItemList selectedItems() const;
/**
* @returns true if @p item is currently selected, or false otherwise.
*/
bool isSelected(const KFileItem &item) const;
/**
* @returns the number of directories in the currently listed url.
* Returns 0 if there is no view.
*/
int numDirs() const;
/**
* @returns the number of files in the currently listed url.
* Returns 0 if there is no view.
*/
int numFiles() const;
/**
* @returns a KCompletion object, containing all filenames and
* directories of the current directory/URL.
* You can use it to insert it into a KLineEdit or KComboBox
* Note: it will only contain files, after prepareCompletionObjects()
* has been called. It will be implicitly called from makeCompletion()
* or makeDirCompletion()
*/
KCompletion *completionObject() const;
/**
* @returns a KCompletion object, containing only all directories of the
* current directory/URL.
* You can use it to insert it into a KLineEdit or KComboBox
* Note: it will only contain directories, after
* prepareCompletionObjects() has been called. It will be implicitly
* called from makeCompletion() or makeDirCompletion()
*/
KCompletion *dirCompletionObject() const;
/**
* an accessor to a collection of all available Actions. The actions
* are static, they will be there all the time (no need to connect to
* the signals KActionCollection::inserted() or removed().
*
* There are the following actions:
*
* @li popupMenu : an ActionMenu presenting a popupmenu with all actions
* @li up : changes to the parent directory
* @li back : goes back to the previous directory
* @li forward : goes forward in the history
* @li home : changes to the user's home directory
* @li reload : reloads the current directory
* @li mkdir : opens a dialog box to create a directory
* @li delete : deletes the selected files/directories
* @li sorting menu : an ActionMenu containing all sort-options
* @li by name : sorts by name
* @li by size : sorts by size
* @li by date : sorts by date
* @li by type : sorts by type
* @li descending : reverses the sort order
* @li view menu : an ActionMenu containing all actions concerning the view
* @li short view : shows a simple fileview
* @li detailed view : shows a detailed fileview (dates, permissions ,...)
* @li show hidden : shows hidden files
* @li preview : shows a preview next to the fileview
* @li properties : shows a KPropertiesDialog for the selected files
*
* The short and detailed view are in an exclusive group. The sort-by
* actions are in an exclusive group as well. Also the "separate dirs",
* "preview" and "single" actions are in an exclusive group.
*
* You can e.g. use
* \code
* actionCollection()->action( "up" )->plug( someToolBar );
* \endcode
* to add a button into a toolbar, which makes the dirOperator change to
* its parent directory.
*
* @returns all available Actions
*/
KActionCollection *actionCollection() const;
/**
* Sets the config object and the to be used group in KDirOperator. This
* will be used to store the view's configuration.
* If you don't set this, the views cannot save and restore their
* configuration.
*
* Usually you call this right after KDirOperator creation so that the view
* instantiation can make use of it already.
*
* Note that KDirOperator does NOT take ownership of that object (typically
* it's KSharedConfig::openConfig() anyway.
*
* You must not delete the KConfig or KConfigGroup object (and master config object) before
* either deleting the KDirOperator or calling setViewConfig(0); or something like that
*
* @see viewConfig
* @see viewConfigGroup
*/
virtual void setViewConfig(KConfigGroup &configGroup);
/**
* @returns the group set by setViewConfig configuration.
*/
KConfigGroup *viewConfigGroup() const;
/**
* Reads the default settings for a view, i.e. the default KFile::FileView.
* Also reads the sorting and whether hidden files should be shown.
* Note: the default view will not be set - you have to call
* \code
* setView( KFile::Default )
* \endcode
* to apply it.
*
* @see setView
* @see setViewConfig
* @see writeConfig
*/
virtual void readConfig(const KConfigGroup &configGroup);
/**
* Saves the current settings like sorting, simple or detailed view.
*
* @see readConfig
* @see setViewConfig
*/
virtual void writeConfig(KConfigGroup &configGroup);
/**
* This toggles between double/single click file and directory selection mode.
* When argument is true, files and directories are highlighted with single click and
* selected (executed) with double click.
*
* NOTE: this currently has no effect.
*
* The default follows the single/double click system setting.
*/
void setOnlyDoubleClickSelectsFiles(bool enable);
/**
* @returns whether files (not directories) should only be select()ed by
* double-clicks.
* @see setOnlyDoubleClickSelectsFiles
*/
bool onlyDoubleClickSelectsFiles() const;
/**
* Creates the given directory/url. If it is a relative path,
* it will be completed with the current directory.
* If enterDirectory is true, the directory will be entered after a
* successful operation. If unsuccessful, a messagebox will be presented
* to the user.
* @returns true if the directory could be created.
*/
virtual bool mkdir(const QString &directory, bool enterDirectory = true);
/**
* Starts and returns a KIO::DeleteJob to delete the given @p items.
*
* @param items the list of items to be deleted
* @param parent the parent widget used for the confirmation dialog
* @param ask specifies whether a confirmation dialog should be shown
* @param showProgress passed to the DeleteJob to show a progress dialog
*/
virtual KIO::DeleteJob *del(const KFileItemList &items, QWidget *parent = nullptr,
bool ask = true, bool showProgress = true);
/**
* Clears the forward and backward history.
*/
void clearHistory();
/**
* When going up in the directory hierarchy, KDirOperator can highlight
* the directory that was just left.
*
* I.e. when you go from /home/gis/src to /home/gis, the item "src" will
* be made the current item.
*
* Default is off.
*/
virtual void setEnableDirHighlighting(bool enable);
/**
* @returns whether the last directory will be made the current item
* when going up in the directory hierarchy.
*
* Default is false.
*/
bool dirHighlighting() const;
/**
* @returns true if we are in directory-only mode, that is, no files are
* shown.
*/
bool dirOnlyMode() const;
static bool dirOnlyMode(uint mode);
/**
* Sets up the action menu.
* @param whichActions is an value of OR'd ActionTypes that controls which actions to show in the action menu
*/
void setupMenu(int whichActions);
/**
* Reimplemented - allow dropping of files if @p b is true
* @param b true if the widget should allow dropping of files
*/
virtual void setAcceptDrops(bool b);
/**
* Sets the options for dropping files.
* CURRENTLY NOT IMPLEMENTED
*/
virtual void setDropOptions(int options);
/**
* Starts and returns a KIO::CopyJob to trash the given @p items.
*
* @param items the list of items to be trashed
* @param parent the parent widget used for the confirmation dialog
* @param ask specifies whether a confirmation dialog should be shown
* @param showProgress passed to the CopyJob to show a progress dialog
*/
virtual KIO::CopyJob *trash(const KFileItemList &items, QWidget *parent,
bool ask = true, bool showProgress = true);
/**
* Returns the preview generator for the current view.
* @since 4.2
*/
KFilePreviewGenerator *previewGenerator() const;
/**
* 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);
/**
* Returns the position where icons are shown relative to the labels
* of file items in the icon view.
* @since 4.2.3
*/
QStyleOptionViewItem::Position decorationPosition() const;
/**
* Sets the position where icons shall be shown relative to the labels
* of file items in the icon view.
* @since 4.2.3
*/
void setDecorationPosition(QStyleOptionViewItem::Position position);
/**
* Returns whether the inline previews are shown or not.
* @since 4.2
*/
bool isInlinePreviewShown() const;
/**
* Returns the icon zoom.
* @since 4.2
*/
int iconsZoom() const;
/**
* If the system is set up to trigger items on single click, if @p isSaving
* is true, we will force to double click to accept.
* @note this is false by default
* @since 4.2
*/
void setIsSaving(bool isSaving);
/**
* Returns whether KDirOperator will force a double click to accept.
* @note this is false by default
* @since 4.2
*/
bool isSaving() const;
/**
* Returns the URL schemes that the file widget should allow navigating to.
*
* If the returned list is empty, all schemes are supported.
*
* @sa QFileDialog::supportedSchemes
* @since 5.43
*/
QStringList supportedSchemes() const;
protected:
/**
* A view factory for creating predefined fileviews. Called internally by setView,
* but you can also call it directly. Reimplement this if you depend on self defined fileviews.
* @param parent is the QWidget to be set as parent
* @param viewKind is the predefined view to be set, note: this can be several ones OR:ed together
* @returns the created view
* @see KFile::FileView
* @see setView
*/
virtual QAbstractItemView *createView(QWidget *parent, KFile::FileView viewKind);
/**
* Sets a custom KDirLister to list directories.
* The KDirOperator takes ownership of the given KDirLister.
*/
virtual void setDirLister(KDirLister *lister);
void resizeEvent(QResizeEvent *event) Q_DECL_OVERRIDE;
void keyPressEvent(QKeyEvent *event) Q_DECL_OVERRIDE;
/**
* Sets up all the actions. Called from the constructor, you usually
* better not call this.
*/
void setupActions();
/**
* Updates the sorting-related actions to comply with the current sorting
* @see sorting
*/
void updateSortActions();
/**
* Updates the view-related actions to comply with the current
* KFile::FileView
*/
void updateViewActions();
/**
* Sets up the context-menu with all the necessary actions. Called from the
* constructor, you usually don't need to call this.
*/
void setupMenu();
/**
* Synchronizes the completion objects with the entries of the
* currently listed url.
*
* Automatically called from makeCompletion() and
* makeDirCompletion()
*/
void prepareCompletionObjects();
/**
* Checks if there support from KIO::PreviewJob for the currently
* shown files, taking mimeFilter() and nameFilter() into account
* Enables/disables the preview-action accordingly.
*/
bool checkPreviewSupport();
/**
* Called upon right-click to activate the popupmenu.
*/
virtual void activatedMenu(const KFileItem &item, const QPoint &pos);
void changeEvent(QEvent *event) Q_DECL_OVERRIDE;
bool eventFilter(QObject *watched, QEvent *event) Q_DECL_OVERRIDE;
public Q_SLOTS:
/**
* Goes one step back in the history and opens that url.
*/
virtual void back();
/**
* Goes one step forward in the history and opens that url.
*/
virtual void forward();
/**
* Enters the home directory.
*/
virtual void home();
/**
* Goes one directory up from the current url.
*/
virtual void cdUp();
/**
* to update the view after changing the settings
*/
void updateDir();
/**
* Re-reads the current url.
*/
virtual void rereadDir();
/**
* Opens a dialog to create a new directory.
*/
virtual void mkdir();
/**
* Deletes the currently selected files/directories.
*/
virtual void deleteSelected();
/**
* Enables/disables actions that are selection dependent. Call this e.g.
* when you are about to show a popup menu using some of KDirOperators
* actions.
*/
void updateSelectionDependentActions();
/**
* Tries to complete the given string (only completes files).
*/
QString makeCompletion(const QString &);
/**
* Tries to complete the given string (only completes directores).
*/
QString makeDirCompletion(const QString &);
/**
* Trashes the currently selected files/directories.
*
* This function used to take activation reason and keyboard modifiers,
* in order to call deleteSelected() if the user wanted to delete.
* Instead, call deleteSelected().
*
* FIXME KAction Port: link deleteSelected() up correctly
*/
virtual void trashSelected();
/**
* Notifies that the icons size should change. @p value is an int ranged from 0 to 100.
* 100 means KIconLoader::SizeEnormous.
* @since 4.2
*/
void setIconsZoom(int value);
/**
* Set the URL schemes that the file widget should allow navigating to.
*
* If the returned list is empty, all schemes are supported. Examples for
* schemes are @c "file" or @c "ftp".
*
* @sa QFileDialog::setSupportedSchemes
* @since 5.43
*/
void setSupportedSchemes(const QStringList &schemes);
protected Q_SLOTS:
/**
* Restores the normal cursor after showing the busy-cursor. Also hides
* the progressbar.
*/
void resetCursor();
/**
* Called after setUrl() to load the directory, update the history,
* etc.
*/
void pathChanged();
/**
* Enters the directory specified by the given @p item.
*/
virtual void selectDir(const KFileItem &item);
/**
* Emits fileSelected( item )
*/
void selectFile(const KFileItem &item);
/**
* Emits fileHighlighted(item)
*/
void highlightFile(const KFileItem &item);
/**
* Changes sorting to sort by name
*/
void sortByName();
/**
* Changes sorting to sort by size
*/
void sortBySize();
/**
* Changes sorting to sort by date
*/
void sortByDate();
/**
* Changes sorting to sort by date
*/
void sortByType();
/**
* Changes sorting to reverse sorting
*/
void sortReversed();
/**
* Toggles showing directories first / having them sorted like files.
*/
void toggleDirsFirst();
/**
* Toggles case sensitive / case insensitive sorting
*/
void toggleIgnoreCase();
/**
* Tries to make the given @p match as current item in the view and emits
* completion( match )
*/
void slotCompletionMatch(const QString &match);
Q_SIGNALS:
void urlEntered(const QUrl &);
void updateInformation(int files, int dirs);
void completion(const QString &);
void finishedLoading();
/**
* Emitted whenever the current fileview is changed, either by an explicit
* call to setView() or by the user selecting a different view thru
* the GUI.
*/
void viewChanged(QAbstractItemView *newView);
/**
* Emitted when a file is highlighted or generally the selection changes in
* multiselection mode. In the latter case, @p item is 0L. You can access
* the selected items with selectedItems().
*/
void fileHighlighted(const KFileItem &item);
void dirActivated(const KFileItem &item);
void fileSelected(const KFileItem &item);
/**
* Emitted when files are dropped. Dropping files is disabled by
* default. You need to enable it with setAcceptDrops()
* @param item the item on which the drop occurred or 0.
* @param event the drop event itself.
* @param urls the urls that where dropped.
*/
void dropped(const KFileItem &item, QDropEvent *event, const QList<QUrl> &urls);
/**
* Emitted just before the context menu is shown, allows users to
* extend the menu with custom actions.
*
* @param item the file on which the context menu was invoked
* @param menu the context menu, pre-populated with the file-management actions
* @since 4.2
*/
void contextMenuAboutToShow(const KFileItem &item, QMenu *menu);
/**
* Will notify that the icon size has changed. Since we save the icon size depending
* on the view type (list view or a different kind of view), a call to setView() can
* trigger this signal to be emitted.
* @since 4.2
*/
void currentIconSizeChanged(int size);
private:
class Private;
Private *const d;
Q_PRIVATE_SLOT(d, void _k_slotDetailedView())
Q_PRIVATE_SLOT(d, void _k_slotSimpleView())
Q_PRIVATE_SLOT(d, void _k_slotTreeView())
Q_PRIVATE_SLOT(d, void _k_slotDetailedTreeView())
Q_PRIVATE_SLOT(d, void _k_slotToggleHidden(bool))
Q_PRIVATE_SLOT(d, void _k_togglePreview(bool))
Q_PRIVATE_SLOT(d, void _k_toggleInlinePreviews(bool))
Q_PRIVATE_SLOT(d, void _k_slotOpenFileManager())
Q_PRIVATE_SLOT(d, void _k_slotSortByName())
Q_PRIVATE_SLOT(d, void _k_slotSortBySize())
Q_PRIVATE_SLOT(d, void _k_slotSortByDate())
Q_PRIVATE_SLOT(d, void _k_slotSortByType())
Q_PRIVATE_SLOT(d, void _k_slotSortReversed(bool))
Q_PRIVATE_SLOT(d, void _k_slotToggleDirsFirst())
Q_PRIVATE_SLOT(d, void _k_slotToggleIgnoreCase())
Q_PRIVATE_SLOT(d, void _k_slotStarted())
Q_PRIVATE_SLOT(d, void _k_slotProgress(int))
Q_PRIVATE_SLOT(d, void _k_slotShowProgress())
Q_PRIVATE_SLOT(d, void _k_slotIOFinished())
Q_PRIVATE_SLOT(d, void _k_slotCanceled())
Q_PRIVATE_SLOT(d, void _k_slotRedirected(const QUrl &))
Q_PRIVATE_SLOT(d, void _k_slotProperties())
Q_PRIVATE_SLOT(d, void _k_slotActivated(const QModelIndex &))
Q_PRIVATE_SLOT(d, void _k_slotSelectionChanged())
Q_PRIVATE_SLOT(d, void _k_openContextMenu(const QPoint &))
Q_PRIVATE_SLOT(d, void _k_triggerPreview(const QModelIndex &))
Q_PRIVATE_SLOT(d, void _k_showPreview())
Q_PRIVATE_SLOT(d, void _k_slotSplitterMoved(int, int))
Q_PRIVATE_SLOT(d, void _k_assureVisibleSelection())
Q_PRIVATE_SLOT(d, void _k_synchronizeSortingState(int, Qt::SortOrder))
Q_PRIVATE_SLOT(d, void _k_slotChangeDecorationPosition())
Q_PRIVATE_SLOT(d, void _k_slotExpandToUrl(const QModelIndex &))
Q_PRIVATE_SLOT(d, void _k_slotItemsChanged())
Q_PRIVATE_SLOT(d, void _k_slotDirectoryCreated(const QUrl &))
};
#endif
|