From d3fb6e0ae86f7cee3d97b1835f54f0669685400e Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Thu, 30 Dec 2004 16:05:38 +0000 Subject: [PATCH] 2004-12-30 Shane Landrum * en/Gtk/ItemFactory.xml * en/Gtk/MenuShell.xml * en/Gtk/MenuEntry.xml * en/Gtk/Menu.xml * en/Gtk/ItemFactoryEntry.xml * en/Gtk/MenuCallback.xml: Docs for menus and menu creation. * en/Gtk/Notebook.xml: Docs for a 2.4 change. svn path=/trunk/gtk-sharp/; revision=38185 --- doc/ChangeLog | 10 +++++++++ doc/en/Gtk/ItemFactory.xml | 36 +++++++++++++++++------------ doc/en/Gtk/ItemFactoryEntry.xml | 40 +++++++++++++++++++++------------ doc/en/Gtk/Menu.xml | 21 ++++++++++++----- doc/en/Gtk/MenuCallback.xml | 6 ++--- doc/en/Gtk/MenuEntry.xml | 31 +++++++++++++------------ doc/en/Gtk/MenuShell.xml | 4 +--- doc/en/Gtk/Notebook.xml | 6 ++--- 8 files changed, 97 insertions(+), 57 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 63dde1a8a..ff0c012aa 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,13 @@ +2004-12-30 Shane Landrum + + * en/Gtk/ItemFactory.xml + * en/Gtk/MenuShell.xml + * en/Gtk/MenuEntry.xml + * en/Gtk/Menu.xml + * en/Gtk/ItemFactoryEntry.xml + * en/Gtk/MenuCallback.xml: Docs for menus and menu creation. + * en/Gtk/Notebook.xml: Docs for a 2.4 change. + 2004-12-30 Shane Landrum * en/Gtk/TreeViewColumn.xml diff --git a/doc/en/Gtk/ItemFactory.xml b/doc/en/Gtk/ItemFactory.xml index 654756553..a0f17f163 100644 --- a/doc/en/Gtk/ItemFactory.xml +++ b/doc/en/Gtk/ItemFactory.xml @@ -11,7 +11,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A factory for menus. - + + To use this class, make an array of + objects which describe a menu, then invoke + to generate the menu. + Gtk.Object @@ -487,10 +491,13 @@ - To be added + Finds an item factory which has been constructed using the + "<name>" prefix of as the path argument + building a new item factory. + a - a - To be added + a , or + @@ -504,10 +511,10 @@ - To be added - a - a - To be added + Creates menu items from a set of entries. + a , the number of entries + an array of objects + @@ -523,13 +530,14 @@ - To be added - a - a - a + Creates menu items from entries. + a , the number of menu items + a , a list of information about menu items + a , pointer to data that should be passed to + the callback functions of all entries a - To be added + FIXME: See bugzilla 70887. - \ No newline at end of file + diff --git a/doc/en/Gtk/ItemFactoryEntry.xml b/doc/en/Gtk/ItemFactoryEntry.xml index 397cccf85..624555fdc 100644 --- a/doc/en/Gtk/ItemFactoryEntry.xml +++ b/doc/en/Gtk/ItemFactoryEntry.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - + Class intended for use with . + FIXME: see bugzilla.ximian.com #70887, which directly concerns this API. System.ValueType @@ -27,7 +27,7 @@ - To be added + Empty entry. @@ -41,8 +41,8 @@ - To be added - a + For internal use only. Do not use. + a , pointer to the underlying C data. a @@ -56,8 +56,8 @@ - To be added - + The path of the item. + For example, "/File/_Open", where the "O" should be a mnemonic underline. @@ -69,8 +69,8 @@ - To be added - + The accelerator key for this item. + For example, "O". @@ -82,8 +82,8 @@ - To be added - + A callback function to run when this item is activated. + NOTE: The API doesn't support the actual code here. @@ -95,9 +95,21 @@ - To be added - + Type of item to add. + Possible values: + "<Title>" creates a title item, + "<Item>" creates a simple item, + "<ImageItem>" creates an item holding an image, + "<StockItem>" creates an item holding a stock image, + "<CheckItem>" creates a check item, + "<ToggleItem>" creates a toggle item, + "<RadioItem>" creates a radio item, + <path> for the path of a radio item to link against, + "<Separator>" creates a separator, + "<Tearoff>" creates a tearoff separator, + "<Branch>" creates an item to hold sub items, + "<LastBranch>" creates a right justified item to hold sub items. - \ No newline at end of file + diff --git a/doc/en/Gtk/Menu.xml b/doc/en/Gtk/Menu.xml index 249d55b97..3c8e4ab3b 100644 --- a/doc/en/Gtk/Menu.xml +++ b/doc/en/Gtk/Menu.xml @@ -496,9 +496,9 @@ class PopupSample System.Int32 - To be added + The number of the monitor on which the menu should be popped up. a - To be added + @@ -515,13 +515,22 @@ class PopupSample - To be added - a + Adds a new to a (table) menu. + a , should be a a a a a - To be added + + The number of 'cells' that + an item will occupy is specified by , + , and + . These each represent the leftmost, + rightmost, uppermost and lower column and row numbers of the table. + (Columns and rows are indexed from zero). + + Note that this function is not related to . + @@ -541,4 +550,4 @@ class PopupSample - \ No newline at end of file + diff --git a/doc/en/Gtk/MenuCallback.xml b/doc/en/Gtk/MenuCallback.xml index 0881046a3..edc0ebf8a 100644 --- a/doc/en/Gtk/MenuCallback.xml +++ b/doc/en/Gtk/MenuCallback.xml @@ -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 + Do not use. + Do not use. System.Delegate @@ -31,4 +31,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/MenuEntry.xml b/doc/en/Gtk/MenuEntry.xml index 92ec0196b..30135a55d 100644 --- a/doc/en/Gtk/MenuEntry.xml +++ b/doc/en/Gtk/MenuEntry.xml @@ -9,8 +9,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Class for use with in generating menus. + + See for more details. + FIXME: see bugzilla.ximian.com #70887, which directly concerns this API. + System.ValueType @@ -27,8 +30,8 @@ - To be added - To be added + An empty menu entry. + @@ -40,8 +43,8 @@ - To be added - To be added + The path of this menu item. + For example, "/File/_Open", where the "O" should be a mnemonic underline. @@ -53,8 +56,8 @@ - To be added - To be added + An accelerator key sequence + @@ -67,10 +70,10 @@ - To be added - a + For internal use only. Do not use. + a , pointer to the underlying C object. a - To be added + @@ -81,10 +84,10 @@ - To be added + The widget related to this menu entry. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/MenuShell.xml b/doc/en/Gtk/MenuShell.xml index 3e01b2814..b67aa28dd 100644 --- a/doc/en/Gtk/MenuShell.xml +++ b/doc/en/Gtk/MenuShell.xml @@ -377,8 +377,6 @@ Default handler for the event. Override this method in a subclass to provide a default handler for the event. - To be added - To be added @@ -394,4 +392,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Notebook.xml b/doc/en/Gtk/Notebook.xml index 2f87612e2..ef0119a12 100644 --- a/doc/en/Gtk/Notebook.xml +++ b/doc/en/Gtk/Notebook.xml @@ -875,9 +875,9 @@ the label of a menu doesn't have to be a . it can be a System.Boolean - To be added + Whether tabs should have homogeneous sizes. a - To be added + @@ -1048,4 +1048,4 @@ Don't forget to call the Show method on the widget or else the new page will not - \ No newline at end of file +