271 lines
14 KiB
XML
271 lines
14 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="GimpPathEditor">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="GimpPathEditor.top_of_page">GimpPathEditor</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpPathEditor</refname>
|
|
<refpurpose>Widget for editing a file search path.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="GimpPathEditor.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="GimpPathEditor-struct">GimpPathEditor</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-path-editor-new">gimp_path_editor_new</link> (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *path);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-path">gimp_path_editor_get_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
|
|
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-path">gimp_path_editor_set_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *path);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
|
|
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-writable-path">gimp_path_editor_set_writable_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *path);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *directory);
|
|
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-dir-writable">gimp_path_editor_set_dir_writable</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *directory,
|
|
<link linkend="gboolean">gboolean</link> writable);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id="GimpPathEditor.object-hierarchy" role="object_hierarchy">
|
|
<title role="object_hierarchy.title">Object Hierarchy</title>
|
|
<synopsis>
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
|
|
+----<link linkend="GtkObject">GtkObject</link>
|
|
+----<link linkend="GtkWidget">GtkWidget</link>
|
|
+----<link linkend="GtkContainer">GtkContainer</link>
|
|
+----<link linkend="GtkBox">GtkBox</link>
|
|
+----<link linkend="GtkVBox">GtkVBox</link>
|
|
+----GimpPathEditor
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpPathEditor.implemented-interfaces" role="impl_interfaces">
|
|
<title role="impl_interfaces.title">Implemented Interfaces</title>
|
|
<para>
|
|
GimpPathEditor implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpPathEditor.signals" role="signal_proto">
|
|
<title role="signal_proto.title">Signals</title>
|
|
<synopsis>
|
|
"<link linkend="GimpPathEditor-path-changed">path-changed</link>" : Run First
|
|
"<link linkend="GimpPathEditor-writable-changed">writable-changed</link>" : Run First
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="GimpPathEditor.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
This widget is used to edit file search paths.
|
|
</para>
|
|
<para>
|
|
It shows a list of all directories which are in the search path. You
|
|
can click a directory to select it. The widget provides a
|
|
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> to change the currently selected directory.
|
|
</para>
|
|
<para>
|
|
There are buttons to add or delete directories as well as "up" and "down"
|
|
buttons to change the order in which the directories will be searched.
|
|
</para>
|
|
<para>
|
|
Whenever the user adds, deletes, changes or reorders a directory of
|
|
the search path, the "path_changed" signal will be emitted.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="GimpPathEditor.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="GimpPathEditor-struct" role="struct">
|
|
<title>GimpPathEditor</title>
|
|
<indexterm zone="GimpPathEditor-struct"><primary>GimpPathEditor</primary></indexterm><programlisting>typedef struct _GimpPathEditor GimpPathEditor;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-path-editor-new" role="function">
|
|
<title>gimp_path_editor_new ()</title>
|
|
<indexterm zone="gimp-path-editor-new"><primary>gimp_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_path_editor_new (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
|
|
</para>
|
|
<para>
|
|
The elements of the initial search path must be separated with the
|
|
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>title</parameter> :</term>
|
|
<listitem><simpara> The title of the <link linkend="GtkFileChooser"><type>GtkFileChooser</type></link> dialog which can be popped up.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>path</parameter> :</term>
|
|
<listitem><simpara> The initial search path.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-get-path" role="function">
|
|
<title>gimp_path_editor_get_path ()</title>
|
|
<indexterm zone="gimp-path-editor-get-path"><primary>gimp_path_editor_get_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
|
|
<para>
|
|
The elements of the returned search path string are separated with the
|
|
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
|
|
</para>
|
|
<para>
|
|
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara> The path editor you want to get the search path from.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The search path the user has selected in the path editor.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-set-path" role="function">
|
|
<title>gimp_path_editor_set_path ()</title>
|
|
<indexterm zone="gimp-path-editor-set-path"><primary>gimp_path_editor_set_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
|
<para>
|
|
The elements of the initial search path must be separated with the
|
|
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara> The path editor you want to set the search path from.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>path</parameter> :</term>
|
|
<listitem><simpara> The new path to set.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-get-writable-path" role="function">
|
|
<title>gimp_path_editor_get_writable_path ()</title>
|
|
<indexterm zone="gimp-path-editor-get-writable-path"><primary>gimp_path_editor_get_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_writable_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-set-writable-path" role="function">
|
|
<title>gimp_path_editor_set_writable_path ()</title>
|
|
<indexterm zone="gimp-path-editor-set-writable-path"><primary>gimp_path_editor_set_writable_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_writable_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>path</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-get-dir-writable" role="function">
|
|
<title>gimp_path_editor_get_dir_writable ()</title>
|
|
<indexterm zone="gimp-path-editor-get-dir-writable"><primary>gimp_path_editor_get_dir_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_editor_get_dir_writable (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *directory);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>directory</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-path-editor-set-dir-writable" role="function">
|
|
<title>gimp_path_editor_set_dir_writable ()</title>
|
|
<indexterm zone="gimp-path-editor-set-dir-writable"><primary>gimp_path_editor_set_dir_writable</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_dir_writable (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
|
const <link linkend="gchar">gchar</link> *directory,
|
|
<link linkend="gboolean">gboolean</link> writable);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>editor</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>directory</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>writable</parameter> :</term>
|
|
<listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 id="GimpPathEditor.signal-details" role="signals">
|
|
<title role="signals.title">Signal Details</title>
|
|
<refsect2 id="GimpPathEditor-path-changed"><title>The <literal>"path-changed"</literal> signal</title>
|
|
<indexterm zone="GimpPathEditor-path-changed"><primary>GimpPathEditor::path-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
|
|
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
|
|
<para>
|
|
This signal is emitted whenever the user adds, deletes, modifies
|
|
or reorders an element of the search path.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2><refsect2 id="GimpPathEditor-writable-changed"><title>The <literal>"writable-changed"</literal> signal</title>
|
|
<indexterm zone="GimpPathEditor-writable-changed"><primary>GimpPathEditor::writable-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *arg0,
|
|
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
|
|
<para>
|
|
This signal is emitted whenever the "writable" column of a directory
|
|
is changed, either by the user clicking on it or by calling
|
|
<link linkend="gimp-path-editor-set-dir-writable"><function>gimp_path_editor_set_dir_writable()</function></link>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="GimpPathEditor.see-also">
|
|
<title>See Also</title>
|
|
<para>
|
|
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link>
|
|
</para>
|
|
<para>
|
|
<link linkend="G-SEARCHPATH-SEPARATOR:CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|