<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kio: A network-enabled file management system in a library (kio)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kio</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="headertitle">
<div class="title">A network-enabled file management system in a library </div> </div>
</div>
<div class="contents">
<div class="textblock"><p>This library implements almost all the file management functions you will ever need. In fact, the KDE file manager, Konqueror also uses this to provide its network-enabled file management.</p>
<p>The easiest way to use this library from a KDE application is via the <a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKIO_1_1NetAccess.html">KIO::NetAccess</a> class (for easy synchronous access) or via the <a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKIO_1_1Job.html">KIO::Job</a> class (for more complex asynchronous jobs).</p>
<p>This library also implements the System Configuration Cache (KSycoca).</p>
<p><a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKMimeType.html">KMimeType</a>: The notion of a file type, already existing in KDE-1.x</p>
<p><a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKService.html">KService</a>: To a mimetype are bound one or more applications, now called services. Services can be applications, but also libraries, dynamically opened.</p>
<p><a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKServiceType.html">KServiceType</a>: A service type allows the same mechanism to be extended to components. For instance : the question "what are the koffice plugins" is solved by a service type called KOfficePlugin, and by every plugin providing a .desktop file stating that it is a service that implements the servicetype KOfficePlugin.</p>
<p><a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKServiceTypeProfile.html">KServiceTypeProfile</a>: Stores the user's preferences for services bound to mimetypes/servicetypes.</p>
<p><a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKTrader.html">KTrader</a>: Use it to query for which services implement a given mimetype/servicetype. Has its own language, in order to allow complex queries.</p>
<h2><a class="anchor" id="KDE"></a>
Filedialog widget and associated classes.</h2>
<p>This library also provides the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> file selector widget, its building blocks and some other widgets, making use of the file dialog.</p>
<p>The file dialog provides different views; there is a vertically scrolling view based on <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKListView.html">KListView</a>, showing things like filename, file size, permissions etc. in separate columns. And there is a horizontally scrolling view based on <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKIconView.html">KIconView</a>. Additionally, there are some compound views, like a view using the icon-view for files on the right side and another view for directories on the left. A view, that shows a preview for the currently selected file (using <a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKIO_1_1PreviewJob.html">KIO::PreviewJob</a> to generate previews) and any other view to show the files is also available.</p>
<p>All those views share a common baseclass, named <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a>, which defines the interface for inserting files into a view, removing them, selecting etc.</p>
<p>The one class encapsulating all those views and adding browsing capabilities to them is <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKDirOperator.html">KDirOperator</a>. It allows the user to switch between different views.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileTreeView.html">KFileTreeView</a> is a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKListView.html">KListView</a> based widget that displays files and/or directories as a tree. It does not implement the <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a> interface, however, so it can't be used with <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKDirOperator.html">KDirOperator</a>.</p>
<p>Besides the filebrowsing widgets, there is the <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKPropertiesDialog.html">KPropertiesDialog</a> class, implementing a dialog showing the name, permissions, icons, meta information and all kinds of properties of a file, as well as providing a means to modify them.</p>
<p>The <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKPropertiesDialog.html">KPropertiesDialog</a> is extensible with plugin-pages via the <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKPropsDlgPlugin.html">KPropsDlgPlugin</a> class.</p>
<p>The <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKIconDialog.html">KIconDialog</a> class shows a list of icons installed on the system (as accessible via <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKIconLoader.html">KIconLoader</a>) and allows the user to select one.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKOpenWithDlg.html">KOpenWithDlg</a> implements a dialog to choose an application from, that is to be run, e.g. to let the user choose an application to open a file/url with.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileDialog.html">KFileDialog</a>: The class providing the file selector dialog. It combines a <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKDirOperator.html">KDirOperator</a>, <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKURLBar.html">KURLBar</a> and several other widgets.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKDirOperator.html">KDirOperator</a>: The class encapsulating different KFileViews, offering file browsing and file selection. Asynchronous, network transparent reading of directories is performed via the <a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/namespaceKIO.html">KIO</a> library.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKURLRequester.html">KURLRequester</a>: A widget to be used for asking for a filename/path/URL. It consists of a <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKLineEdit.html">KLineEdit</a> (or <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKComboBox.html">KComboBox</a>) and a button. Activating the button will open a <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileDialog.html">KFileDialog</a>. Typing in the lineedit is aided with filename completion.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKURLRequesterDlg.html">KURLRequesterDlg</a>: A dialog to ask for a filename/path/URL, using <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKURLRequester.html">KURLRequester</a>.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a>: The base class for all views to be used with <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKDirOperator.html">KDirOperator</a>.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileIconView.html">KFileIconView</a>: The <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a> based on <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKIconView.html">KIconView</a>.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileDetailView.html">KFileDetailView</a>: The <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a> based on <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKListView.html">KListView</a>.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFilePreview.html">KFilePreview</a>: The <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a>, combining a widget showing preview for a selected file and another <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileView.html">KFileView</a> for browsing.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKURLBar.html">KURLBar</a>: A widget offering a number of clickable entries which represent a URL, aligned horizontally or vertically. The entries are customizable by the user both on a per application basis or for all applications (URLs, their icon and the description can be added, removed or edited by the user). This is the widget used as "sidebar" in the <a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileDialog.html">KFileDialog</a>.</p>
<p><a class="elRef" doxygen="kfile.tag:../../kio/kfile/html/" href="../../kio/kfile/html/classKFileMetaInfoWidget.html">KFileMetaInfoWidget</a>: A widget that allows viewing and editing of meta data of a file, utilizing <a class="elRef" doxygen="kio.tag:../../kio/kio/html/" href="../../kio/kio/html/classKFileMetaInfo.html">KFileMetaInfo</a>. </p>
</div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kio</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
