/usr/share/gtk-doc/html/libfm/libfm-File-properties-dialog.html is in libfm-doc 1.2.0-1ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libfm Reference Manual: File properties dialog</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-gtk.html" title="Libfm Gtk+ Widgets and Objects.">
<link rel="prev" href="libfm-FmFileMenu.html" title="FmFileMenu">
<link rel="next" href="FmFolderModel.html" title="FmFolderModel">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libfm-File-properties-dialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libfm-File-properties-dialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libfm-gtk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libfm-FmFileMenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FmFolderModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libfm-File-properties-dialog"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libfm-File-properties-dialog.top_of_page"></a>File properties dialog</span></h2>
<p>File properties dialog — Dialog window for changing properties of file.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libfm-File-properties-dialog.html#fm-file-properties-add-for-mime-type" title="fm_file_properties_add_for_mime_type ()">fm_file_properties_add_for_mime_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html"><span class="returnvalue">GtkDialog</span></a> *
</td>
<td class="function_name">
<a class="link" href="libfm-File-properties-dialog.html#fm-file-properties-widget-new" title="fm_file_properties_widget_new ()">fm_file_properties_widget_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libfm-File-properties-dialog.html#fm-show-file-properties" title="fm_show_file_properties ()">fm_show_file_properties</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libfm-File-properties-dialog.html#FM-MODULE-gtk-file-prop-VERSION" title="FM_MODULE_gtk_file_prop_VERSION">FM_MODULE_gtk_file_prop_VERSION</a></td>
</tr>
<tr>
<td class="variable_type">extern FmFilePropertiesExtensionInit </td>
<td class="function_name"><a class="link" href="libfm-File-properties-dialog.html#fm-module-init-gtk-file-prop" title="fm_module_init_gtk_file_prop">fm_module_init_gtk_file_prop</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libfm-File-properties-dialog.html#FmFilePropertiesExtensionInit" title="struct FmFilePropertiesExtensionInit">FmFilePropertiesExtensionInit</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm-gtk.h</p>
<p>The file properties dialog is a window with few tabs and buttons "OK"
and "Cancel". Most of content of those tabs is handled by the widget
itself but there is a possibility to change its content for some file
type. See <a class="link" href="libfm-File-properties-dialog.html#fm-file-properties-add-for-mime-type" title="fm_file_properties_add_for_mime_type ()"><code class="function">fm_file_properties_add_for_mime_type()</code></a> for details.</p>
<p>Default content of tabs of file properties dialog follows (each tab has
a GtkAlignment element, tab ids below meant of those):</p>
<p>Tab 1: contains GtkTable (id general_table) with items:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>GtkImage (id icon) : file icon, eventbox: id icon_eventbox</p></li>
<li class="listitem"><p>GtkLabel (id file) : reserved (hidden), hidden label: id file_label</p></li>
<li class="listitem"><p>GtkEntry (id name) : label: "Name"</p></li>
<li class="listitem"><p>GtkLabel (id dir) : label: "Location"</p></li>
<li class="listitem"><p>GtkLabel (id target) : label: "Target", id target_label</p></li>
<li class="listitem"><p>GtkLabel (id type) : label: "File type"</p></li>
<li class="listitem"><p>GtkComboBox (id open_with) : label: "Open with", id open_with_label</p></li>
<li class="listitem"><p>GtkLabel (id total_files) : (hidden) label: "Total count of files", id total_files_label</p></li>
<li class="listitem"><p>GtkLabel (id total_size) : label: "Total Size of Files", id total_size_label</p></li>
<li class="listitem"><p>GtkLabel (id size_on_disk) : label: "Size on Disk", id size_on_disk_label</p></li>
<li class="listitem"><p>GtkLabel (id mtime) : label: "Last Modification", id mtime_label</p></li>
<li class="listitem"><p>GtkLabel (id atime) : label: "Last Access", id atime_label</p></li>
<li class="listitem"><p>GtkLabel (id ctime) : (hidden) label: "Last Permissions Change", id ctime_label</p></li>
</ul></div>
<p>Tab 2: id permissions_tab, contains items inside:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>GtkEntry (id owner) : label: "Owner", id owner_label</p></li>
<li class="listitem"><p>GtkEntry (id group) : label: "Group", id group_label</p></li>
<li class="listitem"><p>GtkComboBox (id read_perm) : label: "View content"</p></li>
<li class="listitem"><p>GtkComboBox (id write_perm) : label: "Change content"</p></li>
<li class="listitem"><p>GtkComboBox (id exec_perm) : label: "Execute", id exec_label</p></li>
<li class="listitem"><p>GtkComboBox (id flags_set_file) : label: "Special bits", id flags_label</p></li>
<li class="listitem"><p>GtkComboBox (id flags_set_dir) : share the place with flags_set_file</p></li>
<li class="listitem"><p>GtkCheckButton (id hidden) "Hidden file"</p></li>
</ul></div>
<p>Tab 3: id extra_tab (hidden), empty, label: id extra_tab_label</p>
<p>Since <a href="/usr/share/gtk-doc/html/gtk3/GtkTable.html#gtk-table-get-size"><code class="function">gtk_table_get_size()</code></a> is available only for GTK 2.22 ... GTK 3.4
it is not generally recommended to change size of GtkTable but be also
aware that <a href="/usr/share/gtk-doc/html/gtk3/GtkTable.html#gtk-table-attach"><code class="function">gtk_table_attach()</code></a> is marked deprecated in GTK 3.4 though.</p>
<p>Widget sets icon activatable if target file supports icon change. If
user changes icon then its name (either themed name or file path) will
be stored as GQuark fm_qdata_id in GtkImage "icon" (see above).</p>
<p>Widget sets name entry editable if target file supports renaming. Both
icon name and file name will be checked after extensions are finished
therefore extensions have a chance to reset the data and widget will
not do own processing.</p>
</div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fm-file-properties-add-for-mime-type"></a><h3>fm_file_properties_add_for_mime_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_file_properties_add_for_mime_type (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>,
<em class="parameter"><code><a class="link" href="libfm-File-properties-dialog.html#FmFilePropertiesExtensionInit" title="struct FmFilePropertiesExtensionInit"><span class="type">FmFilePropertiesExtensionInit</span></a> *callbacks</code></em>);</pre>
<p>Adds a handler for some mime type into file properties dialog. The
handler will be used if file properties dialog is opened for single
file or for few files of the same type to extend its functionality.
The value "*" of <em class="parameter"><code>mime_type</code></em>
has special meaning - the handler will
be used for file types where no other extension is applied. No
wildcards are allowed otherwise.</p>
<div class="refsect3">
<a name="id-1.2.6.15.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mime_type</p></td>
<td class="parameter_description"><p>mime type to add handler for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callbacks</p></td>
<td class="parameter_description"><p>table of handler callbacks</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.15.7.2.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if handler was added successfully.</p>
<p></p>
</div>
<p class="since">Since 1.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-file-properties-widget-new"></a><h3>fm_file_properties_widget_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkDialog.html"><span class="returnvalue">GtkDialog</span></a> *
fm_file_properties_widget_new (<em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmFileInfoList" title="FmFileInfoList"><span class="type">FmFileInfoList</span></a> *files</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> toplevel</code></em>);</pre>
<p>Creates new dialog widget for change properties of <em class="parameter"><code>files</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.6.15.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>files</p></td>
<td class="parameter_description"><p>list of files</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>toplevel</p></td>
<td class="parameter_description"><p>choose appearance of dialog</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.15.7.3.6"></a><h4>Returns</h4>
<p> a new widget. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-show-file-properties"></a><h3>fm_show_file_properties ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_show_file_properties (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmFileInfoList" title="FmFileInfoList"><span class="type">FmFileInfoList</span></a> *files</code></em>);</pre>
<p>Creates and shows file properties dialog for <em class="parameter"><code>files</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.6.15.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parent</p></td>
<td class="parameter_description"><p>a window to put dialog over it</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>files</p></td>
<td class="parameter_description"><p>list of files</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.15.7.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<p></p>
</div>
<p class="since">Since 0.1.0</p>
</div>
</div>
<div class="refsect1">
<a name="libfm-File-properties-dialog.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FM-MODULE-gtk-file-prop-VERSION"></a><h3>FM_MODULE_gtk_file_prop_VERSION</h3>
<pre class="programlisting">#define FM_MODULE_gtk_file_prop_VERSION 1
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-module-init-gtk-file-prop"></a><h3>fm_module_init_gtk_file_prop</h3>
<pre class="programlisting">extern FmFilePropertiesExtensionInit fm_module_init_gtk_file_prop;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmFilePropertiesExtensionInit"></a><h3>struct FmFilePropertiesExtensionInit</h3>
<pre class="programlisting">struct FmFilePropertiesExtensionInit {
gpointer (*init)(GtkBuilder *ui, gpointer uidata, FmFileInfoList *files);
void (*finish)(gpointer data, gboolean cancelled);
};
</pre>
<p>The structure describing callbacks for File Properties dialog extension
specific for some file type.</p>
<p>The <em class="parameter"><code>init</code></em>
callback is called before dialog window is opened. Callback
can disable or enable elements in dialog window, add triggers on those
elements, append new elements, etc. Callback gets three arguments: the
actual UI from builder, internal widget data pointer, and file infos
list. Internal widget data pointer may be used to block widget builtin
signal handler (that may be required if extension has own handler for
some GtkEntry element). Callback should return some own internal data
pointer which will be used as argument for <em class="parameter"><code>finish</code></em>
callback later.</p>
<p>The <em class="parameter"><code>finish</code></em>
callback is called before dialog window is closed. It gets
two arguments: the data pointer that was returned by <em class="parameter"><code>init</code></em>
callback
before and boolean value indicating if dialog was closed not by "OK"
button. Callback should free any resources allocated by <em class="parameter"><code>init</code></em>
callback
before.</p>
<p>This structure is used for "gtk_file_prop" module initialization. The
key for module of this type is content type (MIME name) to support.
The value "*" has special meaning - the module will be used for file
types where no other extension is applied. No wildcards are allowed
otherwise.</p>
<div class="refsect3">
<a name="id-1.2.6.15.8.4.8"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmFilePropertiesExtensionInit.init"></a>init</code></em> ()</p></td>
<td class="struct_member_description"><p>callback to make ui fields specific to file type</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="FmFilePropertiesExtensionInit.finish"></a>finish</code></em> ()</p></td>
<td class="struct_member_description"><p>callback to optionally apply changes</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.2.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|