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

2005-01-04 Shane Landrum <epicene@pobox.com>

Browse source 
* en/Gtk/Image.xml
	* en/Gtk/RetrieveSurroundingArgs.xml
	* en/Gtk/IMMulticontext.xml
	* en/Gtk/FileInfo.xml
	* en/Gtk/FileInfoType.xml
	* en/Gtk/IMStatusStyle.xml
	* en/Gtk/RetrieveSurroundingHandler.xml
	* en/Gtk/IMPreeditStyle.xml: Added docs.


svn path=/trunk/gtk-sharp/; revision=38328
This commit is contained in:
Shane Landrum 2005-01-04 21:05:14 +00:00
parent ba10591590
commit 59a94673b6
10 changed files with 135 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/ChangeLog
View file

@ -1,3 +1,14 @@
2005-01-04 Shane Landrum <epicene@pobox.com>
* en/Gtk/Image.xml
* en/Gtk/RetrieveSurroundingArgs.xml
* en/Gtk/IMMulticontext.xml
* en/Gtk/FileInfo.xml
* en/Gtk/FileInfoType.xml
* en/Gtk/IMStatusStyle.xml
* en/Gtk/RetrieveSurroundingHandler.xml
* en/Gtk/IMPreeditStyle.xml: Added docs.
2005-01-03 Shane Landrum <epicene@pobox.com> 2005-01-03 Shane Landrum <epicene@pobox.com>
* en/Gtk/IMContextSimple.xml * en/Gtk/IMContextSimple.xml

48
doc/en/Gtk/FileInfo.xml
View file

@ -9,8 +9,12 @@
</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></remarks> A class for handling information about files.
</summary>
<remarks>
For use with <see cref="T:Gtk.FileSystem"/> classes.
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>GLib.Opaque</BaseTypeName> <BaseTypeName>GLib.Opaque</BaseTypeName>
@ -30,8 +34,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Frees memory associated with this data structure.</summary>
<remarks></remarks> <remarks>Subject to change in the future.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Copy"> <Member MemberName="Copy">
@ -42,7 +46,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns a new object that's a copy of this object.</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns> <returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -55,8 +59,8 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor for internal use only.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">a <see cref="T:System.IntPtr" />, the underlying C object.</param>
<returns>a <see cref="T:Gtk.FileInfo" /></returns> <returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -67,7 +71,7 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Public constructor.</summary>
<returns>a <see cref="T:Gtk.FileInfo" /></returns> <returns>a <see cref="T:Gtk.FileInfo" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -80,7 +84,8 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>When making a derived class, override this method to change
that class's <see cref="T:GLib.GType" />.</summary>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -93,7 +98,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file's name.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -106,7 +111,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file's MIME type.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -119,7 +124,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file's last-modified time.</summary>
<returns>a <see cref="T:System.Int64" /></returns> <returns>a <see cref="T:System.Int64" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -132,7 +137,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>The file's size.</summary>
<returns>a <see cref="T:System.Int64" /></returns> <returns>a <see cref="T:System.Int64" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -145,7 +150,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether the file is hidden or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
@ -158,9 +163,16 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Generates a collation key on the display name for faster sorting.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" />,
<remarks></remarks> the collate key for the display name, or <see langword="null"/>
if the display name hasn't been set.</returns>
<remarks>
The collate key is a string that can be usefully compared with
others using the C method strcmp().
This is useful when sorting a bunch of <see cref="T:Gtk.FileInfo"/>
objects since the collate key will be only computed once.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IsFolder"> <Member MemberName="IsFolder">
@ -171,7 +183,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether the file is actually a folder or not.</summary>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>

22
doc/en/Gtk/FileInfoType.xml
View file

@ -9,8 +9,12 @@
</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>Enumeration to represent information about a file.</summary> <summary>
<remarks></remarks> Mask of information about a file for use with
<see cref="M:Gtk.FileSystem.GetFolder"/>.
</summary>
<remarks>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Enum</BaseTypeName> <BaseTypeName>System.Enum</BaseTypeName>
@ -41,7 +45,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A file's display name.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -54,7 +58,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether a file is actually a folder.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -67,7 +71,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Whether a file is hidden.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -80,7 +84,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A file's MIME type.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -93,7 +97,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A file's modification time.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -106,7 +110,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A file's size.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
@ -119,7 +123,7 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>All the information about a file.</summary>
<remarks></remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>

57
doc/en/Gtk/IMContext.xml
View file

@ -240,7 +240,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when pre-editing is started.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -252,7 +252,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when the input method needs to delete the context text.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -276,7 +276,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>
Event fired when the input method requires the context surrounding the cursor.
</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -288,7 +290,7 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Event fired when pre-editing is completed.</summary>
<remarks /> <remarks />
</Docs> </Docs>
</Member> </Member>
@ -303,10 +305,16 @@
<Parameter Name="cursor_index" Type="System.Int32" /> <Parameter Name="cursor_index" Type="System.Int32" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Sets surrounding context around the insertion point and preedit string.
</summary>
<param name="text">a <see cref="T:System.String" /></param> <param name="text">a <see cref="T:System.String" /></param>
<param name="cursor_index">a <see cref="T:System.Int32" /></param> <param name="cursor_index">a <see cref="T:System.Int32" /></param>
<remarks /> <remarks>
This function is expected to be called in response to the
<see cref="E:Gtk.IMContext.RetrieveSurrounding"/> event,
and it will likely have no effect if called at other times.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetSurrounding"> <Member MemberName="GetSurrounding">
@ -324,7 +332,26 @@
<param name="text">a <see cref="T:System.String" /></param> <param name="text">a <see cref="T:System.String" /></param>
<param name="cursor_index">a <see cref="T:System.Int32" /></param> <param name="cursor_index">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks /> <remarks>
<para>
Input methods typically want context in order to constrain
input text based on existing text; this is important for
languages such as Thai where only some sequences of
characters are allowed.
</para>
<para>
This function is implemented by emitting the <see
cref="E:Gtk.IMContext.RetrieveSurrounding"/> event on the
input method; in response to this signal, a widget should
provide as much context as is available, up to an entire
paragraph, by calling <see
cref="M:Gtk.IMContext.SetSurrounding"/>. Note that there
is no obligation for a widget to respond to the <see
cref="E:Gtk.IMContext.RetrieveSurrounding"/> signal, so
input methods must be prepared to function without
context.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -448,11 +475,17 @@
<Parameter Name="cursor_pos" Type="System.Int32&amp;" RefType="out" /> <Parameter Name="cursor_pos" Type="System.Int32&amp;" RefType="out" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<param name="str">a <see cref="T:System.String" /></param> Retrieve the current preedit string for the input context
<param name="attrs">a <see cref="T:Pango.AttrList" /></param> and a list of attributes to apply to the string.
<param name="cursor_pos">a <see cref="T:System.Int32" /></param> </summary>
<remarks>To be added</remarks> <param name="str">a <see cref="T:System.String" />, a location to store , the retrieved string.</param>
<param name="attrs">a <see cref="T:Pango.AttrList" />, location to store the retrieved attribute list.</param>
<returns>a <see cref="T:System.Int32" />, the position of the cursor (in bytes) within the preedit string.</returns>
<remarks>
This string should be displayed inserted at the insertion
point.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">

6
doc/en/Gtk/IMMulticontext.xml
View file

@ -10,7 +10,9 @@
</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>
An input method context object that manages the use of multiple input method contexts for a widget
</summary>
<remarks /> <remarks />
</Docs> </Docs>
<Base> <Base>
@ -36,7 +38,7 @@
<Parameter Name="menushell" Type="Gtk.MenuShell" /> <Parameter Name="menushell" Type="Gtk.MenuShell" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Add menuitems for various available input methods to a menu; <summary>Add menu items for various available input methods to a menu;
the menuitems, when selected, will switch the input method the menuitems, when selected, will switch the input method
for the context and the global default input method.</summary> for the context and the global default input method.</summary>
<param name="menushell">a <see cref="T:Gtk.MenuShell" /></param> <param name="menushell">a <see cref="T:Gtk.MenuShell" /></param>

2
doc/en/Gtk/IMPreeditStyle.xml
View file

@ -80,7 +80,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

2
doc/en/Gtk/IMStatusStyle.xml
View file

@ -80,7 +80,7 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>To be added</summary>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

29
doc/en/Gtk/Image.xml
View file

@ -174,7 +174,8 @@
<summary>This constructor is used to create an instance of <see cref="Gtk.Image" /> containing the <see cref="T:Gdk.PixbufAnimation" /> passed to it.</summary> <summary>This constructor is used to create an instance of <see cref="Gtk.Image" /> containing the <see cref="T:Gdk.PixbufAnimation" /> passed to it.</summary>
<param name="animation"> <param name="animation">
<see cref="T:Gdk.PixbufAnimation" /> <see cref="T:Gdk.PixbufAnimation" />
to be displayed by the Image.</param> to be displayed by the Image.
</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns> <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks /> <remarks />
</Docs> </Docs>
@ -443,9 +444,11 @@ masked by the given <see cref="Gdk.Pixmap" />.</summary>
<ReturnType>Gtk.ImageType</ReturnType> <ReturnType>Gtk.ImageType</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>The type of representation being used by the #GtkImage <summary>The type of representation being used by the
<see cref="T:Gtk.Image"/>
to store image data. If the Image has no image data, to store image data. If the Image has no image data,
the return value will be <see cref="P:Gtk.ImageType.Empty" />.</summary> the return value will be <see cref="P:Gtk.ImageType.Empty" />.
</summary>
<returns>an object of type <see cref="T:Gtk.ImageType" /></returns> <returns>an object of type <see cref="T:Gtk.ImageType" /></returns>
<remarks /> <remarks />
</Docs> </Docs>
@ -577,10 +580,10 @@ masked by the given <see cref="Gdk.Pixmap" />.</summary>
<Parameter Name="mask" Type="Gdk.Pixmap" /> <Parameter Name="mask" Type="Gdk.Pixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Same functionality as <see cref="M:Gtk.Image.SetFromImage"/>.</summary>
<param name="val">a <see cref="T:Gdk.Image" /></param> <param name="val">a <see cref="T:Gdk.Image" /></param>
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param> <param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
<remarks>To be added</remarks> <remarks></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Get"> <Member MemberName="Get">
@ -594,10 +597,18 @@ masked by the given <see cref="Gdk.Pixmap" />.</summary>
<Parameter Name="mask" Type="Gdk.Pixmap" /> <Parameter Name="mask" Type="Gdk.Pixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
Gets the <see cref="T:Gdk.Image"/> and mask being
displayed by the <see cref="T:Gtk.Image"/>.
</summary>
<param name="val">a <see cref="T:Gdk.Image" /></param> <param name="val">a <see cref="T:Gdk.Image" /></param>
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param> <param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
<remarks>To be added</remarks> <remarks>
The storage type of the image must be
<see cref="T:Gtk.ImageType.Empty"/>.
or <see cref="T:Gtk.ImageType.Image"/>.
(see <see cref="P:Gtk.Image.StorageType" />).
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetStock"> <Member MemberName="GetStock">
@ -614,7 +625,9 @@ masked by the given <see cref="Gdk.Pixmap" />.</summary>
<summary>Get the stock item name and size, if this is a stock image</summary> <summary>Get the stock item name and size, if this is a stock image</summary>
<param name="stock_id">the stock item name</param> <param name="stock_id">the stock item name</param>
<param name="size">the stock item size, a <see cref="T:Gtk.IconSize" /></param> <param name="size">the stock item size, a <see cref="T:Gtk.IconSize" /></param>
<remarks>If the <see cref="T:Gtk.Image" /> is displaying a stock image, this method can be used to retrieve the stock item name and the size.</remarks> <remarks>
If the <see cref="T:Gtk.Image" /> is displaying a stock image, this method can be used to retrieve the stock item name and the size.
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GetIconSet"> <Member MemberName="GetIconSet">

4
doc/en/Gtk/RetrieveSurroundingHandler.xml
View file

@ -12,6 +12,10 @@
<para>The <see cref="M:Gtk.IMContext.RetrieveSurrounding" /> event utilizes this delegate:</para> <para>The <see cref="M:Gtk.IMContext.RetrieveSurrounding" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.RetrieveSurroundingArgs" /> parameter.</para> <para>Event data is passed via the <see cref="T:Gtk.RetrieveSurroundingArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.RetrieveSurroundingHandler" /> to an event, add the RetrieveSurroundingHandler instance to the event. The methods referenced by the RetrieveSurroundingHandler instance are invoked whenever the event is raised, until the RetrieveSurroundingHandler is removed from the event.</para> <para>To attach a <see cref="T:Gtk.RetrieveSurroundingHandler" /> to an event, add the RetrieveSurroundingHandler instance to the event. The methods referenced by the RetrieveSurroundingHandler instance are invoked whenever the event is raised, until the RetrieveSurroundingHandler is removed from the event.</para>
<para>
Handlers of this class should set the input method surrounding context by calling <see cref="T:Gtk.IMContext.SetSurrounding" />. The method returns %TRUE if the signal was handled by the callback.
</para>
</remarks> </remarks>
</Docs> </Docs>
<Base> <Base>