mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-09 00:13:20 +02:00
More docs, papacito
svn path=/trunk/gtk-sharp/; revision=30138
This commit is contained in:
Duncan Mak
parent
dac325e217
commit
bf3872b0ae
@ -10,8 +10,18 @@
|
||||
</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.Relation" /> describes a relation between an object and one or more other objects.</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
An <see cref="T:Atk.Relation" /> describes a relation between an object and
|
||||
one or more other objects.
|
||||
</para>
|
||||
<para>
|
||||
The actual relations that an object has with other objects are
|
||||
defined as an <see cref="T:Atk.RelationSet" />, which is a set of
|
||||
<see cref="T:Atk.Relations" />.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>GLib.Object</BaseTypeName>
|
||||
@ -63,7 +73,7 @@
|
||||
<Parameter Name="n_targets" Type="System.Int32" />
|
||||
<Parameter Name="relationship" Type="Atk.RelationType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<Docs>n
|
||||
<summary>To be added</summary>
|
||||
<param name="targets">an object of type <see cref="T:Atk.Object" /></param>
|
||||
<param name="n_targets">an object of type <see cref="T:System.Int32" /></param>
|
||||
@ -79,9 +89,9 @@
|
||||
<ReturnType>Atk.RelationType</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>an object of type <see cref="T:Atk.RelationType" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Gets the type of relation.</summary>
|
||||
<returns>The type of this relation</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Target">
|
||||
|
||||
@ -10,8 +10,11 @@
|
||||
</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 set of <see cref="T:Atk.Relations" />, normally the set which
|
||||
an <see cref="T:Atk.Object" /> has.
|
||||
</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>GLib.Object</BaseTypeName>
|
||||
@ -36,10 +39,13 @@
|
||||
<Parameter Name="i" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="i">an object of type <see cref="T:System.Int32" /></param>
|
||||
<returns>an object of type <see cref="T:Atk.Relation" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Determines the relation at the specified position in the relation set.</summary>
|
||||
<param name="i">An <see cref="T:System.Int32" /> representing a position in the set, starting from 0.</param>
|
||||
<returns>
|
||||
An <see cref="T:Atk.Relation" />, which is the relation at
|
||||
position <paramref name="i" /> in the set.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetRelationByType">
|
||||
@ -52,10 +58,10 @@
|
||||
<Parameter Name="relationship" Type="Atk.RelationType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="relationship">an object of type <see cref="T:Atk.RelationType" /></param>
|
||||
<returns>an object of type <see cref="T:Atk.RelationType" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Finds a relation that matches the specified type.</summary>
|
||||
<param name="relationship">An <see cref="T:Atk.RelationType" /></param>
|
||||
<returns>An <see cref="T:Atk.Relation" />, which is a relation matching the specified type.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Add">
|
||||
@ -68,9 +74,9 @@
|
||||
<Parameter Name="relation" Type="Atk.Relation" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="relation">an object of type <see cref="T:Atk.RelationType" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Add a new relation to the current relation set if it is not already present.</summary>
|
||||
<param name="relation">an <see cref="T:Atk.Relation" /></param>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Contains">
|
||||
@ -83,10 +89,13 @@
|
||||
<Parameter Name="relationship" Type="Atk.RelationType" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="relationship">an object of type <see cref="T:Atk.RelationType" /></param>
|
||||
<returns>an object of type <see cref="T:System.Boolean" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Determines whether the relation set contains a relation that matches the specified type.</summary>
|
||||
<param name="relationship">An <see cref="T:Atk.RelationType" />.</param>
|
||||
<returns>
|
||||
<see langword="true" /> if relationship is the relationship
|
||||
type of a relation in set, <see langword="false" /> otherwise.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Remove">
|
||||
@ -99,9 +108,9 @@
|
||||
<Parameter Name="relation" Type="Atk.Relation" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="relation">an object of type <see cref="T:Atk.Relation" /></param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Removes a relation from the relation set.</summary>
|
||||
<param name="relation">An <see cref="T:Atk.Relation" />.</param>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
@ -150,9 +159,9 @@
|
||||
<ReturnType>System.Int32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>an object of type <see cref="T:System.Int32" /></returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Determines the number of relations in a relation set.</summary>
|
||||
<returns>An integer representing the number of relations in the set.</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
||||
@ -10,8 +10,28 @@
|
||||
</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 ATK interface implemented by container objects whose <see cref="T:Atk.Object" /> children can be selected.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
The ATK interface implemented by container objects whose <see cref="T:Atk.Object" /> children can be selected.
|
||||
</para>
|
||||
<para>
|
||||
This should be implemented by UI components with children
|
||||
which are exposed by <see cref="M:Atk.Object.RefChild" /> and
|
||||
<see cref="M:Atk.Object.NChildren" />, if the use of the parent UI
|
||||
component ordinarily involves selection of one or more of the
|
||||
objects corresponding to those AtkObject children - for
|
||||
example, selectable lists.
|
||||
</para>
|
||||
<para>
|
||||
Note that other types of "selection" (for instance text
|
||||
selection) are accomplished a other ATK interfaces -
|
||||
<see cref="T:Atk.Selection" /> is limited to the selection/deselection of
|
||||
children.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
<Base />
|
||||
<Interfaces>
|
||||
@ -29,9 +49,11 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Causes every child of the object to be selected if the object supports multiple selections.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if success, <see langword="false" /> otherwise.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RemoveSelection">
|
||||
@ -44,10 +66,16 @@
|
||||
<Parameter Name="i" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="i">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 child of the object from the object's selection.</summary>
|
||||
<param name="i">
|
||||
A <see langword="int" /> specifying the index in the selection set. (e.g. the
|
||||
ith selection as opposed to the ith child).
|
||||
</param>
|
||||
<returns>
|
||||
<see langword="true" /> if success, <see langword="false" />
|
||||
otherwise.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="IsChildSelected">
|
||||
@ -60,10 +88,17 @@
|
||||
<Parameter Name="i" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="i">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>Determines if the current child of this object is selected.</summary>
|
||||
<param name="i">A <see langword="int" /> specifying the child index.</param>
|
||||
<returns>A bool representing the specified child is selected, or 0 if selection does not implement this interface.</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Callers should not rely on 0 or on a zero value for
|
||||
indication of whether AtkSelectionIface is implemented, they
|
||||
should use type checking/interface checking macros or the
|
||||
atk_get_accessible_value() convenience method.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ClearSelection">
|
||||
@ -74,9 +109,11 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Clears the selection in the object so that no children in the object are selected.</summary>
|
||||
<returns>
|
||||
<see langword="true" /> if success, <see langword="false" /> otherwise.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="AddSelection">
|
||||
@ -89,10 +126,12 @@
|
||||
<Parameter Name="i" Type="System.Int32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="i">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 the specified accessible child of the object to the object's selection.</summary>
|
||||
<param name="i">A <see langword="int" /> specifying the child index.</param>
|
||||
<returns>
|
||||
<see langword="true" /> if success, <see langword="false" /> otherwise.
|
||||
</returns>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RefSelection">
|
||||
@ -118,9 +157,20 @@
|
||||
<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 accessible children currently selected.</summary>
|
||||
<returns>
|
||||
A <see langword="int" /> representing the number of items
|
||||
selected, or 0 if selection does not implement this
|
||||
interface.
|
||||
</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
Callers should not rely on 0 or on a zero value for
|
||||
indication of whether AtkSelectionIface is implemented,
|
||||
they should use type checking/interface checking macros or
|
||||
the atk_get_accessible_value() convenience method.
|
||||
</para>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="SelectionChanged">
|
||||
@ -131,8 +181,8 @@
|
||||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Event fired when the selected is changed.</summary>
|
||||
<remarks />
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user