From 17be196384ed9f10c157c274e83289dfddf9fd3f Mon Sep 17 00:00:00 2001 From: "Hector E. Gomez Morales" Date: Sun, 5 Oct 2003 07:38:14 +0000 Subject: [PATCH] * en/Gtk/Icon.xml * en/Gtk/ItemFactory.xml: Full docs. * en/Gtk/TODO: Added file with list of missing Gtk docs. svn path=/trunk/gtk-sharp/; revision=18624 --- doc/ChangeLog | 6 + doc/en/Gtk/Icon.xml | 96 +++++++++------- doc/en/Gtk/IconSize.xml | 4 +- doc/en/Gtk/ItemFactory.xml | 223 ++++++++++++++++++++++--------------- doc/en/Gtk/TODO | 9 +- 5 files changed, 204 insertions(+), 134 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 8a7b75f1f..48d752947 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2003-10-04 Hector E. Gomez Morales + + * en/Gtk/Icon.xml + * en/Gtk/ItemFactory.xml: Full docs. + * en/Gtk/TODO: Added file with list of missing Gtk docs. + 2003-10-03 John Luke * en/Gnome/Popup.xml: documented w/ simple example diff --git a/doc/en/Gtk/Icon.xml b/doc/en/Gtk/Icon.xml index efe443cb8..4e10240b3 100644 --- a/doc/en/Gtk/Icon.xml +++ b/doc/en/Gtk/Icon.xml @@ -1,5 +1,5 @@ - + gtk-sharp @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Methods for handling icon properties. + System.Object @@ -29,10 +29,14 @@ - To be added - a - a - To be added + Registers as another name for . + An alias for . + An existing icon size. + + + Calling with as argument will return . + + @@ -45,10 +49,10 @@ - To be added - a - a - To be added + Looks up the icon size associated with . + The name to look up. + The icon size with the given name. + @@ -63,12 +67,16 @@ - To be added - a - a - a - a - To be added + Registers a new icon size. + Name of the icon size. + The icon width. + The icon height. + Integer value representing the size. + + + Along the same lines as . Returns integer value for the size. + + @@ -81,10 +89,14 @@ - To be added - a - a - To be added + Obtains the canonical name of the given icon size. + A . + The name of the given icon size. + + + The returned string is statically allocated and should not be freed. + + @@ -100,13 +112,17 @@ - To be added - a - a - a - a - a - To be added + Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular . + A object, used to determine which set of user preferences to use. + An icon size. + Location to store icon width. + Location to store icon height. + if was a valid size. + + + Normally size would be , , etc. This method isn't normally needed, is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by , because themes are free to render the pixbuf however they like, including changing the usual size. + + @@ -121,12 +137,16 @@ - To be added - a - a - a - a - To be added + Obtains the pixel size of a semantic icon size, possibly modified by user preferences fot the default . + An icon size. + Location to store icon width. + Location to store icon height. + if was a valid size. + + + Normally size would be , , etc. This method isn't normally needed, is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by , because themes are free to render the pixbuf however they like, including changing the usual size. + + @@ -135,10 +155,10 @@ - To be added - a - To be added + A constructor. + A new instance of . + - \ No newline at end of file + diff --git a/doc/en/Gtk/IconSize.xml b/doc/en/Gtk/IconSize.xml index 17ab8090a..abbc6118d 100644 --- a/doc/en/Gtk/IconSize.xml +++ b/doc/en/Gtk/IconSize.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -128,4 +128,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/ItemFactory.xml b/doc/en/Gtk/ItemFactory.xml index f7ad2433e..1c4a0fd8d 100644 --- a/doc/en/Gtk/ItemFactory.xml +++ b/doc/en/Gtk/ItemFactory.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 + A factory for menus. + Gtk.Object @@ -33,10 +33,14 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added + If has been created by an item factory, returns the full path to it. + A . + The full path to if it has been created by an item factory, otherwise. This value is owned by GTK+ and must not be modified or freed. + + + The full path of a is the concatenation of the factory path specified in with the path specified in the from which the was created. + + @@ -49,10 +53,10 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.ItemFactory' - To be added + Obtains the item factory from which a was created. + A . + The item factory from which was created, or . + @@ -65,10 +69,14 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'IntPtr' - To be added + Obtains the which was passed to . + A . + associated with the item factory from which was created, or if wasn't created by an item factory. + + + This data is available until the menu is popped down again. + + @@ -85,13 +93,17 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'uint' - To be added: an object of type 'Gdk.ModifierType' - To be added + Installs an accelerator for in , that causes the activate event to be emitted it the accelerator is activated. + Widget to install an accelerator on. + The full path for the . + The accelerator group to install the accelerator in. + Key value of the accelerator. + Modifier combination of the acelerator. + + + This method can be used to make widgets participate in the accel saving/restoring functionality provided by and , even if they haven't been created by an item factory. The recommended API for this purpose are the and ; don't use in new code, since it is likely to be removed in the future. + + @@ -105,10 +117,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.ItemFactoryEntry' - To be added + Deletes the menu items which were created from the entries by the given item factory. + The length of . + An array of s. + @@ -121,7 +133,7 @@ - To be added + Obtains the menu item which correponds to . To be added: an object of type 'uint' To be added: an object of type 'Gtk.Widget' To be added @@ -139,11 +151,11 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'string' - To be added: an object of type 'Gtk.AccelGroup' - To be added + Initializes a item factory. + The kind of menu to create, an object of type 'uint'. + The factory path of , a string of the form "name". + A to which the accelerators for the menu items will be added, or to create a new one. + @@ -156,9 +168,9 @@ - To be added - To be added: an object of type 'Gtk.ItemFactoryEntry' - To be added + Deletes the menu item which was created from by the given item factory. + A . + @@ -173,11 +185,11 @@ - To be added - To be added: an object of type 'Gtk.ItemFactoryEntry' - To be added: an object of type 'IntPtr' - To be added: an object of type 'uint' - To be added + Creates an item for . + The to create an item for. + Data passed to the callback method of . + 1 if the callback method of is of type , 2 if it is of type . + @@ -190,7 +202,7 @@ - To be added + Obtains the which corresponds to . To be added: an object of type 'uint' To be added: an object of type 'Gtk.Widget' To be added @@ -206,10 +218,14 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Widget' - To be added + Obtains the menu item which corresponds to . + The path to the menu item. + The menu item for the given path, or if doesn't lead to a menu item. + + + If the corresponding to is a menu item which opens a submenum, then the item is returned. If you are interested in the submenum, use instead. + + @@ -222,9 +238,9 @@ - To be added - To be added: an object of type 'string' - To be added + Deletes the menu item which was created for by the given item factory. + A path. + @@ -235,9 +251,13 @@ - To be added - To be added: an object of type 'IntPtr' - To be added + Obtains the which was passed to . + associated. + + + This data is available until the menu is popped down again. + + @@ -252,11 +272,11 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.ItemFactoryEntry' - To be added: an object of type 'IntPtr' - To be added + Creates the menu items from the . + The length of . + An array of s whose members must be of type . + Data passed to the callback methods of all entries. + @@ -269,10 +289,14 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.Widget' - To be added + Obtains the which corresponds to . + The path to the . + The for the given path, or if doesn't lead to a . + + + If the corresponding to is a menu item which opens a submenu, then the submenu is returned. If you are interested in the menu item, use instead. + + @@ -287,11 +311,11 @@ - To be added - To be added: an object of type 'Gtk.TranslateFunc' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.DestroyNotify' - To be added + Sets a method to be used for translating the path elements before they are displayed. + The delegate to be used to traslate path elements. + Data to pass to and . + A delegate to be called when the object is destroyed and when the translation is changed again. + @@ -332,12 +356,12 @@ - To be added + A constructor. To be added: an object of type 'uint' - To be added: an object of type 'string' - To be added: an object of type 'Gtk.AccelGroup' - To be added: an object of type 'Gtk.ItemFactory' - To be added + + + A new instance of . + @@ -346,9 +370,9 @@ - To be added - To be added: an object of type 'Gtk.ItemFactory' - To be added + Internal constructor. + An instance of . + This is an internal constructor, and should not be used by user code. @@ -394,14 +418,27 @@ - To be added - a - a - a - a - a - a - To be added + Pops up the menu constructed form the item factory at (, ). + Data available for callbacks while the menu is posted. + A to be called on when the menu is unposted. + The x position. + The y position. + The mouse button which was pressed to initiate the popup. + The time at which the activation event ocurred. + + + Callbacks can access the while the menu is posted via and . + + + The should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, should be 0. + + + The should be the time stamp of the event that initiated the popup. If such a event is not available, use instead. + + + The operation of the and the is the same as the and for . + + @@ -417,13 +454,23 @@ - To be added - a - a - a - a - To be added + Pops up the menu constructed form the item factory at (, ). + The x position. + The y position. + The mouse button which was pressed to initiate the popup. + The time at which the activation event ocurred. + + + The should be the mouse button pressed to initiate the menu popup. If the menu popup was initiated by something other than a mouse button press, such as a mouse button release or a keypress, should be 0. + + + The should be the time stamp of the event that initiated the popup. If such a event is not available, use instead. + + + The operation of the and the is the same as the and for . + + - \ No newline at end of file + diff --git a/doc/en/Gtk/TODO b/doc/en/Gtk/TODO index 269cf08c7..19ce9a1e1 100644 --- a/doc/en/Gtk/TODO +++ b/doc/en/Gtk/TODO @@ -1,9 +1,9 @@ TODO doc for Gtk namespace. -There are in total 325 xml to document in Gtk. Right now there are 181 xml not documented in any proportion. +There are in total 325 xml to document in Gtk. Right now there are 178 xml not documented in any proportion. The idea is to have a easy way to know what documentation is missing, if you want to help or are helping please take out the xml that you commit -from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email next -to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list). +from the missing list. For documentation that take some time to finish (like HTML, TextBuffer, etc) the best is that you but your name and email +next to the file in this list to acknowledge that you are working in it (is recommendable that you suscribe to the mono-docs mailing list). Following is the list of undocumented xml: @@ -65,8 +65,6 @@ IMContextSimple.xml IMMulticontext.xml IMPreedStyle.xml IMStatusStyle.xml -Icon.xml -IconSize.xml ImageAnimationData.xml ImageIconSetData.xml ImageImageData.xml @@ -75,7 +73,6 @@ ImagePixmapData.xml ImageStockData.xml Init.xml Input.xml -ItemFactory.xml ItemFactoryCallback.xml ItemFactoruCallback1.xml ItemFactoryEntry.xml