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

Two docs a day keeps Papacito away....

Browse source 
svn path=/trunk/gtk-sharp/; revision=30356
This commit is contained in:
Duncan Mak 2004-06-24 22:17:50 +00:00
parent 41e324b368
commit 41eed13456
2 changed files with 121 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
doc/en/Atk/EditableText.xml
View file

@ -10,8 +10,20 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>The ATK interface implemented by components containing user-editable text content</summary>
<remarks>To be added</remarks> <remarks>
<para>
<see cref="T:Atk.EditableText" /> should be implemented by UI components which
contain text which the user can edit, via the <see
cref="T:Atk.Object" /> corresponding to that component (see <see cref="T:Atk.Object" />).
</para>
<para>
<see cref="T:Atk.EditableText" /> is a subclass of <see
cref="T:Atk.Text" />, and as such, an
object which implements AtkEditableText is by definition an
<see cref="T:Atk.Text" /> implementor as well.
</para>
</remarks>
</Docs> </Docs>
<Base /> <Base />
<Interfaces> <Interfaces>
@ -32,10 +44,14 @@
<Parameter Name="end_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Delete text</summary>
<param name="start_pos">To be added: an object of type 'int'</param> <param name="start_pos">start position</param>
<param name="end_pos">To be added: an object of type 'int'</param> <param name="end_pos">end position</param>
<remarks>To be added</remarks> <remarks>
<para>
This only deletes text up to, but not including <paramref
name="end_pos" />.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PasteText"> <Member MemberName="PasteText">
@ -48,9 +64,9 @@
<Parameter Name="position" Type="System.Int32" /> <Parameter Name="position" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Paste text from clipboard to specified position.</summary>
<param name="position">To be added: an object of type 'int'</param> <param name="position">position to paste</param>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CutText"> <Member MemberName="CutText">
@ -64,10 +80,15 @@
<Parameter Name="end_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Cut text</summary>
<param name="start_pos">To be added: an object of type 'int'</param> <param name="start_pos">start position</param>
<param name="end_pos">To be added: an object of type 'int'</param> <param name="end_pos">end position</param>
<remarks>To be added</remarks> <remarks>
<para>
This method only cuts the text up to <paremref
name="end_pos" />, it does not include the text at that position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CopyText"> <Member MemberName="CopyText">
@ -81,10 +102,15 @@
<Parameter Name="end_pos" Type="System.Int32" /> <Parameter Name="end_pos" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Copy text</summary>
<param name="start_pos">To be added: an object of type 'int'</param> <param name="start_pos">start position</param>
<param name="end_pos">To be added: an object of type 'int'</param> <param name="end_pos">end position</param>
<remarks>To be added</remarks> <remarks>
<para>
This method only copies the text up to <paremref
name="end_pos" />, it does not include the text at that position.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SetRunAttributes"> <Member MemberName="SetRunAttributes">
@ -99,12 +125,24 @@
<Parameter Name="end_offset" Type="System.Int32" /> <Parameter Name="end_offset" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the attributes for a specified range.</summary>
<param name="attrib_set">To be added: an object of type 'GLib.SList'</param> <param name="attrib_set">an <see cref="T:Atk.AttributeSet" /></param>
<param name="start_offset">To be added: an object of type 'int'</param> <param name="start_offset">start of range in which to set attributes</param>
<param name="end_offset">To be added: an object of type 'int'</param> <param name="end_offset">end of range in which to set attributes</param>
<returns>To be added: an object of type 'bool'</returns> <returns>
<remarks>To be added</remarks> <see langword="true" /> if attributes successfully set for
the specified range, otherwise <see langword="false"/>
</returns>
<remarks>
<para>
Sets the attributes for a specified range. See the
ATK_ATTRIBUTE macros (such as ATK_ATTRIBUTE_LEFT_MARGIN)
for examples of attributes that can be set. Note that
other attributes that do not have corresponding
ATK_ATTRIBUTE macros may also be set for certain text
widgets.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TextContents"> <Member MemberName="TextContents">
@ -116,10 +154,10 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Set text contents of text.</summary>
<param name="value">To be added: an object of type 'string'</param> <param name="value"> string to set for text contents of text</param>
<returns>To be added: an object of type 'string'</returns> <returns>contents of text</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InsertText"> <Member MemberName="InsertText">
@ -132,10 +170,10 @@
<Parameter Name="str1ng" Type="System.String" /> <Parameter Name="str1ng" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Insert text at a given position.</summary>
<param name="str1ng">a <see cref="T:System.String" /></param> <param name="str1ng">the text to insert</param>
<returns>a <see cref="T:System.Int32" /></returns> <returns>the position after the text has been inserted</returns>.
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

70
doc/en/Atk/Image.xml
View file

@ -10,8 +10,31 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>
<remarks>To be added</remarks> Implemented by AtkObject subtypes on behalf of components which
display image/pixmap information onscreen, and which provide
information (other than just widget borders, etc.) via that
image content.
</summary>
<remarks>
<para>
<see cref="T:Atk.Image" /> should be implemented by <see
cref="T:Atk.Object" /> subtypes on behalf
of components which display image/pixmap information onscreen,
and which provide information (other than just widget borders,
etc.) via that image content. For instance, icons, buttons
with icons, toolbar elements, and image viewing panes
typically should implement AtkImage.
</para>
<para>
<see cref="T:Atk.Image" /> primarily provides two types of information:
coordinate information (useful for screen review mode of
screenreaders, and for use by onscreen magnifiers), and
descriptive information. The descriptive information is
provided for alternative, text-only presentation of the most
significant information present in the image.
</para>
</remarks>
</Docs> </Docs>
<Base /> <Base />
<Interfaces> <Interfaces>
@ -31,10 +54,10 @@
<Parameter Name="description" Type="System.String" /> <Parameter Name="description" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Sets the textual description for this image.</summary>
<param name="description">To be added: an object of type 'string'</param> <param name="description">a description to set for image</param>
<returns>To be added: an object of type 'bool'</returns> <returns><see langword="true" />, or <see langword="false" /> if operation could not be completed.</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ImageDescription"> <Member MemberName="ImageDescription">
@ -44,9 +67,9 @@
<ReturnType>System.String</ReturnType> <ReturnType>System.String</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get a textual description of this image.</summary>
<returns>To be added: an object of type 'string'</returns> <returns>a string representing the image description</returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetImagePosition"> <Member MemberName="GetImagePosition">
@ -61,11 +84,19 @@
<Parameter Name="coord_type" Type="Atk.CoordType" /> <Parameter Name="coord_type" Type="Atk.CoordType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets the position of the image in the form of a point specifying the images top-left corner.</summary>
<param name="x">a <see cref="T:System.Int32&amp;" /></param> <param name="x">x coordinate position</param>
<param name="y">a <see cref="T:System.Int32&amp;" /></param> <param name="y">y coordinate position</param>
<param name="coord_type">a <see cref="T:Atk.CoordType" /></param> <param name="coord_type">
<remarks>To be added</remarks> specifies whether the coordinates are relative to the
screen or to the components top level window
</param>
<remarks>
<para>
The values of <paramref name="x" /> and <paramref name="y"
/>are returned as -1 if the values cannot be obtained.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetImageSize"> <Member MemberName="GetImageSize">
@ -79,10 +110,13 @@
<Parameter Name="height" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Get the width and height in pixels for the specified image.</summary>
<param name="width">a <see cref="T:System.Int32&amp;" /></param> <param name="width">the image width</param>
<param name="height">a <see cref="T:System.Int32&amp;" /></param> <param name="height">the image height</param>
<remarks>To be added</remarks> <remarks>
The values of <paramref name="width" /> and <paramref name="height" /> are returned as -1 if the values cannot be
obtained.
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>