ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

2004-12-15 John Luke <john.luke@gmail.com>

Browse source 
* 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
This commit is contained in:
John Luke 2004-12-15 21:46:24 +00:00
parent e3e4c2528a
commit 4ff5ea4ddb
12 changed files with 119 additions and 93 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/ChangeLog
View file

@ -1,3 +1,17 @@
2004-12-15 John Luke <john.luke@gmail.com>
* 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 <john.luke@gmail.com>
* en/Pango/FcFont.xml:

4
doc/en/Atk/Hyperlink.xml
View file

@ -364,8 +364,8 @@ Multiple anchors are primarily used by client-side image maps.
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Default handler for the <see cref="M:Atk.Hyperlink.LinkActivated" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.Hyperlink.LinkActivated" /> event.</remarks>
</Docs>
</Member>
</Members>

12
doc/en/Atk/LinkSelectedArgs.xml
View file

@ -9,8 +9,10 @@
</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>Event data.</summary>
<remarks>
<para>The <see cref="M:Atk.NoOpObject.LinkSelected" /> event invokes <see cref="T:Atk.LinkSelectedHandler" /> delegates which pass event data via this class.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName>
@ -24,9 +26,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Atk.LinkSelectedArgs" /></returns>
<remarks>To be added</remarks>
<summary>Public Constructor.</summary>
<returns>A new <see cref="T:Atk.LinkSelectedArgs" />.</returns>
<remarks>Create a new <see cref="T:Atk.LinkSelectedArgs" /> instance with this constructor if you need to invoke a <see cref="T:Atk.LinkSelectedHandler" /> delegate.</remarks>
</Docs>
</Member>
<Member MemberName="LinkIndex">

8
doc/en/Atk/LinkSelectedHandler.xml
View file

@ -9,8 +9,12 @@
</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>Event handler.</summary>
<remarks>
<para>The <see cref="M:Atk.NoOpObject.LinkSelected" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Atk.LinkSelectedArgs" /> parameter.</para>
<para>To attach a <see cref="T:Atk.LinkSelectedHandler" /> 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.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

6
doc/en/Atk/NoOpObject.xml
View file

@ -1874,9 +1874,9 @@
<Parameter Name="link_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Default handler for the <see cref="M:Atk.NoOpObject.LinkSelected" /> event.</summary>
<param name="link_index">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.NoOpObject.LinkSelected" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="CurrentValue">
@ -1893,4 +1893,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

22
doc/en/Atk/StateManager.xml
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>An AtkState describes a component's particular state.</summary>
<remarks>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.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -29,10 +29,10 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the <see cref="T:Atk.StateType" /> corresponding to the description string <paramref name="name" />.</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Atk.StateType" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="TypeGetName">
@ -45,10 +45,10 @@
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the description string describing the <paramref name="type" />.</summary>
<param name="type">a <see cref="T:Atk.StateType" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="TypeRegister">
@ -61,10 +61,10 @@
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<summary>Register a new object state.</summary>
<param name="name">a <see cref="T:System.String" /> describing the new state.</param>
<returns>a <see cref="T:Atk.StateType" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -73,9 +73,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Atk.StateManager" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

56
doc/en/Atk/StateSet.xml
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>An <see cref="T:Atk.StateSet" /> determines a component's state set.</summary>
<remarks>An <see cref="T:Atk.StateSet" /> determines a component's state set. It is composed of a set of <see cref="T:Atk.State" />s.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
@ -36,10 +36,10 @@
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Checks whether the state for the specified type is in the specified set.</summary>
<param name="type">an object of type <see cref="T:Atk.StateType" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:System.Boolean" />, <see langword="true" /> if type is the state type is in set.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="XorSets">
@ -52,10 +52,10 @@
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructs the exclusive-or of the two sets, returning <see langword="null" /> is empty.</summary>
<param name="compare_set">an object of type <see cref="T:Atk.StateSet" /></param>
<returns>an object of type <see cref="T:Atk.StateSet" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:Atk.StateSet" /> which contains the states which are in exactly one of the two sets.</returns>
<remarks>The set returned by this operation contains the states in exactly one of the two sets.</remarks>
</Docs>
</Member>
<Member MemberName="AddState">
@ -68,10 +68,10 @@
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Add a new state for the specified type to the current state set if it is not already present.</summary>
<param name="type">an object of type <see cref="T:Atk.StateType" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:System.Boolean" />, <see langword="true" /> if the state for type is not already in set.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AndSets">
@ -84,10 +84,10 @@
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructs the intersection of the two sets, returning <see langword="null" /> if the intersection is empty.</summary>
<param name="compare_set">an object of type <see cref="T:Atk.StateSet" /></param>
<returns>an object of type <see cref="T:Atk.StateSet" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:Atk.StateSet" /> which is the intersection of the two sets.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RemoveState">
@ -100,10 +100,10 @@
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Removes the state for the specified type from the state set.</summary>
<param name="type">an object of type <see cref="T:Atk.StateType" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>an object of type <see cref="T:System.Boolean" />, <see langword="true" /> if type was the state type is in set.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="OrSets">
@ -116,9 +116,9 @@
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructs the union of the two sets.</summary>
<param name="compare_set">an object of type <see cref="T:Atk.StateSet" /></param>
<returns>an object of type <see cref="T:Atk.StateSet" /></returns>
<returns>an object of type <see cref="T:Atk.StateSet" /> which is the union of the two sets, returning <see langword="null" /> is empty.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -130,8 +130,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Removes all states from the state set.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Finalize">
@ -168,9 +168,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>an object of type <see cref="T:Atk.StateSet" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ContainsStates">
@ -184,7 +184,7 @@
<Parameter Name="n_types" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Checks whether the states for all the specified types are in the specified set.</summary>
<param name="types">a <see cref="T:Atk.StateType&amp;" /></param>
<param name="n_types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
@ -199,9 +199,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<summary>Checks whether the state set is empty, i.e. has no states set.</summary>
<returns>a <see cref="T:System.Boolean" />, <see langword="true" /> if the StateSet has no states set, otherwise <see langword="false" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
@ -241,7 +241,7 @@
<Parameter Name="n_types" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Add the states for the specified types to the current state set.</summary>
<param name="n_types">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Atk.StateType" /></returns>
<remarks>To be added</remarks>

12
doc/en/Atk/TextClipType.xml
View file

@ -9,8 +9,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>Describes the type of clipping required.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> No clipping to be done</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -50,7 +50,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Text clipped by min coordinate is omitted</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -63,7 +63,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Text clipped by max coordinate is omitted</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -76,7 +76,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary> Only text fully within mix/max bound is retained</summary>
<remarks>To be added</remarks>
</Docs>
</Member>

28
doc/en/Atk/TextRange.xml
View file

@ -9,8 +9,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 structure used to describe a text range.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty <see cref="T:Atk.TextRange" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Bounds">
@ -40,8 +40,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> A rectangle giving the bounds of the text range</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="StartOffset">
@ -53,8 +53,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> The start offset of a <see cref="T:Atk.TextRange" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="EndOffset">
@ -66,8 +66,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> The end offset of a <see cref="T:Atk.TextRange" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Content">
@ -79,8 +79,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> The text in the text range</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -93,10 +93,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Atk.TextRange" /></summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Atk.TextRange" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

28
doc/en/Atk/TextRectangle.xml
View file

@ -9,8 +9,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 structure used to store a rectangle used by <see cref="T:Atk.Text" />.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty <see cref="T:Atk.TextRectangle" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="X">
@ -40,8 +40,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The horizontal coordinate of a rectangle</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Y">
@ -53,8 +53,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary> The vertical coordinate of a rectangle</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Width">
@ -66,8 +66,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The width of a rectangle</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Height">
@ -79,8 +79,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The height of a rectangle</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -93,10 +93,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Atk.TextRectangle" /></summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Atk.TextRectangle" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
</Members>

14
doc/en/Gtk/FileChooserAction.xml
View file

@ -38,7 +38,8 @@
</Parameters>
<Docs>
<summary>Indicates open mode. The file chooser will only let the user pick an existing file.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Save">
@ -51,7 +52,8 @@
</Parameters>
<Docs>
<summary>Indicates save mode. The file chooser will let the user pick an existing file, or type in a new filename.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="SelectFolder">
@ -64,7 +66,8 @@
</Parameters>
<Docs>
<summary>Indicates an Open mode for selecting folders. The file chooser will let the user pick an existing folder.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateFolder">
@ -77,7 +80,8 @@
</Parameters>
<Docs>
<summary>Indicates a mode for creating a new folder. The file chooser will let the user name an existing or new folder.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="value__">
@ -94,4 +98,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

8
doc/en/Gtk/FileChooserError.xml
View file

@ -38,7 +38,8 @@
</Parameters>
<Docs>
<summary>Indicates that a file does not exist.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="BadFilename">
@ -51,7 +52,8 @@
</Parameters>
<Docs>
<summary>Indicates a malformed filename.</summary>
<remarks></remarks>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="value__">
@ -68,4 +70,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>