From 2d0ec3b3b52153ed378803f6db3f10d4444d71cf Mon Sep 17 00:00:00 2001 From: John Luke Date: Mon, 17 Nov 2003 02:58:23 +0000 Subject: [PATCH] 2003-11-16 John Luke * en/Gdk/Atom.xml: documented * en/Gtk/Clipboard.xml: documented * en/Gtk/Stock.xml: documented * en/Gtk/StockItem.xml: documented svn path=/trunk/gtk-sharp/; revision=20095 --- doc/ChangeLog | 7 + doc/en/Gdk/Atom.xml | 33 +++-- doc/en/Gtk/Clipboard.xml | 119 ++++++++------- doc/en/Gtk/Stock.xml | 302 ++++++++++++++++++++------------------- doc/en/Gtk/StockItem.xml | 53 ++++--- doc/en/Gtk/TODO | 5 +- 6 files changed, 278 insertions(+), 241 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index f5a28fb8e..9537b4c7a 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2003-11-16 John Luke + + * en/Gdk/Atom.xml: documented + * en/Gtk/Clipboard.xml: documented + * en/Gtk/Stock.xml: documented + * en/Gtk/StockItem.xml: documented + 2003-11-12 John Luke * en/Gtk/Quit.xml: documented diff --git a/doc/en/Gdk/Atom.xml b/doc/en/Gdk/Atom.xml index 9d9370cdd..391f2ab5b 100644 --- a/doc/en/Gdk/Atom.xml +++ b/doc/en/Gdk/Atom.xml @@ -1,16 +1,18 @@ - + gdk-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An opaque type representing a string as an index into a table of strings on the X server. + + GLib.Opaque @@ -33,11 +35,11 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added: an object of type 'Gdk.Atom' - To be added + Finds or creates an corresponding to a given string. + an object of type + an object of type + an object of type + If is , do not create a new atom, but just return the atom if it already exists. @@ -48,9 +50,10 @@ - To be added - To be added: an object of type 'string' - To be added + Determines the string corresponding to an atom. + an object of type + + @@ -75,9 +78,9 @@ - To be added - To be added: an object of type 'Gdk.Atom' - To be added + Internal constructor + an object of type + This is an internal constructor, and should not be used by user code. diff --git a/doc/en/Gtk/Clipboard.xml b/doc/en/Gtk/Clipboard.xml index 735f48534..b2954be63 100644 --- a/doc/en/Gtk/Clipboard.xml +++ b/doc/en/Gtk/Clipboard.xml @@ -1,16 +1,23 @@ - + gtk-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An object that stores clipboard data. + + The object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a name encoded as a . (Conversion to and from strings can be done with and .) The default clipboard corresponds to the "CLIPBOARD" atom; another commonly used clipboard is the "PRIMARY" clipboard, which, in X, traditionally contains the currently selected text. + To support having a number of different formats on the clipboard at the same time, the clipboard mechanism allows providing callbacks instead of the actual data. When you set the contents of the clipboard, you can either supply the data directly (via methods like ), or you can supply a callback to be called at a later time when the data is needed (via or .) Providing a callback also avoids having to make copies of the data when it is not needed. + and are quite similar; the choice between the two depends mostly on which is more convenient in a particular situation. The former is most useful when you want to have a blob of data with callbacks to convert it into the various data types that you advertise. When the clear_func you provided is called, you simply free the data blob. The latter is more useful when the contents of clipboard reflect the internal state of a (As an example, for the PRIMARY clipboard, when an entry widget provides the contents for the clipboar the contents are simply the text within the selected region.) If the contents change, the entry widget can call to update the timestamp for clipboard ownership, without having to worry about clear_func being called. + Requesting the data from the clipboard is essentially asynchronous. If the contents of the clipboard are provided within the same process, then a direct function call will be made to retrieve the data, but if they are provided by another process, then the data needs to be retrieved from the other process, which may take some time. To avoid blocking the user interface, the call to request the selection, takes a callback that will be called when the contents are received (or when the request fails.) If you do not want to deal with providing a separate callback, you can also use . What this does is run the GLib main loop recursively waiting for the contents. This can simplify the code flow, but you still have to be aware that other callbacks in your program can be called while this recursive mainloop is running. + + Along with the functions to get the clipboard contents as an arbitrary data chunk, there are also functions to retrieve it as text, and . These functions take care of determining which formats are advertised by the clipboard provider, asking for the clipboard in the best available format and converting the results into the UTF-8 encoding. (The standard form for representing strings in Gtk#.) GLib.Opaque @@ -32,10 +39,10 @@ - To be added - To be added: an object of type 'Gdk.Atom' - To be added: an object of type 'Gtk.Clipboard' - To be added + Returns the clipboard object for the given selection. + an object of type + an object of type + See for complete details. @@ -46,8 +53,8 @@ - To be added - To be added + Clears the contents of the clipboard. + Generally this should only be called between the time you call or , and when the clear_func you supplied is called. Otherwise, the clipboard may be owned by someone else. @@ -60,9 +67,12 @@ - To be added - To be added: an object of type 'Gtk.ClipboardTextReceivedFunc' - To be added + Requests the contents of the clipboard as text. + an object of type + + When the text is later received, it will be converted to UTF-8 if necessary, and will be called. + The text parameter to will contain the resulting text if the request succeeded, or if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form. + @@ -73,9 +83,12 @@ - To be added - To be added: an object of type 'bool' - To be added + Test to see if there is text available to be pasted. + an object of type + + This is done by requesting the TARGETS atom and checking if it contains any of the names: STRING, TEXT, COMPOUND_TEXT, UTF8_STRING. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. + This function is a little faster than calling since it does not need to retrieve the actual text. + @@ -89,10 +102,10 @@ - To be added - To be added: an object of type 'Gdk.Atom' - To be added: an object of type 'Gtk.ClipboardReceivedFunc' - To be added + Requests the contents of clipboard as the given target. + an object of type + an object of type + When the results of the result are later received the supplied callback will be called. @@ -105,10 +118,10 @@ - To be added - To be added: an object of type 'Gdk.Atom' - To be added: an object of type 'Gtk.SelectionData' - To be added + Requests the contents of the clipboard using the given target. + an object of type + an object of type + This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. @@ -119,9 +132,9 @@ - To be added - To be added: an object of type 'string' - To be added + Requests the contents of the clipboard as text and converts the result to UTF-8 if necessary. + an object of type + This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. @@ -146,9 +159,9 @@ - To be added - To be added: an object of type 'Gtk.Clipboard' - To be added + Internal constructor + an object of type + This is an internal constructor, and should not be used by user code. @@ -158,9 +171,9 @@ GLib.Object - To be added - To be added: an object of type 'GLib.Object' - To be added + The owner of the clipboard, if any; otherwise . + an object of type + If the clipboard contents callbacks were set with , and the or has not been subsequently called, it will return the owner set by . @@ -173,9 +186,9 @@ - To be added - To be added: an object of type 'string' - To be added + Sets the contents of the clipboard to the given UTF-8 string. + an object of type + Gtk# will make a copy of the text and take responsibility for responding for requests for the text, and for converting the text into the requested format. @@ -185,9 +198,9 @@ System.UInt32 - To be added + The type of the clipboard. a - To be added + @@ -197,9 +210,9 @@ Gdk.Display - To be added + The associated with the clipboard. a - To be added + @@ -213,11 +226,15 @@ - To be added + Returns the clipboard object for the given selection. a a a - To be added + + Cut/copy/paste menu items and keyboard shortcuts should use the default clipboard, returned by passing GDK_SELECTION_CLIPBOARD for selection. (GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD for backwards compatibility reasons.) The currently-selected object or text should be provided on the clipboard identified by GDK_SELECTION_PRIMARY. Cut/copy/paste menu items conceptually copy the contents of the GDK_SELECTION_PRIMARY clipboard to the default clipboard, i.e. they copy the selection to what the user sees as the clipboard. + (Passing GDK_NONE is the same as using gdk_atom_intern ("CLIPBOARD", ). See http://www.freedesktop.org/standards/clipboards.txt for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY" selections under the X window system. On Win32 the GDK_SELECTION_PRIMARY clipboard is essentially ignored.) + It is possible to have arbitrary named clipboards; if you do invent new clipboards, you should prefix the selection name with an underscore (because the ICCCM requires that nonstandard atoms are underscore-prefixed), and namespace it as well. For example, if your application called "Foo" has a special-purpose clipboard, you might call it "_FOO_SPECIAL_CLIPBOARD". + @@ -228,8 +245,8 @@ - To be added - To be added + Disposes the resources associated with the object. + @@ -240,10 +257,10 @@ - To be added + Internal constructor a a - To be added + This is an internal constructor, and should not be used by user code. @@ -259,13 +276,13 @@ - To be added + Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested. a a a a a - To be added + @@ -282,15 +299,15 @@ - To be added + Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested. a a a a a a - To be added + The difference between this function and is that a is passed in. - \ No newline at end of file + diff --git a/doc/en/Gtk/Stock.xml b/doc/en/Gtk/Stock.xml index 50caa1e9e..494f4bda4 100644 --- a/doc/en/Gtk/Stock.xml +++ b/doc/en/Gtk/Stock.xml @@ -1,16 +1,20 @@ - + gtk-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Prebuilt common menu/toolbar items and corresponding icons + + Stock items represent commonly-used menu or toolbar items such as "Open" or "Exit". Each stock item is identified by a stock ID; stock IDs are just strings, but properties such as Gtk.Stock.Open are provided to avoid typing mistakes in the strings. Applications can register their own stock items in addition to those built-in to Gtk#. + Each stock ID can be associated with a , which contains the user-visible label, keyboard accelerator, and translation domain of the menu or toolbar item; and/or with an icon stored in a . See for more information on stock icons. The connection between a and stock icons is purely conventional (by virtue of using the same stock ID); it is possible to register a stock item but no icon, and vice versa. + System.Object @@ -24,9 +28,9 @@ - To be added + Default constructor. an object of type - To be added + @@ -36,9 +40,9 @@ System.String - To be added + The "Zoom Out" item. an object of type - To be added + @@ -48,9 +52,9 @@ System.String - To be added + The "Zoom In" item. an object of type - To be added + @@ -60,9 +64,9 @@ System.String - To be added + The "Zoom to Fit" item. an object of type - To be added + @@ -72,9 +76,9 @@ System.String - To be added + The "Zoom 100%" item. an object of type - To be added + @@ -84,9 +88,9 @@ System.String - To be added + The "Yes" item. an object of type - To be added + @@ -96,9 +100,9 @@ System.String - To be added + The "Undo" item. an object of type - To be added + @@ -108,9 +112,9 @@ System.String - To be added + The "Underline" item. an object of type - To be added + @@ -120,9 +124,9 @@ System.String - To be added + The "Undelete" item. an object of type - To be added + @@ -132,9 +136,9 @@ System.String - To be added + The "Strikethrough" item. an object of type - To be added + @@ -144,9 +148,9 @@ System.String - To be added + The "Stop" item. an object of type - To be added + @@ -156,9 +160,9 @@ System.String - To be added + The "Spell Check" item. an object of type - To be added + @@ -168,9 +172,9 @@ System.String - To be added + The "Descending" item. an object of type - To be added + @@ -180,9 +184,9 @@ System.String - To be added + The "Ascending" item. an object of type - To be added + @@ -192,9 +196,9 @@ System.String - To be added + The "Font" item. an object of type - To be added + @@ -204,9 +208,9 @@ System.String - To be added + The "Color" item. an object of type - To be added + @@ -216,9 +220,9 @@ System.String - To be added + The "Save As" item. an object of type - To be added + @@ -228,9 +232,9 @@ System.String - To be added + The "Save" item. Tan object of type - To be added + @@ -240,9 +244,9 @@ System.String - To be added + The "Revert" item. an object of type - To be added + @@ -252,9 +256,9 @@ System.String - To be added + The "Remove" item. an object of type - To be added + @@ -264,9 +268,9 @@ System.String - To be added + The "Refresh" item. an object of type - To be added + @@ -276,9 +280,9 @@ System.String - To be added + The "Redo" item. an object of type - To be added + @@ -288,9 +292,9 @@ System.String - To be added + The "Quit" item. an object of type - To be added + @@ -300,9 +304,9 @@ System.String - To be added + The "Properties" item. an object of type - To be added + @@ -312,9 +316,9 @@ System.String - To be added + The "Print Preview" item. an object of type - To be added + @@ -324,9 +328,9 @@ System.String - To be added + The "Print" item. an object of type - To be added + @@ -336,9 +340,9 @@ System.String - To be added + The "Preferences" item. an object of type - To be added + @@ -348,9 +352,9 @@ System.String - To be added + The "Paste" item. an object of type - To be added + @@ -360,9 +364,9 @@ System.String - To be added + The "Open" item. an object of type - To be added + @@ -372,9 +376,9 @@ System.String - To be added + The "OK" item. an object of type - To be added + @@ -384,9 +388,9 @@ System.String - To be added + The "No" item. an object of type - To be added + @@ -396,9 +400,9 @@ System.String - To be added + The "New" item. an object of type - To be added + @@ -408,9 +412,9 @@ System.String - To be added + The "Missing Image" item. an object of type - To be added + @@ -420,9 +424,9 @@ System.String - To be added + The "Right" item. an object of type - To be added + @@ -432,9 +436,9 @@ System.String - To be added + The "Left" item. an object of type - To be added + @@ -444,9 +448,9 @@ System.String - To be added + The "Fill" item. an object of type - To be added + @@ -456,9 +460,9 @@ System.String - To be added + The "Center" item. an object of type - To be added + @@ -468,9 +472,9 @@ System.String - To be added + The "Jump to" item. an object of type - To be added + @@ -480,9 +484,9 @@ System.String - To be added + The "Italic" item. an object of type - To be added + @@ -492,9 +496,9 @@ System.String - To be added + The "Index" item. an object of type - To be added + @@ -504,9 +508,9 @@ System.String - To be added + The "Home" item. an object of type - To be added + @@ -516,9 +520,9 @@ System.String - To be added + The "Help" item. an object of type - To be added + @@ -528,9 +532,9 @@ System.String - To be added + The "Up" item. an object of type - To be added + @@ -540,9 +544,9 @@ System.String - To be added + The "Forward" item. an object of type - To be added + @@ -552,9 +556,9 @@ System.String - To be added + The "Down" item. an object of type - To be added + @@ -564,9 +568,9 @@ System.String - To be added + The "Back" item. an object of type - To be added + @@ -576,9 +580,9 @@ System.String - To be added + The "Top" item. an object of type - To be added + @@ -588,9 +592,9 @@ System.String - To be added + The "Last" item. an object of type - To be added + @@ -600,9 +604,9 @@ System.String - To be added + The "First" item. an object of type - To be added + @@ -612,9 +616,9 @@ System.String - To be added + The "Bottom" item. an object of type - To be added + @@ -624,9 +628,9 @@ System.String - To be added + The "Floppy" item. an object of type - To be added + @@ -636,9 +640,9 @@ System.String - To be added + The "Find and Replace" item. an object of type - To be added + @@ -648,9 +652,9 @@ System.String - To be added + The "Find" item. an object of type - To be added + @@ -660,9 +664,9 @@ System.String - To be added + The "Execute" item. an object of type - To be added + @@ -672,9 +676,9 @@ System.String - To be added + The "Drag-And-Drop multiple" icon. an object of type - To be added + @@ -684,9 +688,9 @@ System.String - To be added + The "Drag-And-Drop" icon. an object of type - To be added + @@ -696,9 +700,9 @@ System.String - To be added + The "Warning" item. an object of type - To be added + @@ -708,9 +712,9 @@ System.String - To be added + The "Question" item. an object of type - To be added + @@ -720,9 +724,9 @@ System.String - To be added + The "Info" item. an object of type - To be added + @@ -732,9 +736,9 @@ System.String - To be added + The "Error" item. an object of type - To be added + @@ -744,9 +748,9 @@ System.String - To be added + The "Delete" item. an object of type - To be added + @@ -756,9 +760,9 @@ System.String - To be added + The "Cut" item. an object of type - To be added + @@ -768,9 +772,9 @@ System.String - To be added + The "Copy" item. an object of type - To be added + @@ -780,9 +784,9 @@ System.String - To be added + The "Convert" item. an object of type - To be added + @@ -792,9 +796,9 @@ System.String - To be added + The "Close" item. an object of type - To be added + @@ -804,9 +808,9 @@ System.String - To be added + The "Clear" item. an object of type - To be added + @@ -816,9 +820,9 @@ System.String - To be added + The "CD-Rom" item. an object of type - To be added + @@ -828,9 +832,9 @@ System.String - To be added + The "Cancel" item. an object of type - To be added + @@ -840,9 +844,9 @@ System.String - To be added + The "Bold" item. an object of type - To be added + @@ -852,9 +856,9 @@ System.String - To be added + The "Apply" item. an object of type - To be added + @@ -864,9 +868,9 @@ System.String - To be added + The "Add" item. an object of type - To be added + @@ -876,10 +880,10 @@ System.String - To be added + The "Color Picker" item. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/StockItem.xml b/doc/en/Gtk/StockItem.xml index f0ddec9ef..bf15501fc 100644 --- a/doc/en/Gtk/StockItem.xml +++ b/doc/en/Gtk/StockItem.xml @@ -1,16 +1,17 @@ - + gtk-sharp - + + 0.0.0.0 neutral Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Contains information about a related object. + Each stock ID can be associated with a , which contains the user-visible label, keyboard accelerator, and translation domain of the menu or toolbar item; and/or with an icon stored in a . See for more information on stock icons. The connection between a and stock icons is purely conventional (by virtue of using the same stock ID); it is possible to register a stock item but no icon, and vice versa. System.ValueType @@ -26,8 +27,9 @@ - To be added - To be added + An empty + + @@ -38,8 +40,9 @@ - To be added - To be added + The identifying name of the . + + @@ -50,8 +53,9 @@ - To be added - To be added + User-visible label + + @@ -63,7 +67,8 @@ To be added - To be added + + @@ -74,8 +79,9 @@ - To be added - To be added + Keyboard accelerator + + @@ -87,7 +93,8 @@ To be added - To be added + + @@ -100,10 +107,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.StockItem' - To be added + Returns a new using the given . + an object of type + an object of type + This is not typically used by user code. @@ -115,7 +122,8 @@ To be added - To be added + + @@ -126,9 +134,10 @@ - To be added - To be added: an object of type 'Gtk.StockItem' - To be added + Makes a copy of the current . + an object of type + + diff --git a/doc/en/Gtk/TODO b/doc/en/Gtk/TODO index ba10dbd2a..52a40527b 100644 --- a/doc/en/Gtk/TODO +++ b/doc/en/Gtk/TODO @@ -1,6 +1,6 @@ TODO doc for Gtk namespace. -There are in total 324 xml to document in Gtk. Right now there are 168 xml not documented in any proportion. +There are in total 324 xml to document in Gtk. Right now there are 165 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). @@ -17,7 +17,6 @@ Accelerator.xml Arg.xml Callback.xml CallbackMarshal.xml -Clipboard.xml ClipboardClearFunc.xml ClipboardGetFunc.xml ClipboardReceivedFunc.xml @@ -112,8 +111,6 @@ SettingsPropertyValue.xml SettingsValue.xml SignalFunc.xml Socket.xml -Stock.xml -StockItem.xml StockManager.xml Style.xml Submenu.xml