diff --git a/doc/ChangeLog b/doc/ChangeLog index fdfa42de7..e4c481ee9 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2004-08-05 Shane Landrum + + * en/Gtk/Rc*: Filled in all "to be added" for RC-file + subsystem. + * en/Gtk/Accel*: Added docs about accelerator keys. + 2004-08-04 Shane Landrum * en/Gtk/*: docs for many tree-related methods, diff --git a/doc/en/Gtk/Accel.xml b/doc/en/Gtk/Accel.xml index d81562a4a..24b108ec8 100644 --- a/doc/en/Gtk/Accel.xml +++ b/doc/en/Gtk/Accel.xml @@ -238,8 +238,8 @@ Accel map entries whose accel path matches one of the filters are skipped - by - this function is intended for gtk-sharp modules that create their own menus, but dont want + by . + This function is intended for gtk-sharp modules that create their own menus but don't want them to be saved into the applications accelerator map dump. @@ -294,4 +294,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelChangedArgs.xml b/doc/en/Gtk/AccelChangedArgs.xml index f588f3c79..b9b0e94c2 100644 --- a/doc/en/Gtk/AccelChangedArgs.xml +++ b/doc/en/Gtk/AccelChangedArgs.xml @@ -51,9 +51,9 @@ Gdk.ModifierType - To be added - To be added: an object of type 'Gdk.ModifierType' - To be added + Gets the state of the Shift, Control, Alt, and other modifier keys and mouse buttons. + An object of type + @@ -63,10 +63,10 @@ System.UInt32 - To be added - To be added: an object of type 'uint' - To be added + Gets the key value for the accelerator event. + An object of type 'uint' + - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelFlags.xml b/doc/en/Gtk/AccelFlags.xml index 995072bee..ecb2a15f3 100644 --- a/doc/en/Gtk/AccelFlags.xml +++ b/doc/en/Gtk/AccelFlags.xml @@ -13,7 +13,7 @@ An enumeration used by AccelLabel - This enumeration is used by to see decide to display or not display an accelerator key and to know if an accelerator key is removable. + This enumeration is used by to decide to display or not display an accelerator key and to know if an accelerator key is removable. @@ -91,4 +91,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelGroup.xml b/doc/en/Gtk/AccelGroup.xml index 3b315f662..a8f607848 100644 --- a/doc/en/Gtk/AccelGroup.xml +++ b/doc/en/Gtk/AccelGroup.xml @@ -208,9 +208,9 @@ - To be added - To be added: an object of type 'Gtk.AccelGroup' - To be added + Default public constructor. + A new . + @@ -235,10 +235,10 @@ - To be added - a - a - To be added + Finds the first entry in an accelerator group for which returns TRUE and returns its . + a for filtering the AccelGroup entries + a , the first key matching the find function. It is owned by Gtk# and must not be freed. + @@ -309,4 +309,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelGroupEntry.xml b/doc/en/Gtk/AccelGroupEntry.xml index 531f2f214..cd57a215e 100644 --- a/doc/en/Gtk/AccelGroupEntry.xml +++ b/doc/en/Gtk/AccelGroupEntry.xml @@ -69,9 +69,9 @@ - To be added - To be added + A containing an integer/string mapping for the path to accelerate. + See the notes for for details on the formatting of the path string. - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelKey.xml b/doc/en/Gtk/AccelKey.xml index cb2432aac..6852fd0c6 100644 --- a/doc/en/Gtk/AccelKey.xml +++ b/doc/en/Gtk/AccelKey.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A class for holding information about a key that gets used as an accelerator. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Make a new AccelKey object that has no global object key. + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.AccelKey' - To be added + Make a new AccelKey object with the object key specified by . + an + An object of type + @@ -56,8 +56,8 @@ - To be added - To be added + A mask of the modifier keys that are relevant for this AccelKey. + @@ -69,8 +69,8 @@ - To be added - To be added + The flags for this AccelKey that determine whether will display it. + @@ -82,8 +82,8 @@ - To be added - To be added + The main keyboard key to use for this AccelKey. + Useful values are enumerated in . @@ -97,12 +97,12 @@ To be added - a - a - a + a enumerated in + a enumerated in , the modifiers (shift, ctrl, etc) that apply for this AccelKey + a enumerated in for whether this AccelKey should be displayed in the menu a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/AccelLabel.xml b/doc/en/Gtk/AccelLabel.xml index 21ccb0990..4a351f24f 100644 --- a/doc/en/Gtk/AccelLabel.xml +++ b/doc/en/Gtk/AccelLabel.xml @@ -96,7 +96,7 @@ Creates an accelerator label. The accelerator label. - To be added + @@ -183,4 +183,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Rc.xml b/doc/en/Gtk/Rc.xml index 38f26319e..6cb03da6c 100644 --- a/doc/en/Gtk/Rc.xml +++ b/doc/en/Gtk/Rc.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Object for rc-file handling--- for example, ~/.gtkrc--- and application style and default setting. Rc files can be used to set the colors of just about any widget, and they can also be used to tile pixmaps onto the background of some widgets. + System.Object @@ -29,10 +29,10 @@ - To be added + Finds all matching RC styles for a given widget, composites them together, and then creates a representing the composite appearance. a a - To be added + (GTK+ actually keeps a cache of previously created styles, so a new style may not be created.) @@ -45,9 +45,9 @@ - To be added - a - To be added + Parses an rc file into the internal data structure. + a , the file to parse. + @@ -60,10 +60,10 @@ - To be added + Searches for a theme engine in the GTK+ search path. This function is not useful for applications and should not be used. a a - To be added + @@ -76,9 +76,9 @@ - To be added - a - To be added + Parses resource information directly from a string. + a to parse. + @@ -92,11 +92,11 @@ - To be added + If the modification time on any previously read file for the given has changed, discard all style information and then reread all previously read RC files. a - a - a - To be added + a , force reload whether or not anything changed if TRUE + a , TRUE if the files were re-read. + @@ -109,9 +109,9 @@ - To be added - a - To be added + Adds a file to the list of files to be parsed at the end of . + a , the filename to add to the parse list + If is not absolute, it is searched in the current directory. @@ -122,9 +122,9 @@ - To be added - a - To be added + If the modification time on any previously read file for the default has changed, discard all style information and then reread all previously read RC files. + a , TRUE if files were re-read. + @@ -133,9 +133,9 @@ - To be added + Public constructor; generates a new RC parser. a - To be added + @@ -145,9 +145,9 @@ System.String - To be added + Returns the name a directory in which GTK# looks for theme engines. a - To be added + Unlike the underlying GTK+ function, the return value of this method is a string, not a directory handle that must be freed later. (FIXME: the GTK+ docs point at the "GTK_PATH" section of "Running GTK applications", which is very detailed and may or may not need included here.) @@ -157,9 +157,9 @@ System.String - To be added + Returns the standard directory in which themes should be installed. (GTK+ does not actually use this directory itself.) a - To be added + Unlike the underlying GTK+ function, the return value of this method is a string, not a directory handle that must be freed later. @@ -169,9 +169,9 @@ System.String - To be added + The path to the IM module file specified by the RC file. This may be overridden by the GTK_IM_MODULE_FILE environment variable. a - To be added + (FIXME: does this apply for Gtk# too?) In standard Gtk+ applications, the GTK_IM_MODULE_FILE environment variable overrides the im_module_file specified in the RC files, which in turn overrides the default value sysconfdir/gtk-2.0/gtk.immodules (sysconfdir is the sysconfdir specified when GTK+ was configured, usually /usr/local/etc.) @@ -181,9 +181,10 @@ System.String - To be added + Obtains the path in which to look for IM modules. + a - To be added + (FIXME: "See the documentation of the GTK_PATH environment variable for more details about looking up modules.") This function is useful solely for utilities supplied with GTK+ and should not be used by applications under normal circumstances. @@ -195,10 +196,10 @@ - To be added + The current list of RC files that will be parsed at the end of . a - a - To be added + a , a list of filenames. + Unlike the underlying GTK+ function, this function's return string does not use memory owned by the application. @@ -214,14 +215,15 @@ - To be added + Creates up a from styles defined in a RC file by providing the raw components used in matching. This function may be useful when creating pseudo-widgets that should be themed like widgets but don't actually have corresponding GTK# widgets. An example of this would be items inside a GNOME canvas widget. a - a - a - a - a - To be added + a , the widget path to use when looking up the style, or NULL if no matching against the widget path should be done + a , the class path to use when looking up the style, or NULL if no matching against the class path should be done. + a , a type that will be used along with parent types of this type when matching against class styles, or G_TYPE_NONE + a ,a style created by matching with the supplied paths, or NULL if nothing matching was specified and the default style should be used. + + The returned value is owned by GTK+ as part of an internal cache, so you must call g_object_ref() on the returned value if you want to keep a reference to it. (FIXME: what's the GTK# equivalent of g_object_ref()?) - \ No newline at end of file + diff --git a/doc/en/Gtk/RcProperty.xml b/doc/en/Gtk/RcProperty.xml index 4d5693225..2267a7520 100644 --- a/doc/en/Gtk/RcProperty.xml +++ b/doc/en/Gtk/RcProperty.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A type for style properties as represented in RC files. + GTK+ allows style properties to be attached to styles. Because style properties can be loaded in from configuration files, theme authors can change the look and feel of the UI without writing their own theme engine code. System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Initialize a new, empty object. + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.RcProperty' - To be added + Constructor for internal use. + An object of type 'IntPtr', a pointer to the underlying C object. + A new . + Intended only for internal use; not for general developer use. @@ -56,21 +56,21 @@ - To be added - To be added + The type of this property. + - Field + Field System.Int32 - To be added - To be added + The name of the property. + @@ -82,8 +82,8 @@ - To be added - To be added + The origin/source of the property. Should be "filename:linenumber" for RC files, or something like "XProperty" for other sources. + @@ -95,9 +95,9 @@ - To be added - To be added + The value of the property. + - \ No newline at end of file + diff --git a/doc/en/Gtk/RcPropertyParser.xml b/doc/en/Gtk/RcPropertyParser.xml index bfe23c210..ee8dc6f6c 100644 --- a/doc/en/Gtk/RcPropertyParser.xml +++ b/doc/en/Gtk/RcPropertyParser.xml @@ -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 + Delegate class for parsing property values in RC files. + System.Delegate @@ -28,4 +28,4 @@ System.Boolean - \ No newline at end of file + diff --git a/doc/en/Gtk/RcStyle.xml b/doc/en/Gtk/RcStyle.xml index 5db8a81fa..1f843909a 100644 --- a/doc/en/Gtk/RcStyle.xml +++ b/doc/en/Gtk/RcStyle.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object for handling a and representing it in the context of an RC file. + This class is used most obviously in , where it's a parameter. GLib.Object @@ -34,9 +34,9 @@ - To be added - To be added: an object of type 'Gtk.RcStyle' - To be added + Copies this RcStyle object to another new RcStyle object. + an object, a duplicate of this obkect. + @@ -73,9 +73,9 @@ - To be added - To be added: an object of type 'Gtk.RcStyle' - To be added + Public constructor + A new object of type + The object returned has no fields set and a refcount of 1. @@ -106,4 +106,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/RcTokenType.xml b/doc/en/Gtk/RcTokenType.xml index f4861bd97..d2d23e81a 100644 --- a/doc/en/Gtk/RcTokenType.xml +++ b/doc/en/Gtk/RcTokenType.xml @@ -37,7 +37,7 @@ - To be added + Token to represent an invalid RC-file directive. @@ -50,7 +50,7 @@ - To be added + Token for including another RC file. @@ -63,7 +63,7 @@ - To be added + Token for the normal state of a widget. @@ -76,7 +76,7 @@ - To be added + Token for the active state of a widget. @@ -89,7 +89,7 @@ - To be added + Token for the prelight state of a widget. @@ -102,7 +102,7 @@ - To be added + Token for the selected state of a widget. @@ -115,7 +115,7 @@ - To be added + Token for the insensitive (unclickable) state of a widget. @@ -128,7 +128,7 @@ - To be added + Token for a foreground color. @@ -141,7 +141,7 @@ - To be added + Token for a background color. @@ -154,7 +154,7 @@ - To be added + Token for the text color of a widget. @@ -167,7 +167,7 @@ - To be added + Token for color used for the background of widgets displaying editable text. @@ -180,7 +180,7 @@ - To be added + Token for specifying X thickness. @@ -193,7 +193,7 @@ - To be added + Token for specifying Y thickness. @@ -206,9 +206,9 @@ - To be added + Token for specifying a font. Deprecated; use FontName declarations instead. - + Deprecation is from GTK+ 2.x. @@ -219,9 +219,9 @@ - To be added + Token for specifying a font set. Deprecated; use FontName declarations instead. - + Deprecation is from GTK+ 2.x. @@ -232,7 +232,7 @@ - To be added + Token for specifying a font name. @@ -245,7 +245,7 @@ - To be added + Token for specifying a background pixmap. @@ -258,7 +258,7 @@ - To be added + Token for specifying the path for pixmaps. @@ -271,7 +271,7 @@ - To be added + Token for specifying a style. @@ -284,7 +284,7 @@ - To be added + Token for specifying a key binding set. @@ -297,7 +297,7 @@ - To be added + Token for specifying a particular key binding. @@ -310,7 +310,7 @@ - To be added + Token for binding a style to a widget. @@ -323,7 +323,7 @@ - To be added + Token for binding a style to a class of widgets. @@ -336,7 +336,7 @@ - To be added + Token for applying a style to an object class. @@ -349,7 +349,7 @@ - To be added + Token for specifying that a given RC directive is lowest priority. @@ -362,7 +362,7 @@ - To be added + Token for specifying the "gtk" priority level (one above lowest). @@ -375,7 +375,7 @@ - To be added + Token for specifying the "application" priority level. @@ -388,7 +388,7 @@ - To be added + Token for specifying the "theme" priority level. @@ -401,7 +401,7 @@ - To be added + Token for specifying the "rc" priority level. @@ -414,7 +414,7 @@ - To be added + Token for specifying "highest" priority level. @@ -427,7 +427,7 @@ - To be added + Token to define an engine to use for this style. @@ -440,7 +440,7 @@ - To be added + Token to set path to search for theme engines. @@ -453,7 +453,7 @@ - To be added + Token to set path used for IM modules. @@ -466,7 +466,7 @@ - To be added + Token to set path to the IM modules file. @@ -479,7 +479,7 @@ - To be added + Token to specify the icon for a stock item. @@ -492,7 +492,7 @@ - To be added + Token to specify a value for use with a left-to-right language. @@ -505,7 +505,7 @@ - To be added + Token to specify a value for use with a right-to-left language. @@ -518,7 +518,7 @@ - To be added + Token to specify the last token. (FIXME: check this) @@ -537,4 +537,4 @@ - \ No newline at end of file +