From 4ff5ea4ddb707479577397ed5d9e224a373d4781 Mon Sep 17 00:00:00 2001 From: John Luke Date: Wed, 15 Dec 2004 21:46:24 +0000 Subject: [PATCH] 2004-12-15 John Luke * en/Atk/LinkSelectedArgs.xml * en/Atk/StateSet.xml * en/Atk/TextRange.xml * en/Atk/HyperLink.xml * en/Atk/TextRectangle.xml * en/Atk/NoOpObject.xml * en/Atk/LinkSelectedHandler.xml * en/Atk/StateManager.xml * en/Atk/TextClipType.xml * en/Gtk/FileChooserAction.xml * en/Gtk/FileChooserError.xml: add docs svn path=/trunk/gtk-sharp/; revision=37811 --- doc/ChangeLog | 14 ++++++++ doc/en/Atk/Hyperlink.xml | 4 +-- doc/en/Atk/LinkSelectedArgs.xml | 12 ++++--- doc/en/Atk/LinkSelectedHandler.xml | 8 +++-- doc/en/Atk/NoOpObject.xml | 6 ++-- doc/en/Atk/StateManager.xml | 22 ++++++------ doc/en/Atk/StateSet.xml | 56 +++++++++++++++--------------- doc/en/Atk/TextClipType.xml | 12 +++---- doc/en/Atk/TextRange.xml | 28 +++++++-------- doc/en/Atk/TextRectangle.xml | 28 +++++++-------- doc/en/Gtk/FileChooserAction.xml | 14 +++++--- doc/en/Gtk/FileChooserError.xml | 8 +++-- 12 files changed, 119 insertions(+), 93 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 46c24c18d..07caf44f6 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,17 @@ +2004-12-15 John Luke + + * en/Atk/LinkSelectedArgs.xml + * en/Atk/StateSet.xml + * en/Atk/TextRange.xml + * en/Atk/HyperLink.xml + * en/Atk/TextRectangle.xml + * en/Atk/NoOpObject.xml + * en/Atk/LinkSelectedHandler.xml + * en/Atk/StateManager.xml + * en/Atk/TextClipType.xml + * en/Gtk/FileChooserAction.xml + * en/Gtk/FileChooserError.xml: add docs + 2004-12-15 John Luke * en/Pango/FcFont.xml: diff --git a/doc/en/Atk/Hyperlink.xml b/doc/en/Atk/Hyperlink.xml index 55086d16e..274ecdbb6 100644 --- a/doc/en/Atk/Hyperlink.xml +++ b/doc/en/Atk/Hyperlink.xml @@ -364,8 +364,8 @@ Multiple anchors are primarily used by client-side image maps. - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Atk/LinkSelectedArgs.xml b/doc/en/Atk/LinkSelectedArgs.xml index 2e8e11fcc..521fce954 100644 --- a/doc/en/Atk/LinkSelectedArgs.xml +++ b/doc/en/Atk/LinkSelectedArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Atk/LinkSelectedHandler.xml b/doc/en/Atk/LinkSelectedHandler.xml index cd87ed0d9..dd8bd66a5 100644 --- a/doc/en/Atk/LinkSelectedHandler.xml +++ b/doc/en/Atk/LinkSelectedHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the LinkSelectedHandler instance to the event. The methods referenced by the LinkSelectedHandler instance are invoked whenever the event is raised, until the LinkSelectedHandler is removed from the event. + System.Delegate diff --git a/doc/en/Atk/NoOpObject.xml b/doc/en/Atk/NoOpObject.xml index 55594539c..025fec28c 100644 --- a/doc/en/Atk/NoOpObject.xml +++ b/doc/en/Atk/NoOpObject.xml @@ -1874,9 +1874,9 @@ - To be added + Default handler for the event. a - To be added + Override this method in a subclass to provide a default handler for the event. @@ -1893,4 +1893,4 @@ - + \ No newline at end of file diff --git a/doc/en/Atk/StateManager.xml b/doc/en/Atk/StateManager.xml index 25bc31c04..f1dab6827 100644 --- a/doc/en/Atk/StateManager.xml +++ b/doc/en/Atk/StateManager.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 AtkState describes a component's particular state. + An AtkState describes a component's particular state. The actual state of an component is described by its AtkStateSet, which is a set of AtkStates. System.Object @@ -29,10 +29,10 @@ - To be added + Gets the corresponding to the description string . a a - To be added + @@ -45,10 +45,10 @@ - To be added + Gets the description string describing the . a a - To be added + @@ -61,10 +61,10 @@ - To be added - a + Register a new object state. + a describing the new state. a - To be added + @@ -73,9 +73,9 @@ - To be added + Default constructor a - To be added + diff --git a/doc/en/Atk/StateSet.xml b/doc/en/Atk/StateSet.xml index 2795bd6c7..72c0dc678 100644 --- a/doc/en/Atk/StateSet.xml +++ b/doc/en/Atk/StateSet.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 determines a component's state set. + An determines a component's state set. It is composed of a set of s. GLib.Object @@ -36,10 +36,10 @@ - To be added + Checks whether the state for the specified type is in the specified set. an object of type - an object of type - To be added + an object of type , if type is the state type is in set. + @@ -52,10 +52,10 @@ - To be added + Constructs the exclusive-or of the two sets, returning is empty. an object of type - an object of type - To be added + an object of type which contains the states which are in exactly one of the two sets. + The set returned by this operation contains the states in exactly one of the two sets. @@ -68,10 +68,10 @@ - To be added + Add a new state for the specified type to the current state set if it is not already present. an object of type - an object of type - To be added + an object of type , if the state for type is not already in set. + @@ -84,10 +84,10 @@ - To be added + Constructs the intersection of the two sets, returning if the intersection is empty. an object of type - an object of type - To be added + an object of type which is the intersection of the two sets. + @@ -100,10 +100,10 @@ - To be added + Removes the state for the specified type from the state set. an object of type - an object of type - To be added + an object of type , if type was the state type is in set. + @@ -116,9 +116,9 @@ - To be added + Constructs the union of the two sets. an object of type - an object of type + an object of type which is the union of the two sets, returning is empty. To be added @@ -130,8 +130,8 @@ - To be added - To be added + Removes all states from the state set. + @@ -168,9 +168,9 @@ - To be added + Default constructor an object of type - To be added + @@ -184,7 +184,7 @@ - To be added + Checks whether the states for all the specified types are in the specified set. a a a @@ -199,9 +199,9 @@ - To be added - a - To be added + Checks whether the state set is empty, i.e. has no states set. + a , if the StateSet has no states set, otherwise + @@ -241,7 +241,7 @@ - To be added + Add the states for the specified types to the current state set. a a To be added diff --git a/doc/en/Atk/TextClipType.xml b/doc/en/Atk/TextClipType.xml index c0cad9949..c2e295330 100644 --- a/doc/en/Atk/TextClipType.xml +++ b/doc/en/Atk/TextClipType.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 + Describes the type of clipping required. + System.Enum @@ -37,7 +37,7 @@ - To be added + No clipping to be done To be added @@ -50,7 +50,7 @@ - To be added + Text clipped by min coordinate is omitted To be added @@ -63,7 +63,7 @@ - To be added + Text clipped by max coordinate is omitted To be added @@ -76,7 +76,7 @@ - To be added + Only text fully within mix/max bound is retained To be added diff --git a/doc/en/Atk/TextRange.xml b/doc/en/Atk/TextRange.xml index 1560dec20..d7b6e136b 100644 --- a/doc/en/Atk/TextRange.xml +++ b/doc/en/Atk/TextRange.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 + A structure used to describe a text range. + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty + @@ -40,8 +40,8 @@ - To be added - To be added + A rectangle giving the bounds of the text range + @@ -53,8 +53,8 @@ - To be added - To be added + The start offset of a + @@ -66,8 +66,8 @@ - To be added - To be added + The end offset of a + @@ -79,8 +79,8 @@ - To be added - To be added + The text in the text range + @@ -93,10 +93,10 @@ - To be added + Creates a new a a - To be added + diff --git a/doc/en/Atk/TextRectangle.xml b/doc/en/Atk/TextRectangle.xml index f33451a4f..1f7ab504f 100644 --- a/doc/en/Atk/TextRectangle.xml +++ b/doc/en/Atk/TextRectangle.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 + A structure used to store a rectangle used by . + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty + @@ -40,8 +40,8 @@ - To be added - To be added + The horizontal coordinate of a rectangle + @@ -53,8 +53,8 @@ - To be added - To be added + The vertical coordinate of a rectangle + @@ -66,8 +66,8 @@ - To be added - To be added + The width of a rectangle + @@ -79,8 +79,8 @@ - To be added - To be added + The height of a rectangle + @@ -93,10 +93,10 @@ - To be added + Creates a new a a - To be added + diff --git a/doc/en/Gtk/FileChooserAction.xml b/doc/en/Gtk/FileChooserAction.xml index 610f3e8c1..252a05ed4 100644 --- a/doc/en/Gtk/FileChooserAction.xml +++ b/doc/en/Gtk/FileChooserAction.xml @@ -38,7 +38,8 @@ Indicates open mode. The file chooser will only let the user pick an existing file. - + + @@ -51,7 +52,8 @@ Indicates save mode. The file chooser will let the user pick an existing file, or type in a new filename. - + + @@ -64,7 +66,8 @@ Indicates an Open mode for selecting folders. The file chooser will let the user pick an existing folder. - + + @@ -77,7 +80,8 @@ Indicates a mode for creating a new folder. The file chooser will let the user name an existing or new folder. - + + @@ -94,4 +98,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooserError.xml b/doc/en/Gtk/FileChooserError.xml index 807c3c4c0..861dd0d7b 100644 --- a/doc/en/Gtk/FileChooserError.xml +++ b/doc/en/Gtk/FileChooserError.xml @@ -38,7 +38,8 @@ Indicates that a file does not exist. - + + @@ -51,7 +52,8 @@ Indicates a malformed filename. - + + @@ -68,4 +70,4 @@ - + \ No newline at end of file