# class KAbstractFileWidget

### abstract

Module | kio
Namespace |
Class | KAbstractFileWidget
Inherits |

### enums

- OperationMode { Other, Opening, Saving }

enum details

### methods

- accept ( )

  returns Nothing
  pure virtual

- actionCollection ( )

  returns KActionCollection
  pure virtual

  Returns a pointer to the action collection, holding all the used KActions.

- baseUrl ( )

  returns KUrl
  pure virtual

  Returns the currently shown directory.

- cancelButton ( )

  returns KPushButton
  pure virtual

  Returns a pointer to the Cancel-Button in the filedialog. Note that the button is hidden and unconnected when using KFileWidget alone; KFileDialog shows it and connects to it.

- clearFilter ( )

  returns Nothing
  pure virtual

  Clears any mime- or namefilter. Does not reload the directory.

- currentFilter ( )

  returns QString
  pure virtual

  Returns the current filter as entered by the user or one of the predefined set via setFilter().

  See also setFilter()

  See also filterChanged()

- currentFilterMimeType ( )

  returns KMimeType.Ptr
  pure virtual

  Returns the mimetype for the desired output format.

  This is only valid if setFilterMimeType() has been called previously.

  See also setFilterMimeType()

- currentMimeFilter ( )

  returns QString
  pure virtual

  The mimetype for the desired output format.

  This is only valid if setMimeFilter() has been called previously.

  See also setMimeFilter()

- filterWidget ( )

  returns KFileFilterCombo
  pure virtual

  Returns the combobox that contains the filters

- keepsLocation ( )

  returns bool
  pure virtual

  Returns whether the contents of the location edit are kept when changing directories.

- locationEdit ( )

  returns KUrlComboBox
  pure virtual

  Returns the combobox used to type the filename or full location of the file.

- mode ( )

  returns KFile.Modes
  pure virtual

  Returns the mode of the filedialog.

  See also setMode()

- okButton ( )

  returns KPushButton
  pure virtual

  Returns a pointer to the OK-Button in the filedialog. Note that the button is hidden and unconnected when using KFileWidget alone; KFileDialog shows it and connects to it.

- operationMode ( )

  returns KAbstractFileWidget.OperationMode
  pure virtual

  Returns the current operation mode, Opening, Saving or Other. Default is Other.

  See also operationMode

  See also KFileDialog.OperationMode

- selectedFile ( )

  returns QString
  pure virtual

  Returns the full path of the selected file in the local filesystem. (Local files only)

- selectedFiles ( )

  returns QStringList
  pure virtual

  Returns a list of all selected local files.

- selectedUrl ( )

  returns KUrl
  pure virtual

  Returns The selected fully qualified filename.

- selectedUrls ( )

  returns KUrl.List
  pure virtual

  Returns The list of selected URLs.

- setCustomWidget (widget)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  widget | QWidget |

  Set a custom widget that should be added to the bottom of the file dialog.

  widget - A widget, or a widget of widgets, for displaying custom data in the file widget. 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 KFileWidget.

- setCustomWidget (text, widget)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  text | QString |
  widget | QWidget |

  Sets a custom widget that should be added below the location and the filter editors.

  text - Label of the custom widget, which is displayed below the labels "Location:" and "Filter:".

  widget - Any kind of widget, but preferable a combo box or a line editor to be compliant with the location and filter layout. When creating this widget, you don't need to specify a parent, since the widget's parent will be set automatically by KFileWidget.

- setFilter (filter)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  filter | QString |

  Sets the filter to be used to filter.

  You can set more filters for the user to select separated by '\n'. Every filter entry is defined through namefilter|text to diplay. If no | is found in the expression, just the namefilter is shown. Examples:

      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");

  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.

  If the filter contains an unescaped '/', a mimetype-filter is assumed. If you would like a '/' visible in your filter it can be escaped with a '\'. You can specify multiple mimetypes like this (separated with space):

      kfile->setFilter( "image/png text/html text/plain" );
      kfile->setFilter( "*.cue|CUE\\/BIN Files (*.cue)" );

  See also filterChanged

  See also setMimeFilter

- setKeepLocation (keep)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  keep | bool |

  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.

- setLocationLabel (text)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  text | QString |

  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.

- setMimeFilter (types, defaultType)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  types | QStringList |
  defaultType | QString | QString()

  Sets the filter up to specify the output type.

  types - a list of mimetypes that can be used as output format

  defaultType - the default mimetype to use as output format, if any. If defaultType is set, it will be set as the current item. Otherwise, a first item showing all the mimetypes will be created. Typically, defaultType should be empty for loading and set for saving.

  Do not use in conjunction with setFilter()

- setMode (m)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  m | KFile.Modes |

  Sets the mode of the dialog.

  The mode is defined as (in kfile.h):

      enum Mode {
      File = 1,
      Directory = 2,
      Files = 4,
      ExistingOnly = 8,
      LocalOnly = 16
      };

  You can OR the values, e.g.

      KFile.Modes mode = KFile.Files |
      KFile.ExistingOnly |
      KFile.LocalOnly );
      setMode( mode );

- setOperationMode (a0)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  a0 | KAbstractFileWidget.OperationMode |

  Sets the operational mode of the filedialog to Saving, Opening or 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 Saving, together with a default filter set via setMimeFilter() will make the filter combobox read-only.

  The default mode is Opening.

  Call this method right after instantiating KFileDialog.

  See also operationMode

  See also KFileDialog.OperationMode

- setPreviewWidget (w)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  w | KPreviewWidgetBase |

  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.

  w - The widget to be used for the preview.

- setSelection (name)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  name | QString |

  Sets the file name to preselect to name

  This takes absolute URLs and relative file names.

- setUrl (url, clearforward)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  url | KUrl |
  clearforward | bool | 1

  Sets the directory to view.

  url - URL to show.

  clearforward - Indicates whether the forward queue should be cleared.

- slotCancel ( )

  returns Nothing
  pure virtual

- slotOk ( )

  returns Nothing
  pure virtual

  Called when clicking ok (when this widget is used in KFileDialog) Might or might not call accept().

- toolBar ( )

  returns KToolBar
  pure virtual

  Returns a pointer to the toolbar.

  You can use this to insert custom items into it, e.g.:

      yourAction = new KAction( i18n("Your Action"), 0,
      this, SLOT( yourSlot() ),
      this, "action name" );
      yourAction->plug( kfileDialog->toolBar() );

- virtual_hook (id, data)

  returns Nothing
  pure virtual

  Argument | Type | Default
  --- | --- | ---
  id | int |
  data | void |

  Internal for future extensions

### enums - detail

- OperationMode { Other, Opening, Saving }

  Defines some default behavior of the filedialog. E.g. in mode Opening and Saving, the selected files/urls will be added to the "recent documents" list. The Saving mode also implies setKeepLocation() being set.

  Other means that no default actions are performed.

  See also setOperationMode

  See also operationMode

  | Other | - 0 | - |
  | Opening | - | - |
  | Saving | - | - |