another batch of 2.10 API documentation

svn path=/trunk/gtk-sharp/; revision=71672
This commit is contained in:
Mike Kestner 2007-01-25 16:17:39 +00:00
parent be5b4c326f
commit 6844495fce
8 changed files with 414 additions and 0 deletions

View File

@ -0,0 +1,42 @@
<Type Name="CellRendererAccelMode" FullName="Gtk.CellRendererAccelMode">
<TypeSignature Language="C#" Value="public enum CellRendererAccelMode" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName>GLib.GType(typeof(Gtk.CellRendererAccelModeGType))</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName="Other">
<MemberSignature Language="C#" Value="Other" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellRendererAccelMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Other accelerators are supported.</summary>
</Docs>
</Member>
<Member MemberName="Gtk">
<MemberSignature Language="C#" Value="Gtk" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.CellRendererAccelMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Gtk accelerators are supported.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>Cell Renderer Accelerator Mode enumeration.</summary>
<remarks />
<since version="Gtk# 2.10" />
</Docs>
</Type>

View File

@ -0,0 +1,119 @@
<Type Name="CellRendererSpin" FullName="Gtk.CellRendererSpin">
<TypeSignature Language="C#" Value="public class CellRendererSpin : Gtk.CellRendererText" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Gtk.CellRendererText</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CellRendererSpin (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<param name="gtype">Native type.</param>
<summary>Internal constuctor.</summary>
<remarks>Do not use.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellRendererSpin (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>Internal constructor.</summary>
<remarks>Typically only used by language bindings to wrap native objects.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CellRendererSpin ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Adjustment">
<MemberSignature Language="C#" Value="public Gtk.Adjustment Adjustment { set; get; };" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("adjustment")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.Adjustment</ReturnType>
</ReturnValue>
<Docs>
<summary>Adjustment data.</summary>
<value>Must be non-null for the cell to be editable.</value>
<remarks>Contains the range information for the cell.</remarks>
</Docs>
</Member>
<Member MemberName="Digits">
<MemberSignature Language="C#" Value="public uint Digits { set; get; };" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("digits")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>Number of decimal places to display.</summary>
<value>An integer between 0 and 20, default value is 0.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="ClimbRate">
<MemberSignature Language="C#" Value="public double ClimbRate { set; get; };" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("climb-rate")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Climb rate.</summary>
<value>Defaults to 0, must be greater than or equal to 0.</value>
<remarks>Provides the acceleration rate for when the button is held down.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>Native type value.</summary>
<value>A <see cref="T:GLib.GType" /> containing the native type value.</value>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>Cell renderer with Spin Button editing capability.</summary>
<remarks />
<since version="Gtk# 2.10" />
</Docs>
</Type>

57
doc/en/Gtk/LoadState.xml Normal file
View File

@ -0,0 +1,57 @@
<Type Name="LoadState" FullName="Gtk.LoadState">
<TypeSignature Language="C#" Value="public enum LoadState" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Members>
<Member MemberName="Loading">
<MemberSignature Language="C#" Value="Loading" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LoadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Loading.</summary>
</Docs>
</Member>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="Empty" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LoadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Empty.</summary>
</Docs>
</Member>
<Member MemberName="Preload">
<MemberSignature Language="C#" Value="Preload" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LoadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Preload.</summary>
</Docs>
</Member>
<Member MemberName="Finished">
<MemberSignature Language="C#" Value="Finished" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LoadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Finished.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>Load State enumeration.</summary>
<remarks />
<since version="Gtk# 2.10" />
</Docs>
</Type>

View File

@ -0,0 +1,37 @@
<Type Name="LocationMode" FullName="Gtk.LocationMode">
<TypeSignature Language="C#" Value="public enum LocationMode" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Members>
<Member MemberName="FilenameEntry">
<MemberSignature Language="C#" Value="FilenameEntry" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LocationMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Filename Entry.</summary>
</Docs>
</Member>
<Member MemberName="PathBar">
<MemberSignature Language="C#" Value="PathBar" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.LocationMode</ReturnType>
</ReturnValue>
<Docs>
<summary>Path Bar.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>Location Mode enumeration.</summary>
<remarks>This type is a semi-private type, only used in FileChooser implementations.</remarks>
<since version="Gtk# 2.10" />
</Docs>
</Type>

67
doc/en/Gtk/PageRange.xml Normal file
View File

@ -0,0 +1,67 @@
<Type Name="PageRange" FullName="Gtk.PageRange">
<TypeSignature Language="C#" Value="public struct PageRange" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public int Start;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Start page.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="End">
<MemberSignature Language="C#" Value="public int End;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>End page.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gtk.PageRange Zero;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.PageRange</ReturnType>
</ReturnValue>
<Docs>
<summary>An Empty range.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.PageRange New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.PageRange</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">A native struct pointer.</param>
<summary>Creates a managed range from a native range.</summary>
<returns>A managed structure.</returns>
<remarks>Normally only used by language bindings.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>Page range structure.</summary>
<remarks />
<since version="Gtk# 2.10" />
</Docs>
</Type>

View File

@ -0,0 +1,22 @@
<Type Name="PageSetupDoneFunc" FullName="Gtk.PageSetupDoneFunc">
<TypeSignature Language="C#" Value="public delegate void PageSetupDoneFunc(PageSetup page_setup);" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="page_setup" Type="Gtk.PageSetup" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="page_setup">The completed page setup.</param>
<summary>Page Setup Done callback delegate.</summary>
<remarks>Pass an instance of this delegate to <see cref="M:Gtk.Print.RunPageSetupDialogAsync" /> to receive notification of asynchronous page setup completion.</remarks>
<since version="Gtk# 2.10" />
</Docs>
</Type>

View File

@ -0,0 +1,23 @@
<Type Name="RecentFilterFunc" FullName="Gtk.RecentFilterFunc">
<TypeSignature Language="C#" Value="public delegate bool RecentFilterFunc(RecentFilterInfo filter_info);" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="filter_info" Type="Gtk.RecentFilterInfo" />
</Parameters>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<param name="filter_info">Filtering information.</param>
<summary>Recent Filter callback delegate.</summary>
<returns><see langword="true" /> if the file should be displayed.</returns>
<remarks>Provides custom filtering. Added via <see cref="M:Gtk.RecentFilter.AddCustom" />.</remarks>
<since version="Gtk# 2.10" />
</Docs>
</Type>

View File

@ -0,0 +1,47 @@
<Type Name="ReloadState" FullName="Gtk.ReloadState">
<TypeSignature Language="C#" Value="public enum ReloadState" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Members>
<Member MemberName="WasUnmapped">
<MemberSignature Language="C#" Value="WasUnmapped" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.ReloadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Was Unmapped.</summary>
</Docs>
</Member>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="Empty" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.ReloadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Empty.</summary>
</Docs>
</Member>
<Member MemberName="HasFolder">
<MemberSignature Language="C#" Value="HasFolder" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.ReloadState</ReturnType>
</ReturnValue>
<Docs>
<summary>Has Folder.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>Reload State enumeration.</summary>
<remarks>Do not use. This type is exposed as part of the FileChooser implementation internals.</remarks>
<since version="Gtk# 2.10" />
</Docs>
</Type>