some more docs: Glade and Atk mostly

svn path=/trunk/gtk-sharp/; revision=31721
This commit is contained in:
John Luke 2004-08-02 02:38:30 +00:00
parent 0cbff45649
commit 076642e2c7
19 changed files with 326 additions and 215 deletions

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A string name/value pair representing a text attribute.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,7 +27,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns an empty <see cref="T:Atk.Attribute" /></summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Atk.Attribute'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>a new <see cref="T:Atk.Attribute" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> The attribute name.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Value">
@ -69,7 +69,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> the value of the attribute, represented as a string.</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View File

@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Event handler.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

View File

@ -7,7 +7,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>Event handler.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>

View File

@ -40,12 +40,13 @@
<Parameter Name="coords" Type="Atk.CoordType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<param name="coords">To be added: an object of type 'Atk.CoordType'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the offset of the character located at coordinates <paramref name="x" /> and <paramref name="y" />. </summary>
<param name="x"> screen x-position of character</param>
<param name="y"> screen y-position of character</param>
<param name="coords"> specify whether coordinates are relative to the screen or widget window</param>
<returns> the offset to the character which is located at the specified x and y coordinates.</returns>
<remarks>
<paramref name="x" /> and <paramref name="y" /> are interpreted as being relative to the screen or this widget's window depending on <paramref name="coords" />.</remarks>
</Docs>
</Member>
<Member MemberName="SetSelection">
@ -60,12 +61,13 @@
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="selection_num">To be added: an object of type 'int'</param>
<param name="start_offset">To be added: an object of type 'int'</param>
<param name="end_offset">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Changes the start and end offset of the specified selection.</summary>
<param name="selection_num"> The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.</param>
<param name="start_offset"> the new start position of the selection</param>
<param name="end_offset"> the new end position of the selection</param>
<returns>
<see langword="true" /> if success, <see langword="false" /> otherwise</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="SetCaretOffset">
@ -78,10 +80,11 @@
<Parameter Name="offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Sets the caret (cursor) position to the specified offset.</summary>
<param name="offset">position</param>
<returns>
<see langword="true" /> if success, <see langword="false" /> otherwise.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RemoveSelection">
@ -94,10 +97,11 @@
<Parameter Name="selection_num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="selection_num">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Removes the specified selection.</summary>
<param name="selection_num"> The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.</param>
<returns>
<see langword="true" /> if success, <see langword="false" /> otherwise</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetText">
@ -111,11 +115,11 @@
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_offset">To be added: an object of type 'int'</param>
<param name="end_offset">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Gets the specified text.</summary>
<param name="start_offset"> start position</param>
<param name="end_offset"> end position</param>
<returns> the text from <paramref name="start_offset" /> up to, but not including <paramref name="end_offset" />.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AddSelection">
@ -129,11 +133,12 @@
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_offset">To be added: an object of type 'int'</param>
<param name="end_offset">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Adds a selection bounded by the specified offsets.</summary>
<param name="start_offset"> the start position of the selected region</param>
<param name="end_offset"> the end position of the selected region</param>
<returns>
<see langword="true" /> if success, <see langword="false" /> otherwise</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DefaultAttributes">
@ -143,9 +148,9 @@
<ReturnType>GLib.SList</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.SList'</returns>
<remarks>To be added</remarks>
<summary>Creates an <see cref="T:Atk.AttributeSet" /> which consists of the default values of attributes for the text.</summary>
<returns> an <see cref="T:Atk.AttributeSet" /> which contains the default values of attributes, at <paramref name="offset" />.</returns>
<remarks>See the enum <see cref="T:Atk.TextAttribute" /> for types of text attributes that can be returned. Note that other attributes may also be returned.</remarks>
</Docs>
</Member>
<Member MemberName="NSelections">
@ -155,9 +160,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the number of selected regions.</summary>
<returns> The number of selected regions, or -1 if a failure occurred.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CaretOffset">
@ -167,9 +172,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the offset position of the caret (cursor).</summary>
<returns> the offset position of the caret (cursor).</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CharacterCount">
@ -179,9 +184,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>Gets the character count.</summary>
<returns> the number of characters.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="TextChanged">
@ -192,8 +197,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the text of the object which implements the AtkText interface changes.</summary>
<remarks>This signal will have a detail which is either "insert" or "delete" which identifies whether the text change was an insertion or a deletion.</remarks>
</Docs>
</Member>
<Member MemberName="TextSelectionChanged">
@ -204,8 +209,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the selected text of an object which implements AtkText changes.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TextCaretMoved">
@ -216,8 +221,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the caret position of the text of an object which implements AtkText changes.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="TextAttributesChanged">
@ -228,8 +233,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the text attributes of the text of an object which implements AtkText changes.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GetTextAfterOffset">
@ -245,13 +250,47 @@
<Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">a <see cref="T:System.Int32" /></param>
<summary>Gets the specified text.</summary>
<param name="offset">position</param>
<param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
<param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<param name="start_offset"> the start offset of the returned string.</param>
<param name="end_offset"> the end offset of the returned string.</param>
<returns> the text after <paramref name="offset" /> bounded by the specified <paramref name="boundary_type" />.</returns>
<remarks>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.Char" /> the character after the offset is returned.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordStart" /> the returned string is from the word start after the offset to the next word start.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordEnd" /> the returned string is from the word end at or after the offset to the next work end.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceStart" /> the returned string is from the sentence start after the offset to the next sentence start.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceEnd" /> the returned string is from the sentence end at or after the offset to the next sentence end.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineStart" /> the returned string is from the line start after the offset to the next line start.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineEnd" /> the returned string is from the line end at or after the offset to the next line start.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetSelection">
@ -266,12 +305,12 @@
<Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="selection_num">a <see cref="T:System.Int32" /></param>
<param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<summary>Gets the text from the specified selection.</summary>
<param name="selection_num"> The selection number. The selected regions are assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.</param>
<param name="start_offset"> passes back the start position of the selected region</param>
<param name="end_offset"> passes back the end position of the selected region</param>
<returns> the selected text.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetTextBeforeOffset">
@ -287,13 +326,47 @@
<Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">a <see cref="T:System.Int32" /></param>
<summary>Gets the specified text.</summary>
<param name="offset">position</param>
<param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
<param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<param name="start_offset"> the start offset of the returned string.</param>
<param name="end_offset"> the end offset of the returned string.</param>
<returns> the text before <paramref name="offset" /> bounded by the specified <paramref name="boundary_type" />.</returns>
<remarks>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.Char" /> the character after the offset is returned.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordStart" /> the returned string is from the word start after the offset to the next word start.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordEnd" /> the returned string is from the word end at or after the offset to the next work end.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceStart" /> the returned string is from the sentence start after the offset to the next sentence start.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceEnd" /> the returned string is from the sentence end at or after the offset to the next sentence end.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineStart" /> the returned string is from the line start after the offset to the next line start.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineEnd" /> the returned string is from the line end at or after the offset to the next line start.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetCharacterExtents">
@ -311,14 +384,14 @@
<Parameter Name="coords" Type="Atk.CoordType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">a <see cref="T:System.Int32" /></param>
<param name="x">a <see cref="T:System.Int32&amp;" /></param>
<param name="y">a <see cref="T:System.Int32&amp;" /></param>
<param name="width">a <see cref="T:System.Int32&amp;" /></param>
<param name="height">a <see cref="T:System.Int32&amp;" /></param>
<param name="coords">a <see cref="T:Atk.CoordType" /></param>
<remarks>To be added</remarks>
<summary>Get the bounding box containing the glyph representing the character at a particular text offset.</summary>
<param name="offset"> The offset of the text character for which bounding information is required.</param>
<param name="x"> Pointer for the x cordinate of the bounding box.</param>
<param name="y"> Pointer for the y cordinate of the bounding box.</param>
<param name="width"> Pointer for the width of the bounding box</param>
<param name="height"> Pointer for the height of the bounding box.</param>
<param name="coords"> specify whether coordinates are relative to the screen or widget window</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetRunAttributes">
@ -333,12 +406,12 @@
<Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">a <see cref="T:System.Int32" /></param>
<param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:GLib.SList" /></returns>
<remarks>To be added</remarks>
<summary>Creates an <see cref="T:Atk.AttributeSet" /> which consists of the attributes explicitly set at the position offset in the text. <paramref name="start_offset" /> and <paramref name="end_offset" /> are set to the start and end of the range around <paramref name="offset" /> where the attributes are invariant.</summary>
<param name="offset"> the offset at which to get the attributes</param>
<param name="start_offset"> the address to put the start offset of the range</param>
<param name="end_offset"> the address to put the end offset of the range</param>
<returns> an <see cref="T:Atk.AttributeSet" /> which contains the attributes explicitly set at <paramref name="offset" />.</returns>
<remarks>See the enum <see cref="T:Atk.TextAttribute" /> for types of text attributes that can be returned. Note that other attributes may also be returned.</remarks>
</Docs>
</Member>
<Member MemberName="GetTextAtOffset">
@ -354,13 +427,47 @@
<Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">a <see cref="T:System.Int32" /></param>
<summary>Gets the specified text.</summary>
<param name="offset"> position</param>
<param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
<param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
<param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<param name="start_offset"> the start offset of the returned string.</param>
<param name="end_offset"> the end offset of the returned string.</param>
<returns> the text at <paramref name="offset" /> bounded by the specified <paramref name="boundary_type" />.</returns>
<remarks>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.Char" /> the character after the offset is returned.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordStart" /> the returned string is from the word start after the offset to the next word start.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word or if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.WordEnd" /> the returned string is from the word end at or after the offset to the next work end.
</para>
<para>
The returned string will contain the word after the offset if the offset is inside a word and will contain the word after the word after the offset if the offset is not inside a word.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceStart" /> the returned string is from the sentence start after the offset to the next sentence start.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence or if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.SentenceEnd" /> the returned string is from the sentence end at or after the offset to the next sentence end.
</para>
<para>
The returned string will contain the sentence after the offset if the offset is inside a sentence and will contain the sentence after the sentence after the offset if the offset is not inside a sentence.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineStart" /> the returned string is from the line start after the offset to the next line start.
</para>
<para>
If the <paramref name="boundary_type" /> is <see cref="F:Atk.TextBoundary.LineEnd" /> the returned string is from the line end at or after the offset to the next line start.
</para>
</remarks>
</Docs>
</Member>
</Members>

View File

@ -87,9 +87,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Atk.Util" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

View File

@ -33,9 +33,10 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<summary>Sets the value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> which is the desired new accessible value.</param>
<returns>
<see langword="true" /> if new value is successfully set, otherwise <see langword="false" />.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -49,9 +50,9 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<remarks>To be added</remarks>
<summary>Gets the minimum value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> representing the minimum accessible value</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetMaximumValue">
@ -64,9 +65,9 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /></param>
<remarks>To be added</remarks>
<summary>Gets the maximum value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> representing the maximum accessible value</param>
<remarks />
</Docs>
</Member>
<Member MemberName="GetCurrentValue">
@ -79,9 +80,9 @@
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="value">To be added: an object of type 'GLib.Value'</param>
<remarks>This is a constructor used by derivative types of <see cref="T:Atk.Value" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks>
<summary>Gets the value of this object.</summary>
<param name="value">an object of type <see cref="T:GLib.Value" /> representing the current accessible value</param>
<remarks />
</Docs>
</Member>
</Members>

View File

@ -10,7 +10,7 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.AccelInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.AccelInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.AccelInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Key">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.AtkActionInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.AtkActionInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.AtkActionInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="ActionName">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.AtkRelationInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.AtkRelationInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.AtkRelationInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Target">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.ChildInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.ChildInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.ChildInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="child">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Global API elements for <see cref="N:Glade" /></summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -88,9 +88,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Glade.Global" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="RegisterCustomProp">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Exception thrown when signal autoconnection fails.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Exception</BaseTypeName>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structures described here are the output of libglade's XML parser.</summary>
<remarks>These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. </remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.Interface" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.Interface'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.Interface" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Destroy">
@ -55,8 +55,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees the resources of this interface.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Dump">
@ -69,9 +69,9 @@
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="filename">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<summary>This function dumps the contents of a <see cref="T:Glade.Interface" /> into a file as XML.</summary>
<param name="filename">a <see cref="T:System.String" /></param>
<remarks>It is intended mainly as a debugging tool.</remarks>
</Docs>
</Member>
<Member MemberName="toplevels">
@ -82,7 +82,7 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.WidgetInfo'</returns>
<returns>an object of type <see cref="T:Glade.WidgetInfo" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Glade's parser used to turn XML into its internal format.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -30,11 +30,11 @@
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This function parses a Glade XML interface file to a <see cref="T:Glade.Interface" /> object (which is libglade's internal representation of the interface data).</summary>
<param name="file">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Glade.Interface" /></returns>
<remarks>To be added</remarks>
<remarks>Generally, user code will not need to call this function. Instead, it should go through the <see cref="T:Glade.XML" /> interfaces.</remarks>
</Docs>
</Member>
<Member MemberName="ParseBuffer">
@ -48,11 +48,14 @@
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This function is similar to <see cref="M:Glade.Parser.ParseFile()" />, except that it parses XML data from a buffer in memory.</summary>
<param name="buffer">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Glade.Interface" /></returns>
<remarks>To be added</remarks>
<remarks>This could be used to embed an interface into the executable, for instance.
<para>
Generally, user code will not need to call this function. Instead, it should go through the <see cref="T:Glade.XML" /> interfaces.
</para></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -61,9 +64,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Glade.Parser" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.Property" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.Property'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.Property" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Name">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.SignalInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.SignalInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.SignalInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="Name">

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Some standard methods used by glade to build widgets.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -31,11 +31,11 @@
<Parameter Name="info" Type="Glade.WidgetInfo" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This is the standard child building function.</summary>
<param name="self">a <see cref="T:Glade.XML" /></param>
<param name="parent">a <see cref="T:Gtk.Widget" /></param>
<param name="info">a <see cref="T:Glade.WidgetInfo" /></param>
<remarks>To be added</remarks>
<remarks>It simply calls <see cref="M:Gtk.Container.Add()" /> on each child to add them to the parent, and process any packing properties using the generic container packing properties interfaces.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -44,9 +44,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Glade.Standard" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="BuildWidget">
@ -61,12 +61,12 @@
<Parameter Name="info" Type="Glade.WidgetInfo" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>This is the standard widget building function.</summary>
<param name="xml">a <see cref="T:Glade.XML" /></param>
<param name="widget_type">a <see cref="T:GLib.GType" /></param>
<param name="info">a <see cref="T:Glade.WidgetInfo" /></param>
<returns>a <see cref="T:Gtk.Widget" /></returns>
<remarks>To be added</remarks>
<remarks>It processes all the widget properties using the standard object properties interfaces. This function will be sufficient for most widget types, thus reducing the amount of work needed to wrap a library.</remarks>
</Docs>
</Member>
</Members>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The structures described here are the output of libglade's XML parser.</summary>
<remarks>These structures are really only useful for people who are extending libglade to handle other widget sets, but it could also be useful for other applications that need to read glade XML files. If you only wish to use libglade, you don't need to worry about these functions and structures. </remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Glade.WidgetInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Glade.WidgetInfo'</returns>
<remarks>To be added</remarks>
<summary>Internal method</summary>
<param name="raw">an object of type <see cref="T:System.IntPtr" /></param>
<returns>an object of type <see cref="T:Glade.WidgetInfo" /></returns>
<remarks>This is an internal method and should not be used by user code.</remarks>
</Docs>
</Member>
<Member MemberName="children">

View File

@ -652,8 +652,8 @@ public class GladeApp
This is used while the tree is being built to set the toplevel window that
is currently being built.
</summary>
<param name="value">To be added: an object of type 'Gtk.Window'</param>
<returns>To be added: an object of type 'Gtk.Window'</returns>
<param name="value">an object of type <see cref="T:Gtk.Window" /></param>
<returns>an object of type <see cref="T:Gtk.Window" /></returns>
<remarks>
<para>
This is used while the tree is being built to set the
@ -735,8 +735,8 @@ public class GladeApp
</ReturnValue>
<Docs>
<summary>returns a widget created from the glade xml file. </summary>
<returns>a <see cref="T:Gtk.Widget" /> or null when the the widget with taht name is't found.</returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Gtk.Widget" /> or null when the the widget with that name is not found.</returns>
<remarks>An indexer of the widgets that acts like GetWidget</remarks>
</Docs>
</Member>
<Member MemberName="FromStream">
@ -751,12 +751,12 @@ public class GladeApp
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Glade.XML" /> from a stream.</summary>
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
<param name="root">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Glade.XML" /></returns>
<remarks>To be added</remarks>
<remarks>Reads the contents of the stream and parses it. It must be in correct Glade format</remarks>
</Docs>
</Member>
<Member MemberName="FromAssembly">
@ -772,13 +772,13 @@ public class GladeApp
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns a new <see cref="T:Glade.XML" /> from a resource in an assembly.</summary>
<param name="assembly">a <see cref="T:System.Reflection.Assembly" /></param>
<param name="resource_name">a <see cref="T:System.String" /></param>
<param name="root">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Glade.XML" /></returns>
<remarks>To be added</remarks>
<remarks>Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format</remarks>
</Docs>
</Member>
<Member MemberName="FromAssembly">
@ -793,12 +793,12 @@ public class GladeApp
<Parameter Name="domain" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns a new <see cref="T:Glade.XML" /> from a resource in the current assembly.</summary>
<param name="resource_name">a <see cref="T:System.String" /></param>
<param name="root">a <see cref="T:System.String" /></param>
<param name="domain">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Glade.XML" /></returns>
<remarks>To be added</remarks>
<remarks>Reads the contents of the resource in the given assembly and parses it. If the assembly is null, the current assembly will be used. It must be in correct Glade format</remarks>
</Docs>
</Member>
<Member MemberName="GType">