From 4a2043cbd2d2fbe33d16af81ef9926a19093b987 Mon Sep 17 00:00:00 2001 From: William Jon McCann Date: Mon, 27 Jan 2014 21:35:14 -0500 Subject: [PATCH] docs: don't use footnotes Temporarily remove documentation for keybinding signals for GtkFileChooserDefault until we can find a way to add them properly. --- gtk/gtkfilechooser.c | 345 ------------------------------------------- gtk/gtktextmark.c | 9 +- gtk/gtktreemodel.c | 4 +- 3 files changed, 6 insertions(+), 352 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. * * - * - * Key Bindings - * - * Internally, GTK+ implements a file chooser's graphical user - * interface with the private - * GtkFileChooserDefaultClass. This - * widget has several key - * bindings and their associated signals. This section - * describes the available key binding signals. - * - * - * GtkFileChooser key binding example - * - * The default keys that activate the key-binding signals in - * GtkFileChooserDefaultClass are as - * follows: - * - * - * - * - * - * Signal name - * Default key combinations - * - * - * location-popup - * - * ControlL (empty path); - * / (path of "/") - * - * Both the individual / key and the - * numeric keypad's "divide" key are supported. - * ; - * ~ (path of "~") - * - * - * - * up-folder - * - * AltUp; - * AltShiftUp - * - * Both the individual Up key and the numeric - * keypad's Up key are supported. - * ; - * Backspace - * - * - * - * down-folder - * - * AltDown; - * AltShiftDown - * - * Both the individual Down key and the numeric - * keypad's Down key are supported. - * - * - * - * - * home-folder - * AltHome - * - * - * desktop-folder - * AltD - * - * - * quick-bookmark - * Alt1 through Alt0 - * - * - * - * - * - * You can change these defaults to something else. For - * example, to add a Shift modifier to a few - * of the default bindings, you can include the following - * fragment in your .config/gtk-3.0/gtk.css file: - * - * - * @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 - * } - * - * - * - * The "GtkFileChooserDefault::location-popup" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * const char *path, - * gpointer user_data); - * - * - * 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 - * path argument is a string that gets - * put in the text entry for the file name. By default this is bound to - * ControlL - * with a path string of "" (the empty - * string). It is also bound to / with a - * path string of "/" - * (a slash): this lets you type / and - * immediately type a path name. On Unix systems, this is bound to - * ~ (tilde) with a path string - * of "~" itself for access to home directories. - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * path : - * - * - * default contents for the text entry for the file name - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * You can create your own bindings for the - * #GtkFileChooserDefault::location-popup signal with custom - * path strings, and have a crude form - * of easily-to-type bookmarks. For example, say you access - * the path /home/username/misc very - * frequently. You could then create an - * Alt M - * shortcut by including the following in your - * .config/gtk-3.0/gtk.css: - * - * @binding-set MiscShortcut - * { - * bind "<Alt>M" { "location-popup" ("/home/username/misc") } - * } - * - * GtkFileChooserDefault - * { - * gtk-key-bindings: MiscShortcut - * } - * - * - * - * - * The "GtkFileChooserDefault::up-folder" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * gpointer user_data); - * - * - * 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 Backspace and - * AltUp - * (the Up key in the numeric keypad also works). - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * - * The "GtkFileChooserDefault::down-folder" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * gpointer user_data); - * - * - * 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/bar/baz", then this will cause - * the file chooser to switch to the "baz" subfolder. By - * default this is bound to - * AltDown - * (the Down key in the numeric keypad also works). - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * - * The "GtkFileChooserDefault::home-folder" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * gpointer user_data); - * - * - * This is used to make the file chooser show the user's home - * folder in the file list. By default this is bound to - * AltHome - * (the Home key in the numeric keypad also works). - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * - * The "GtkFileChooserDefault::desktop-folder" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * gpointer user_data); - * - * - * This is used to make the file chooser show the user's Desktop - * folder in the file list. By default this is bound to - * AltD. - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * - * The "GtkFileChooserDefault::quick-bookmark" signal - * - * void user_function (GtkFileChooserDefault *chooser, - * gint bookmark_index, - * gpointer user_data); - * - * - * This is used to make the file chooser switch to the bookmark - * specified in the bookmark_index 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 - * Alt1, - * Alt2, - * etc. until - * Alt0. Note - * that in the default binding, - * that Alt1 is - * actually defined to switch to the bookmark at index 0, and so on - * successively; - * Alt0 is - * defined to switch to the bookmark at index 10. - * - * - * - * chooser : - * - * - * the object which received the signal. - * - * - * - * - * bookmark_indes : - * - * - * index of the bookmark to switch to; the indices start at 0. - * - * - * - * - * user_data : - * - * - * user data set when the signal handler was connected. - * - * - * - * - * - * */ diff --git a/gtk/gtktextmark.c b/gtk/gtktextmark.c index 33b0649a6f..e8fa205ca6 100644 --- a/gtk/gtktextmark.c +++ b/gtk/gtktextmark.c @@ -73,11 +73,10 @@ * beginning of the newly-inserted text, and a mark with right * gravity will be moved to the end. * - * - * "left" and "right" here refer to logical direction (left is the toward the start - * of the buffer); in some languages such as Hebrew the logically-leftmost text is - * not actually on the left when displayed. - * + * Note that "left" and "right" here refer to logical direction (left + * is the toward the start of the buffer); in some languages such as + * Hebrew the logically-leftmost text is not actually on the left when + * displayed. * * Marks are reference counted, but the reference count only controls the validity * of the memory; marks can be deleted from the buffer at any time with diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c index 822b33b666..58b000f021 100644 --- a/gtk/gtktreemodel.c +++ b/gtk/gtktreemodel.c @@ -64,8 +64,8 @@ * query for the value of a model at a certain node and a certain * column on that node. There are two structures used to reference * a particular node in a model. They are the #GtkTreePath-struct and the - * #GtkTreeIter-structHere, iter is short - * for iterator. Most of the interface + * #GtkTreeIter-struct (iter is short + * for iterator). Most of the interface * consists of operations on a #GtkTreeIter-struct. * * A path is essentially a potential node. It is a location on a model