diff options
author | William Jon McCann <william.jon.mccann@gmail.com> | 2014-01-27 21:35:14 -0500 |
---|---|---|
committer | William Jon McCann <william.jon.mccann@gmail.com> | 2014-01-27 22:32:24 -0500 |
commit | 4a2043cbd2d2fbe33d16af81ef9926a19093b987 (patch) | |
tree | 4c51efaba0fa8b70ca900ab1b958b9a3d53d60d1 /gtk/gtkfilechooser.c | |
parent | 3d17e3f88c8e4ef7add2b5db1884dc6c43b1e884 (diff) | |
download | gtk+-4a2043cbd2d2fbe33d16af81ef9926a19093b987.tar.gz |
docs: don't use footnotes
Temporarily remove documentation for keybinding signals for
GtkFileChooserDefault until we can find a way to add them
properly.
Diffstat (limited to 'gtk/gtkfilechooser.c')
-rw-r--r-- | gtk/gtkfilechooser.c | 345 |
1 files changed, 0 insertions, 345 deletions
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c index 82eb85a3f8..0bee12305d 100644 --- a/gtk/gtkfilechooser.c +++ b/gtk/gtkfilechooser.c @@ -180,351 +180,6 @@ * the whole extra widget. * </note> * </refsect2> - * <refsect2 id="gtkfilechooser-key-bindings"> - * <title>Key Bindings</title> - * <para> - * Internally, GTK+ implements a file chooser's graphical user - * interface with the private - * <classname>GtkFileChooserDefaultClass</classname>. This - * widget has several <link linkend="gtk-Bindings">key - * bindings</link> and their associated signals. This section - * describes the available key binding signals. - * </para> - * <example id="gtkfilechooser-key-binding-example"> - * <title>GtkFileChooser key binding example</title> - * <para> - * The default keys that activate the key-binding signals in - * <classname>GtkFileChooserDefaultClass</classname> are as - * follows: - * </para> - * <informaltable> - * <tgroup cols="2"> - * <tbody> - * <row> - * <entry>Signal name</entry> - * <entry>Default key combinations</entry> - * </row> - * <row> - * <entry>location-popup</entry> - * <entry> - * <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo> (empty path); - * <keycap>/</keycap> (path of "/") - * <footnote> - * Both the individual <keycap>/</keycap> key and the - * numeric keypad's "divide" key are supported. - * </footnote>; - * <keycap>~</keycap> (path of "~") - * </entry> - * </row> - * <row> - * <entry>up-folder</entry> - * <entry> - * <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>; - * <keycombo><keycap>Alt</keycap><keycap>Shift</keycap><keycap>Up</keycap></keycombo> - * <footnote> - * Both the individual Up key and the numeric - * keypad's Up key are supported. - * </footnote>; - * <keycap>Backspace</keycap> - * </entry> - * </row> - * <row> - * <entry>down-folder</entry> - * <entry> - * <keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo>; - * <keycombo><keycap>Alt</keycap><keycap>Shift</keycap><keycap>Down</keycap></keycombo> - * <footnote> - * Both the individual Down key and the numeric - * keypad's Down key are supported. - * </footnote> - * </entry> - * </row> - * <row> - * <entry>home-folder</entry> - * <entry><keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo></entry> - * </row> - * <row> - * <entry>desktop-folder</entry> - * <entry><keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo></entry> - * </row> - * <row> - * <entry>quick-bookmark</entry> - * <entry><keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo> through <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo></entry> - * </row> - * </tbody> - * </tgroup> - * </informaltable> - * <para> - * You can change these defaults to something else. For - * example, to add a <keycap>Shift</keycap> modifier to a few - * of the default bindings, you can include the following - * fragment in your <filename>.config/gtk-3.0/gtk.css</filename> file: - * </para> - * <programlisting> - * @binding-set MyOwnFilechooserBindings - * { - * bind "<Alt><Shift>Up" { "up-folder" () } - * bind "<Alt><Shift>Down" { "down-folder" () } - * bind "<Alt><Shift>Home" { "home-folder" () } - * } - * - * GtkFileChooserDefault - * { - * gtk-key-bindings: MyOwnFilechooserBindings - * } - * </programlisting> - * </example> - * <refsect3 id="GtkFileChooserDefault-location-popup"> - * <title>The "GtkFileChooserDefault::location-popup" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * const char *path, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser show a "Location" - * dialog which the user can use to manually type the name of - * the file he wishes to select. The - * <parameter>path</parameter> argument is a string that gets - * put in the text entry for the file name. By default this is bound to - * <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo> - * with a <parameter>path</parameter> string of "" (the empty - * string). It is also bound to <keycap>/</keycap> with a - * <parameter>path</parameter> string of "<literal>/</literal>" - * (a slash): this lets you type <keycap>/</keycap> and - * immediately type a path name. On Unix systems, this is bound to - * <keycap>~</keycap> (tilde) with a <parameter>path</parameter> string - * of "~" itself for access to home directories. - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>path</parameter> :</term> - * <listitem> - * <simpara> - * default contents for the text entry for the file name - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * <note> - * You can create your own bindings for the - * #GtkFileChooserDefault::location-popup signal with custom - * <parameter>path</parameter> strings, and have a crude form - * of easily-to-type bookmarks. For example, say you access - * the path <filename>/home/username/misc</filename> very - * frequently. You could then create an <keycombo> - * <keycap>Alt</keycap> <keycap>M</keycap> </keycombo> - * shortcut by including the following in your - * <filename>.config/gtk-3.0/gtk.css</filename>: - * <programlisting> - * @binding-set MiscShortcut - * { - * bind "<Alt>M" { "location-popup" ("/home/username/misc") } - * } - * - * GtkFileChooserDefault - * { - * gtk-key-bindings: MiscShortcut - * } - * </programlisting> - * </note> - * </refsect3> - * <refsect3 id="GtkFileChooserDefault-up-folder"> - * <title>The "GtkFileChooserDefault::up-folder" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser go to the parent of - * the current folder in the file hierarchy. By default this - * is bound to <keycap>Backspace</keycap> and - * <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo> - * (the Up key in the numeric keypad also works). - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * </refsect3> - * <refsect3 id="GtkFileChooserDefault-down-folder"> - * <title>The "GtkFileChooserDefault::down-folder" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser go to a child of the - * current folder in the file hierarchy. The subfolder that - * will be used is displayed in the path bar widget of the file - * chooser. For example, if the path bar is showing - * "/foo/<emphasis>bar/</emphasis>baz", then this will cause - * the file chooser to switch to the "baz" subfolder. By - * default this is bound to - * <keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo> - * (the Down key in the numeric keypad also works). - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * </refsect3> - * <refsect3 id="GtkFileChooserDefault-home-folder"> - * <title>The "GtkFileChooserDefault::home-folder" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser show the user's home - * folder in the file list. By default this is bound to - * <keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo> - * (the Home key in the numeric keypad also works). - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * </refsect3> - * <refsect3 id="GtkFileChooserDefault-desktop-folder"> - * <title>The "GtkFileChooserDefault::desktop-folder" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser show the user's Desktop - * folder in the file list. By default this is bound to - * <keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo>. - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * </refsect3> - * <refsect3 id="GtkFileChooserDefault-quick-bookmark"> - * <title>The "GtkFileChooserDefault::quick-bookmark" signal</title> - * <programlisting> - * void user_function (GtkFileChooserDefault *chooser, - * gint bookmark_index, - * <link linkend="gpointer">gpointer</link> user_data); - * </programlisting> - * <para> - * This is used to make the file chooser switch to the bookmark - * specified in the <parameter>bookmark_index</parameter> parameter. - * For example, if you have three bookmarks, you can pass 0, 1, 2 to - * this signal to switch to each of them, respectively. By default this is bound to - * <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo>, - * <keycombo><keycap>Alt</keycap><keycap>2</keycap></keycombo>, - * etc. until - * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo>. Note - * that in the default binding, - * that <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo> is - * actually defined to switch to the bookmark at index 0, and so on - * successively; - * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo> is - * defined to switch to the bookmark at index 10. - * </para> - * <variablelist role="params"> - * <varlistentry> - * <term><parameter>chooser</parameter> :</term> - * <listitem> - * <simpara> - * the object which received the signal. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>bookmark_indes</parameter> :</term> - * <listitem> - * <simpara> - * index of the bookmark to switch to; the indices start at 0. - * </simpara> - * </listitem> - * </varlistentry> - * <varlistentry> - * <term><parameter>user_data</parameter> :</term> - * <listitem> - * <simpara> - * user data set when the signal handler was connected. - * </simpara> - * </listitem> - * </varlistentry> - * </variablelist> - * </refsect3> - * </refsect2> */ |