kio/Mainpage.dox

   1 /** @mainpage KIO: Network-enabled File Management
   2
   3 <p><b>
   4 Overview |
   5 @ref filedialog "File Selector"
   6 </b></p>
   7
   8 This library implements almost all the file management functions you
   9 will ever need. In fact, the %KDE file manager, Konqueror also uses
  10 this to provide its network-enabled file management.
  11
  12 The easiest way to use this library from a %KDE application is via the
  13 KIO::NetAccess class (for easy synchronous access) or via the
  14 KIO::Job class (for more complex asynchronous jobs).
  15
  16 This library also implements the %KDE file selector widget (see
  17 @ref filedialog "the page on the file selector widget").
  18
  19 @authors
  20 Various: see copyright headers in individual files
  21
  22 @maintainers
  23 [Unknown/None]
  24
  25 @licenses
  26 @lgpl
  27
  28 */
  29
  30 /** @page filedialog KDE File Dialog Widget
  31
  32 <p><b>
  33 @ref index "Overview" |
  34 File Selector
  35 </b></p>
  36
  37 This library provides the KDE file selector widget, its building blocks
  38 and some other widgets that make use of the file selector.
  39
  40 The file dialog provides different views: there is a vertically scrolling
  41 view based on K3ListView, showing things like filename, file size,
  42 permissions etc. in separate columns. And there is a horizontally scrolling
  43 view based on K3IconView. Additionally, there are some compound views,
  44 like a view using the icon-view for files on the right side and another
  45 view for directories on the left. A view, that shows a preview for the
  46 currently selected file (using KIO::PreviewJob to generate previews)
  47 and any other view to show the files is also available.
  48
  49 All those views share a common baseclass, named KFileView, which
  50 defines the interface for inserting files into a view, removing them,
  51 selecting etc.
  52
  53 The one class encapsulating all those views and adding browsing capabilities
  54 to them is KDirOperator. It allows the user to switch between different
  55 views.
  56
  57 KFileTreeView is a K3ListView based widget that displays files and/or
  58 directories as a tree. It does not implement the KFileView interface,
  59 however, so it can't be used with KDirOperator.
  60
  61 Besides the filebrowsing widgets, there is the KPropertiesDialog class,
  62 implementing a dialog showing the name, permissions, icons, meta
  63 information and all kinds of properties of a file, as well as providing a
  64 means to modify them.
  65
  66 The KPropertiesDialog is extensible with plugin-pages via the
  67 KPropsDlgPlugin class.
  68
  69 The KIconDialog class shows a list of icons installed on the system (as
  70 accessible via KIconLoader) and allows the user to select one.
  71
  72 KOpenWithDlg implements a dialog to choose an application from, that is
  73 to be run, e.g. to let the user choose an application to open a file/url
  74 with.
  75
  76
  77 @see KFileDialog:
  78   The class providing the file selector dialog. It combines a KDirOperator,
  79   KUrlBar and several other widgets.
  80
  81 @see KDirOperator:
  82   The class encapsulating different KFileViews, offering file browsing and
  83   file selection. Asynchronous, network transparent reading of directories
  84   is performed via the @ref KIO library.
  85
  86 @see KUrlRequester:
  87   A widget to be used for asking for a filename/path/URL. It consists of a
  88   KLineEdit (or KComboBox) and a button. Activating the button
  89   will open a KFileDialog. Typing in the lineedit is aided with
  90   filename completion.
  91
  92 @see KUrlRequesterDlg:
  93   A dialog to ask for a filename/path/URL, using KUrlRequester.
  94
  95 @see KFileView:
  96   The base class for all views to be used with KDirOperator.
  97
  98 @see KFileIconView:
  99   The KFileView based on K3IconView.
 100
 101 @see KFileDetailView:
 102   The KFileView based on K3ListView.
 103
 104 @see KFilePreview:
 105   The KFileView, combining a widget showing preview for a selected file
 106   and another KFileView for browsing.
 107
 108 @see KUrlBar:
 109   A widget offering a number of clickable entries which represent a URL,
 110   aligned horizontally or vertically. The entries are customizable by the
 111   user both on a per application basis or for all applications (URLs, their
 112   icon and the description can be added, removed or edited by the user).
 113   This is the widget used as "sidebar" in the KFileDialog.
 114
 115 @see KFileMetaInfoWidget:
 116   A widget that allows viewing and editing of meta data of a file, utilizing
 117    KFileMetaInfo.
 118
 119 */
 120
 121 // DOXYGEN_REFERENCES = kdecore kjs kdeui
 122 // DOXYGEN_EXCLUDE = kssl/kssl
 123 // DOXYGEN_PROJECTNAME = KIO
 124 // vim:ts=4:sw=4:expandtab:filetype=doxygen