diff --git a/doc/ChangeLog b/doc/ChangeLog index 93dbf1f6f..e96657fb7 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +2003-02-25 Lee Mallabone + + * en/Gtk/AspectFrame.xml: full doc, based on C docs. + * en/Gtk/FileSelection.xml: first draft + * en/Gtk/ColorSelection.xml: first draft, incorrect API left undocumented and reported as bug #38672. + * en/Gtk/ColorSelectionDialog.xml: full doc. + * en/Gtk/CheckMenuItem.xml: full doc, based on C docs. + * en/Gtk/UpdateType.xml: simple docs for a simple enum. + 2003-02-25 Duncan Mak * en/Gtk/WrapMode.xml: From Hector. diff --git a/doc/en/Gtk/AspectFrame.xml b/doc/en/Gtk/AspectFrame.xml index 1155fb773..e6ed43377 100644 --- a/doc/en/Gtk/AspectFrame.xml +++ b/doc/en/Gtk/AspectFrame.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 frame that constrains its child to a particular aspect ratio. + The AspectFrame is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. AspectFrame derives from , so it can draw a label and a frame around the child. The frame will be "shrink-wrapped" to the size of the child. Gtk.Frame @@ -42,12 +42,12 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'bool' - To be added + Set the size and alignment properties of this AspectFrame. + Horizontal alignment of the child within the allocation of the AspectFrame. + Vertical alignment of the child within the allocation of the AspectFrame. + The desired aspect ratio. + If , ratio is ignored, and the aspect ratio is taken from the requistion of the child. + Alignment values range from 0.0 (left/top aligned) to 1.0 (right/bottom aligned). @@ -106,14 +106,14 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.AspectFrame' - To be added + The main way to construct a new AspectFrame. + A title for the frame, can be . + Horizontal alignment of the child within the allocation of the AspectFrame. + Vertical alignment of the child within the allocation of the AspectFrame. + The desired aspect ratio. + If , ratio is ignored, and the aspect ratio is taken from the requistion of the child. + A new AspectFrame + Alignment values range from 0.0 (left/top aligned) to 1.0 (right/bottom aligned). @@ -122,9 +122,9 @@ - To be added - To be added: an object of type 'Gtk.AspectFrame' - To be added + Internal constructor + + @@ -149,10 +149,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Vertical alignment of the child widget in the AspectFrame. + A value between 0.0 (top aligned) and 1.0 (bottom aligned). + A value between 0.0 and 1.0. + @@ -165,10 +165,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Horiontal alignment of the child widget in the AspectFrame. + A value between 0.0 (left aligned) and 1.0 (right aligned). + A value between 0.0 and 1.0. + @@ -181,10 +181,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + The aspect ratio of the child widget's size. + A ratio between 0.0 and 1.0 + The aspect ratio between 0.0 and 1.0 representing the child's size constraints. + Setting this ratio is ignored if is set to . @@ -197,10 +197,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Allow the frame to use its child widget's aspect ratio. + for the AspectFrame to use the child widget's size ratio, for to control the ratio. + The current size ratio of the child widget + diff --git a/doc/en/Gtk/CheckMenuItem.xml b/doc/en/Gtk/CheckMenuItem.xml index 91cb0a121..c083464cf 100644 --- a/doc/en/Gtk/CheckMenuItem.xml +++ b/doc/en/Gtk/CheckMenuItem.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A menu item with a check box. + A CheckMenuItem is a menu item that maintains the state of a boolean value in addition to a 's usual role in activating application code. + A check box indicating the state of the boolean value is displayed at the left side of the . Activating the toggles the value. + Whether the CheckMenuItem is 'on' or not can be determined with the property. + Gtk.MenuItem @@ -39,10 +42,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.CheckMenuItem' - To be added + A static way of creating a new CheckMenuItem + The name of the menu item + A new CheckMenuItem + @@ -53,8 +56,8 @@ - To be added - To be added + Toggles the state of the check box between active and inactive. + @@ -107,9 +110,9 @@ - To be added - To be added: an object of type 'Gtk.CheckMenuItem' - To be added + Creates a CheckMenuItem with no label + A new CheckMenuItem + @@ -120,10 +123,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.CheckMenuItem' - To be added + Create a new CheckMenuItem with the specified . + The text to appear on the menu item. + A new CheckMenuItem + The text label will be created using , so underscores in the label indicate the mnemonic for the menu item. @@ -148,10 +151,12 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manages whether the CheckMenuItem is in the 'inconsistent' state. + to mark the check box as inconsistent, otherwise. + if this CheckMenuItem is in the inconsistent state, otherwise. + If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a boolean setting, and the current values in that range are inconsistent, you may want to display the check in an "in between" state. This property turns on "in between" display. + Normally you would turn off the inconsistent state again if the user explicitly selects a setting. This has to be done manually, this property only affects visual appearance, it doesn't affect the semantics of the widget. + @@ -164,10 +169,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + The 'active' state of the CheckMenuItem + if the menu item has been set active, otherwise. + + @@ -176,8 +181,8 @@ - To be added - To be added + An event that is fired whenever the state of the CheckMenuItem is toggled. + Connect to this event with a standard . diff --git a/doc/en/Gtk/ColorSelection.xml b/doc/en/Gtk/ColorSelection.xml index c4c70b06c..1a6a4f182 100644 --- a/doc/en/Gtk/ColorSelection.xml +++ b/doc/en/Gtk/ColorSelection.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A widget for selecting a color. + The ColorSelection consists of a color wheel and number of sliders and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and opacity. It is found on the standard color selection dialog box, . + This widget displays the 'selected' color as well as the previously selected color. + Gtk.VBox @@ -105,9 +107,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Gets the current state of the ColorSelection + if the user is currently dragging a color around, if the selection has stopped. + @@ -160,9 +162,9 @@ - To be added - To be added: an object of type 'Gtk.ColorSelection' - To be added + The main way to create a new ColorSelection + A new ColorSelection + @@ -187,10 +189,10 @@ - To be added - To be added: an object of type 'ushort' - To be added: an object of type 'ushort' - To be added + Get the alpha value of the previous color + A new setting for the 'previous' alpha value. + The previous alpha value - an integer between 0 and 65535. + It may be confusing for a user if this property is set with no interaction from them. @@ -203,10 +205,10 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + Manage the current color of the ColorSelection. + A color to set as the 'current' color. + The currently selected color in this ColorSelection. + @@ -219,10 +221,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manage whether or not the ColorSelection displays a palette. + to display a palette in the ColorSelection, otherwise. + if a palette is currently part of the ColorSelection, otherwise. + @@ -235,10 +237,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manage whether or not opacity is part of the ColorSelection. + to display opacity controls, otherwise. + if the user can edit opacity, otherwise. + @@ -251,10 +253,10 @@ - To be added - To be added: an object of type 'ushort' - To be added: an object of type 'ushort' - To be added + Manage the current alpha value of the ColorSelection. + Sets the current opacity. + The existing opacity of this ColorSelection. + @@ -263,8 +265,8 @@ - To be added - To be added + This event is fired when the current color changes in the ColorSelection. + diff --git a/doc/en/Gtk/ColorSelectionDialog.xml b/doc/en/Gtk/ColorSelectionDialog.xml index 06c01d991..2f3287fac 100644 --- a/doc/en/Gtk/ColorSelectionDialog.xml +++ b/doc/en/Gtk/ColorSelectionDialog.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 standard dialog box for selecting a color. + The ColorSelectionDialog provides a standard which allows the user to select a color much like the provides a standard dialog for file selection. Gtk.Dialog @@ -81,10 +81,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.ColorSelectionDialog' - To be added + The main way to construct a new color selector. + A title that will appear in the window's title bar. + A new ColorSelectionDialog + @@ -93,9 +93,9 @@ - To be added - To be added: an object of type 'Gtk.ColorSelectionDialog' - To be added + Internal constructor + + @@ -117,8 +117,8 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' + A button for providing help with this dialog + A standard . To be added @@ -129,9 +129,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + A button for cancelling this dialog + A standard . + @@ -141,9 +141,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + A button to confirm use of the selected color. + A standard . + @@ -153,9 +153,9 @@ Gtk.ColorSelection - To be added - To be added: an object of type 'Gtk.ColorSelection' - To be added + An accessor to the actual ColorSelection widget. + The ColorSelection component of this . + All color-related functions are available using the methods on this property, such as . diff --git a/doc/en/Gtk/FileSelection.xml b/doc/en/Gtk/FileSelection.xml index ccd1468fd..d894862ff 100644 --- a/doc/en/Gtk/FileSelection.xml +++ b/doc/en/Gtk/FileSelection.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,16 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Creates a new dialog for the user to select one or more files, directories, or cancel. + FileSelection should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory. + + + The filesystem can be navigated using the directory list or the drop-down history menu. Alternatively, the TAB key can be used to navigate using filename completion - common in text based editors such as emacs and jed. + + Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. + + The functionality of the FileSelection can be extended by using the available accessors to the buttons and drop downs. + Gtk.Dialog @@ -39,9 +47,9 @@ - To be added - To be added: an object of type 'string' - To be added + Restrict the visible files and directories to those that match the given . + A simple wildcard pattern such as '*.txt'. + This method attempts to match to a valid filenames or subdirectories in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog. If a partial match can be made, the "Files" list will contain those file names which have been partially matched, and the "Folders" list will show those directories with a partial match. @@ -52,8 +60,8 @@ - To be added - To be added + Ensures that the file operation buttons are visible. + @@ -64,8 +72,8 @@ - To be added - To be added + Ensures that the file operation buttons are hidden. + @@ -120,10 +128,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.FileSelection' - To be added + The main way to construct a new file selector. + A title that will appear in the window's title bar. + A new FileSelection + @@ -132,9 +140,9 @@ - To be added - To be added: an object of type 'Gtk.FileSelection' - To be added + Internal constructor + + @@ -180,9 +188,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + The 'rename file' button of this file selector. + + This button may or may not be visible, see and . @@ -192,9 +200,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + The 'delete' button of this file selector. + + This button may or may not be visible, see and . @@ -204,9 +212,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + The 'create directory' button of this file selector. + + This button may or may not be visible, see and . @@ -228,9 +236,9 @@ Gtk.Entry - To be added - To be added: an object of type 'Gtk.Entry' - To be added + The main text entry widget of this file selector. + + @@ -252,9 +260,9 @@ Gtk.Menu - To be added - To be added: an object of type 'Gtk.Menu' - To be added + The that is displayed by the . + A menu containing the file system paths higher than the selected directory, and the user's directory history. + Note that this widget does not just contain history, it contains a list of directories above the current directory in the filesystem as well as user directory history. @@ -264,9 +272,9 @@ Gtk.OptionMenu - To be added - To be added: an object of type 'Gtk.OptionMenu' - To be added + The drop down menu containing directories in the filesystem above the selected directory, and the user's directory history. + The at the top of the file selector. + This widget displays the menu returned by . @@ -276,9 +284,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + A help button, not displayed by default. + + @@ -288,9 +296,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + The 'cancel' of this file selector. + + @@ -300,9 +308,9 @@ Gtk.Button - To be added - To be added: an object of type 'Gtk.Button' - To be added + The 'OK' button of this file selector. + + @@ -336,9 +344,9 @@ Gtk.TreeView - To be added - To be added: an object of type 'Gtk.TreeView' - To be added + The widget that displays files in this file selector. + + @@ -348,9 +356,9 @@ Gtk.TreeView - To be added - To be added: an object of type 'Gtk.TreeView' - To be added + The widget that displays directories in this file selector. + + @@ -360,9 +368,9 @@ System.String[] - To be added - To be added: an object of type 'string[]' - To be added + Get the files that are selected + An array of file paths + @@ -375,10 +383,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manage whether buttons are displayed for doing file operations. + Set to to display the file buttons. + for buttons to be shown, otherwise. + This manipulates whether the buttons for creating a directory, deleting files and renaming files, are displayed. @@ -391,10 +399,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + Manage the selected filename. + Sets a default path for the file requestor. + The selected filename in the on-disk encoding. + If includes a directory path, then the requestor will open with that path as its current working directory. The encoding of filename is the on-disk encoding, which may not be UTF-8. @@ -407,11 +415,11 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manage whether more than one file can be selected. + Set to to allow more than one file to be selected in the file list, to only allow selection of a single file. + if multiple selections are allowed, otherwise. + - \ No newline at end of file + diff --git a/doc/en/Gtk/UpdateType.xml b/doc/en/Gtk/UpdateType.xml index 27c96ddc7..d172a79ae 100644 --- a/doc/en/Gtk/UpdateType.xml +++ b/doc/en/Gtk/UpdateType.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 + Provides a method of indicating how 'updates' should occur. + The purpose of this type is most easily explained in the context of its use. , a base class for slider widgets such as , uses an UpdateType to determine how often to update a text value when the user is dragging a slider bar around. System.Enum @@ -34,8 +34,8 @@ - To be added - To be added + Indicates that updates should occur as soon as possible. + @@ -46,8 +46,8 @@ - To be added - To be added + Indicates that updates are not urgent. + This typically indicates that a whole group of updates can be done at once when a user action has finished. @@ -58,8 +58,8 @@ - To be added - To be added + Indicates that updates should happen as often as possible, but a delay between an action and its update, is allowed. +