diff --git a/doc/ChangeLog b/doc/ChangeLog index 6bc29993c..f13c3b256 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,22 @@ +2003-07-04 Duncan Mak + + * en/Gtk/AccelGroup.xml: revert parts of my last patch, as some of + the links do not resolve due to bug #38538. + + * en/Gtk/Button.xml (NewFromLabel): + (NewFromStock): documented. + + * en/Gtk/Frame.xml (GetLabelAlign): documented. + + * en/Gtk/IconFactory.xml: + * en/Gtk/IconSet.xml: + * en/Gtk/IconSize.xml: + * en/Gtk/IconSource.xml: documented. + + * en/Gtk/Paned.xml: added documentation for the events. + + * en/Gtk/ResponseType.xml: documented. + 2003-07-02 John Luke * en/Gtk/Container.xml: add first draft diff --git a/doc/en/Gtk/AccelGroup.xml b/doc/en/Gtk/AccelGroup.xml index 09c994b90..d8293bbe1 100644 --- a/doc/en/Gtk/AccelGroup.xml +++ b/doc/en/Gtk/AccelGroup.xml @@ -12,11 +12,11 @@ A GtkAccelGroup represents a group of keyboard accelerators, typically attached to a toplevel GtkWindow (with ). Usually - you won't need to create a Gtk.AccelGroup directly; instead, - when using , Gtk# - automatically sets up the accelerators for your menus in the - item factory's . + cref="M:Gtk.Window.AddAccelGroup(Gtk.AccelGroup)" />). Usually + you won't need to create a + directly; instead, when using , Gtk# automatically sets up the accelerators for your menus + in the item factory's . Note that accelerators are different from @@ -25,8 +25,9 @@ for. For example "Ctrl+Q" might appear alongside the "Quit" menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined - characters. See . Menu items can - have both accelerators and mnemonics, of course. + characters. . Menu + items can have both accelerators and mnemonics, of course. @@ -55,7 +56,8 @@ Finds the to which closure is connected. A GClosure () - The to which is connected, or . + The to which is connected, or . @@ -67,7 +69,7 @@ - Undoes the last call to on its object. + Undoes the last call to on its object. @@ -81,7 +83,8 @@ - Removes an accelerator previously installed through . + Removes an accelerator previously installed through + . The closure to remove from this accelerator group. if the closure was found and got disconnected @@ -99,15 +102,14 @@ - - Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers - (see )). When the + Installs an accelerator in this group, using an + accelerator path to look up the appropriate key and modifiers + (see 'gtk_accel_map_add_entry'). When the group is being activated in response to a call to , will be invoked if the accel_key and - accel_mods from - match the key and modifiers for the path. - + cref="M:Gtk.AccelGroup.Activate" />, will be invoked if the accel_key and + accel_mods from + match the key and modifiers for the path. Path used for determining key and modifiers. Closure to be executed upon accelerator activation @@ -139,7 +141,7 @@ - Removes an accelerator previously installed through . + Removes an accelerator previously installed through . Key value of the accelerator. Modifier combination of the accelerator. @@ -162,7 +164,7 @@ Key value of the accelerator. Modifier combination of the accelerator. Location to return the number of entries found, or . - An array of n_entries elements, or . + An array of elements, or . @@ -174,7 +176,12 @@ Locks the given accelerator group. - Locking an accelerator group prevents the accelerators contained within it to be changed during runtime. Refer to about runtime accelerator changes. If called more than once, accel_group remains locked until has been called an equivalent number of times. + Locking an accelerator group prevents the + accelerators contained within it to be changed duringb + runtime. Refer to 'gtk_accel_map_change_entry ()' about + runtime accelerator changes. If called more than once, it + remains locked until + has been called an equivalent number of times. @@ -191,7 +198,15 @@ - Installs an accelerator in this group. When accel_group is being activated in response to a call to , closure will be invoked if the accel_key and accel_mods from match those of this connection. The signature used for the closure is that of . + + Installs an accelerator in this group. When accel_group is + being activated in response to a call to , closure will be + invoked if the accel_key and accel_mods from match those of this + connection. The signature used for the closure is that of + . + Key value of the accelerator. Modifier combination of the accelerator. A flag mask to configure this accelerator. diff --git a/doc/en/Gtk/Button.xml b/doc/en/Gtk/Button.xml index cef08233d..3c8a57b3b 100644 --- a/doc/en/Gtk/Button.xml +++ b/doc/en/Gtk/Button.xml @@ -244,10 +244,13 @@ public class ButtonApp { - To be added - an object of type - an object of type - To be added + Creates a widget with a child containing the given text. + + The text you want the to hold. + + The newly created widget. + @@ -260,10 +263,13 @@ public class ButtonApp { - To be added - an object of type - an object of type - To be added + Creates a new containing the image and text from a stock item. + The name of the stock item + a new + + The valid names of Stock items can be found in the class. + diff --git a/doc/en/Gtk/Frame.xml b/doc/en/Gtk/Frame.xml index 96636fa43..c7bf6c321 100644 --- a/doc/en/Gtk/Frame.xml +++ b/doc/en/Gtk/Frame.xml @@ -243,10 +243,10 @@ - To be added - To be added: an object of type 'float&' - To be added: an object of type 'float&' - To be added + Retrieves the X and Y alignment of the frame's label. + Location to store X alignment of frame's label + Location to store Y alignment of frame's label + diff --git a/doc/en/Gtk/IconFactory.xml b/doc/en/Gtk/IconFactory.xml index 6dd9d2886..8c97469c8 100644 --- a/doc/en/Gtk/IconFactory.xml +++ b/doc/en/Gtk/IconFactory.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An icon factory manages a collection of Gtk.IconSet + GLib.Object @@ -33,10 +33,19 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.IconSet' - To be added + Looks for an icon in the list of default icon factories. + an icon name + + a , or . + + + Looks for an icon in the list of default icon factories. For + display to the user, you should use + on the for the widget + that will display the icon, instead of using this function + directly, so that themes are taken into account. + @@ -47,8 +56,20 @@ - To be added - To be added + + Adds an icon factory to the list of icon factories searched + by . + + + Adds an icon factory to the list of icon factories searched + by . This means that, for example, will be + able to find icons in factory. There will normally be an + icon factory added for each library or application that + comes with icons. The default icon factories can be + overridden by themes. + @@ -62,10 +83,27 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.IconSet' - To be added + + Adds the given to the icon factory, under the name + . + + The icon's name + The icon set + + Adds the given to the icon factory, under the name + . should be namespaced for your + application, e.g. "myapp-name-of-icon". Normally + applications create a , then add it to the + list of default factories with + . They pass the + to widgets such as to display the icon. Themes can + provide an icon with the same name (such as + "myapp-name-of-icon") to override your application's + default icons. If an icon already existed in factory for + , it is unreferenced and replaced with the new + . + @@ -78,10 +116,21 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.IconSet' - To be added + + Looks up a Stock ID in the icon factory. + + an icon name + + a , or . + + + Looks up in the icon factory, returning an icon set + if found, otherwise . For display to the user, you + should use on the + for + the widget that will display the icon, instead of using this + function directly, so that themes are taken into account. + @@ -92,8 +141,14 @@ - To be added - To be added + + Removes an icon factory from the list of default icon factories. + + + Removes an icon factory from the list of default icon + factories. Not normally used; you might use it for a library + that can be unloaded or shut down. + @@ -130,9 +185,25 @@ - To be added - To be added: an object of type 'Gtk.IconFactory' - To be added + Creates a new . + A new . + + Creates a new . An icon factory manages a + collection of s; a manages a set of + variants of a particular icon (i.e. a GtkIconSet contains + variants for different sizes and widget states). Icons in an + icon factory are named by a stock ID, which is a simple + string identifying the icon. Each has a list of + GtkIconFactorys derived from the current theme; those icon + factories are consulted first when searching for an icon. If + the theme doesn't set a particular icon, GTK+ looks for the + icon in a list of default icon factories, maintained by + and + . Applications with icons + should add a default icon factory with their icons, which + will allow themes to override the icons for the application. + @@ -173,10 +244,13 @@ - To be added - To be added: an object of type 'Gtk.IconSize' - To be added: an object of type 'Drawing.Size' - To be added + Obtains the pixel size of a semantic icon size. + a + + the size of the parameter, + as a . + + @@ -191,11 +265,11 @@ - To be added - To be added: an object of type 'Gtk.IconSize' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added + Obtains the pixel size of a semantic icon size + an icon size + an integer to store the icon's width + an integer to store the icon's height + diff --git a/doc/en/Gtk/IconSet.xml b/doc/en/Gtk/IconSet.xml index 92c5b1c67..3fcf48de4 100644 --- a/doc/en/Gtk/IconSet.xml +++ b/doc/en/Gtk/IconSet.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + A represents a single icon in various sizes and widget states. + + + A represents a single icon in + various sizes and widget states. It can provide a for a given size and state on request, + and automatically caches some of the rendered GdkPixbuf objects. + GLib.Opaque @@ -35,15 +42,35 @@ - To be added - To be added: an object of type 'Gtk.Style' - To be added: an object of type 'Gtk.TextDirection' - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gtk.IconSize' - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'Gdk.Pixbuf' - To be added + + Renders an icon using + + + a associated with widget, or + + The text direction + The widget state + The size of the icon + + widget that will display the icon, or + + + detail to pass to the theme engine, or + + a to be displayed + + Renders an icon using . In + most cases, is better, since it automatically provides most of the arguments from the + current widget settings. This function never returns ; + if the icon can't be rendered (perhaps because an image file + fails to load), a default "missing image" icon will be + returned instead. + @@ -57,7 +84,7 @@ - To be added + This method needs fixing, the signature is incorrect To be added: an object of type 'Gtk.IconSize' To be added: an object of type 'int' To be added @@ -71,9 +98,11 @@ - To be added - To be added: an object of type 'Gtk.IconSet' - To be added + + Copy the IconSet by value. + + a copy of the current IconSet + @@ -86,9 +115,50 @@ - To be added + + Adds an IconSource to the current IconSet. + To be added: an object of type 'Gtk.IconSource' - To be added + + + Icon sets have a list of , + which they use as base icons for rendering icons in + different states and sizes. Icons are scaled, made to look + insensitive, etc. in , + but needs base images to work + with. The base images and when to use them are described + by a . + + + + This function copies , so you can reuse the same + source immediately without affecting the icon set. + + + An example of when you'd use this function: a web + browser's "Back to Previous Page" icon might point in a + different direction in Hebrew and in English; it might + look different when insensitive; and it might change size + depending on toolbar mode (small/large icons). So a single + icon set would contain all those variants of the icon, and + you might add a separate source for each one. + + + You should nearly always add a "default" icon source with + all fields wildcarded, which will be used as a fallback if + no more specific source matches. always prefers more specific icon sources to more + generic icon sources. The order in which you add the + sources to the icon set does not matter. + + + + This constructor + creates a new icon set with a default icon source based on + the given pixbuf. + + @@ -99,9 +169,9 @@ - To be added - To be added: an object of type 'Gtk.IconSet' - To be added + Increments the reference count. + the IconSet with the incremented reference count + @@ -112,8 +182,11 @@ - To be added - To be added + Decrements the reference count + + Decrements the reference count, and frees memory + if the reference count reaches 0. + @@ -138,9 +211,16 @@ - To be added - To be added: an object of type 'Gtk.IconSet' - To be added + + Creates a new . A represents a single + icon in various sizes and widget states. It can provide a + for a given size and state on request, and + automatically caches some of the rendered objects. + + a new IconSet + @@ -151,10 +231,14 @@ - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gtk.IconSet' - To be added + + Creates a new with as the default/fallback source image. + + + a + + an . + diff --git a/doc/en/Gtk/IconSize.xml b/doc/en/Gtk/IconSize.xml index 1ee29fb8c..de262249b 100644 --- a/doc/en/Gtk/IconSize.xml +++ b/doc/en/Gtk/IconSize.xml @@ -7,8 +7,13 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + The possible icon sizes + + + This class contains all the valid icon sizes that is supported + by Gtk. + + System.Enum @@ -34,8 +39,8 @@ - To be added - To be added + This signifies an unsupported icon size. + @@ -46,8 +51,8 @@ - To be added - To be added + The icon size for a . + @@ -58,8 +63,8 @@ - To be added - To be added + The icon size for a small + @@ -70,8 +75,8 @@ - To be added - To be added + The icon size for a large . + @@ -82,8 +87,8 @@ - To be added - To be added + The icon size for a . + @@ -94,8 +99,8 @@ - To be added - To be added + The icon size used during a drag-n-drop operation. + @@ -106,8 +111,8 @@ - To be added - To be added + The icon size used in a + diff --git a/doc/en/Gtk/IconSource.xml b/doc/en/Gtk/IconSource.xml index 3bab027b8..a3273c263 100644 --- a/doc/en/Gtk/IconSource.xml +++ b/doc/en/Gtk/IconSource.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,56 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + A GtkIconSource contains a (or image + filename) that serves as the base image for one or more of the + icons in a , along with a + specification for which icons in the icon set will be based on + that pixbuf or image file. An icon set contains a set of icons + that represent the same logical concept in different states, + different global text directions, and different sizes. + + + + A GtkIconSource contains a (or image + filename) that serves as the base image for one or more of the + icons in a , along with a + specification for which icons in the icon set will be based on + that pixbuf or image file. An icon set contains a set of icons + that represent the same logical concept in different states, + different global text directions, and different sizes. + + + So for example a web browser's "Back to Previous Page" icon + might point in a different direction in Hebrew and in English; + it might look different when insensitive; and it might change + size depending on toolbar mode (small/large icons). So a + single icon set would contain all those variants of the + icon. contains a list of from which + it can derive specific icon variants in the set. + + + In the simplest case, contains + one source pixbuf from which it derives all variants. The + constructor handles + this case; if you only have one source pixbuf, just use that + function. + + + If you want to use a different base pixbuf for different icon + variants, you create multiple icon sources, mark which + variants they'll be used to create, and add them to the icon + set with . + + + By default, the icon source has all parameters + wildcarded. That is, the icon source will be used as the base + icon for any desired text direction, widget state, or icon + size. + + GLib.Opaque @@ -28,9 +76,15 @@ - To be added - To be added: an object of type 'Gtk.IconSource' - To be added + + Creates a copy of the current ; mostly useful for language + bindings. + + + a new GtkIconSource that is a copy of the current one + + @@ -41,8 +95,8 @@ - To be added - To be added + Frees a dynamically-allocated icon source, along with its filename, size, and pixbuf fields. + @@ -67,9 +121,9 @@ - To be added - To be added: an object of type 'Gtk.IconSource' - To be added + Creates a new . + a new . + @@ -94,10 +148,38 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + If the widget state is wildcarded, this source can be used + as the base image for an icon in any . + + + Whether or not the widget is wildcarded. + + + + If the widget state is wildcarded, this source can be used + as the base image for an icon in any . If the + widget state is not wildcarded, then the state the source + applies to should be set with + and the icon source will only be used with that specific + state. + + + prefers non-wildcarded + sources (exact matches) over wildcarded sources, and will + use an exact match when possible. + + + will normally transform + wildcarded source images to produce an appropriate icon + for a given state, for example lightening an image on + prelight, but will not modify source images that match + exactly. + + @@ -110,10 +192,38 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + If the icon size is wildcarded, this source can be used as + the base image for an icon of any size. If the size is not + wildcarded, then the size the source applies to should be + set with and the icon + source will only be used with that specific size. + + + if the size is wildcarded, + otherwise. + + Whether the size is wildcarded or not + + + If the icon size is wildcarded, this source can be used as + the base image for an icon of any size. If the size is not + wildcarded, then the size the source applies to should be + set with and the icon + source will only be used with that specific size. + + + prefers non-wildcarded + sources (exact matches) over wildcarded sources, and will + use an exact match when possible. + + + will normally scale + wildcarded source images to produce an appropriate icon at + a given size, but will not change the size of source + images that match exactly. + + @@ -126,10 +236,18 @@ - To be added + + The base image used when creating icon variants of a + To be added: an object of type 'Gdk.Pixbuf' - To be added: an object of type 'Gdk.Pixbuf' - To be added + the source pixbuf, or if none is set. + + + If an icon source has both a filename and a pixbuf set, the + pixbuf will take priority. + + @@ -142,10 +260,22 @@ - To be added - To be added: an object of type 'Gtk.TextDirection' - To be added: an object of type 'Gtk.TextDirection' - To be added + + The text direction this icon source applies to. + + The text direction this source applies to + + Obtains the text direction this icon source applies to. The + return value is only useful/meaningful if the text direction + is not wildcarded. + + + Setting the text direction on an icon source makes no + difference if the text direction is wildcarded. Therefore, + you should usually set the property to + un-wildcard it in addition to calling this function. + @@ -158,10 +288,21 @@ - To be added - To be added: an object of type 'Gtk.IconSize' - To be added: an object of type 'Gtk.IconSize' - To be added + + The icon size this icon source is intended to be used with. + + The icon size this source applies to + + Obtains the icon size this source applies to. The return + value is only useful/meaningful if the icon size is not + wildcarded. + + + Setting the icon size on an icon source makes no difference + if the size is wildcarded. Therefore, you should usually set + the property + to un-wildcard it in addition to calling this function. + @@ -174,10 +315,22 @@ - To be added - To be added: an object of type 'Gtk.StateType' - To be added: an object of type 'Gtk.StateType' - To be added + + The widget state this icon source applies to. + + The widget state this icon source applies to. + + Obtains the widget state this icon source applies to. The + return value is only useful/meaningful if the widget state + is not wildcarded. + + + Setting the widget state on an icon source makes no + difference if the state is wildcarded. Therefore, you should + usually set the propertyto un-wildcard it in addition to calling this + function. + @@ -190,10 +343,32 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + If the text direction is wildcarded, this source can be used + as the base image for an icon in any . + + + if the text direction is wildcarded, + otherwise. + + Whether the text direction is wildcarded or not + + + If the text direction is wildcarded, this source can be + used as the base image for an icon in any . If the text direction is + not wildcarded, then the text direction the icon source + applies to should be set with , and the icon source + will only be used with that text direction. + + + prefers non-wildcarded + sources (exact matches) over wildcarded sources, and will + use an exact match when possible. + + @@ -206,10 +381,21 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + + Retrieves the source filename, or if none is set. + + + Sets the name of an image file to use as a base image when + creating icon variants for . The filename must be + absolute. + + + Retrieves the source filename, or if + none is set. The filename is not a copy, and should not be + modified or expected to persist beyond the lifetime of the + icon source. + + diff --git a/doc/en/Gtk/Paned.xml b/doc/en/Gtk/Paned.xml index a9633bdb3..dbc79fd70 100644 --- a/doc/en/Gtk/Paned.xml +++ b/doc/en/Gtk/Paned.xml @@ -258,8 +258,17 @@ public Widget GetExampleFrame() - To be added - To be added + + Emitted when paned has the focus and one of the tab key + combinations are pressed. + + + This signal is emitted when paned has the focus and any of + the Tab, Ctrl-Tab, Shift-Tab or Ctrl-Shift-Tab keys + combinations are pressed. Tab and Ctrl-Tab set reversed to + while Shift-Tab and Ctrl-Shift-Tab + set reversed to . + @@ -268,8 +277,10 @@ public Widget GetExampleFrame() - To be added - To be added + + Emitted when paned has the focus and the separator is moved. + + @@ -278,8 +289,10 @@ public Widget GetExampleFrame() - To be added - To be added + + Emitted when the Esc key is pressed while paned has the focus. + + @@ -288,8 +301,12 @@ public Widget GetExampleFrame() - To be added - To be added + Emitted when the paned has focus + + This signal is emitted when paned has the focus and any of + the Return, Enter, Space keys are pressed. This will also + cause the child widget with the focus to be activated. + @@ -298,8 +315,10 @@ public Widget GetExampleFrame() - To be added - To be added + + Emitted when paned has the focus and F8 is pressed to give the focus to or take the focus from the separator handle. + + @@ -308,8 +327,8 @@ public Widget GetExampleFrame() - To be added - To be added + Emitted when F6 or Shift-F6 is pressed while paned has the focus. + diff --git a/doc/en/Gtk/ResponseType.xml b/doc/en/Gtk/ResponseType.xml index b55790531..5ecc1f2f6 100644 --- a/doc/en/Gtk/ResponseType.xml +++ b/doc/en/Gtk/ResponseType.xml @@ -7,8 +7,17 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + This enumeration contains the response signals that are emitted by a . + + + When a button in a is pressed, a + response signal is emitted with a response ID. While positive + responses are entirely user-defined, the enumeration (all the members have + values less than zero) could be also be used instead for + convience. + System.Enum @@ -34,8 +43,11 @@ - To be added - To be added + + This is returned if a response widget has no response ID, or + has been programmatically hidden or destroyed. + + @@ -46,8 +58,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -58,8 +72,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -70,8 +86,8 @@ - To be added - To be added + This is returned when the dialog is deleted. + @@ -82,8 +98,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -94,8 +112,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -106,8 +126,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -118,8 +140,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -130,8 +154,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -142,8 +168,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + + @@ -154,8 +182,10 @@ - To be added - To be added + + Convenience response type to be used in the constructors of the class. + +