GtkSharp/doc/en/Gtk/Style.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

443 lines
17 KiB
XML

<Type Name="Style" FullName="Gtk.Style">
<TypeSignature Language="C#" Value="public class Style : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</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>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Foreground">
<MemberSignature Language="C#" Value="public Gdk.Color Foreground (Gtk.StateType state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Background">
<MemberSignature Language="C#" Value="public Gdk.Color Background (Gtk.StateType state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGC">
<MemberSignature Language="C#" Value="public Gdk.GC BackgroundGC (Gtk.StateType state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ForegroundGC">
<MemberSignature Language="C#" Value="public Gdk.GC ForegroundGC (Gtk.StateType state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ApplyDefaultBackground">
<MemberSignature Language="C#" Value="public void ApplyDefaultBackground (Gdk.Window window, bool set_bg, Gtk.StateType state_type, Gdk.Rectangle area, int x, int y, int width, int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="set_bg" Type="System.Boolean" />
<Parameter Name="state_type" Type="Gtk.StateType" />
<Parameter Name="area" Type="Gdk.Rectangle" />
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="set_bg">To be added: an object of type 'bool'</param>
<param name="state_type">To be added: an object of type 'Gtk.StateType'</param>
<param name="area">To be added: an object of type 'Gdk.Rectangle'</param>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<param name="width">To be added: an object of type 'int'</param>
<param name="height">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetBackground">
<MemberSignature Language="C#" Value="public void SetBackground (Gdk.Window window, Gtk.StateType state_type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="state_type" Type="Gtk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="state_type">To be added: an object of type 'Gtk.StateType'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Detach">
<MemberSignature Language="C#" Value="public void Detach ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RenderIcon">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf RenderIcon (Gtk.IconSource source, Gtk.TextDirection direction, Gtk.StateType state, Gtk.IconSize size, Gtk.Widget widget, string detail);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="Gtk.IconSource" />
<Parameter Name="direction" Type="Gtk.TextDirection" />
<Parameter Name="state" Type="Gtk.StateType" />
<Parameter Name="size" Type="Gtk.IconSize" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="detail" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="source">To be added: an object of type 'Gtk.IconSource'</param>
<param name="direction">To be added: an object of type 'Gtk.TextDirection'</param>
<param name="state">To be added: an object of type 'Gtk.StateType'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<param name="widget">To be added: an object of type 'Gtk.Widget'</param>
<param name="detail">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gtk.Style Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Style</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LookupIconSet">
<MemberSignature Language="C#" Value="public Gtk.IconSet LookupIconSet (string stock_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.IconSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Attach">
<MemberSignature Language="C#" Value="public Gtk.Style Attach (Gdk.Window window);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Style</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor" Deprecated="true">
<MemberSignature Language="C#" Value="protected Style (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Style, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Style" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Style (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of Style, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Style ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Style'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.Style</summary>
<returns>The GLib Type for the Gtk.Style class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="FontDescription">
<MemberSignature Language="C#" Value="public Pango.FontDescription FontDescription { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="YThickness">
<MemberSignature Language="C#" Value="public int YThickness { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XThickness">
<MemberSignature Language="C#" Value="public int XThickness { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Foregrounds">
<MemberSignature Language="C#" Value="public Gdk.Color[] Foregrounds { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color[]'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Backgrounds">
<MemberSignature Language="C#" Value="public Gdk.Color[] Backgrounds { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color[]'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Black">
<MemberSignature Language="C#" Value="public Gdk.Color Black { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="White">
<MemberSignature Language="C#" Value="public Gdk.Color White { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BackgroundGCs">
<MemberSignature Language="C#" Value="public Gdk.GC[] BackgroundGCs { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC[]'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ForegroundGCs">
<MemberSignature Language="C#" Value="public Gdk.GC[] ForegroundGCs { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC[]'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BlackGC">
<MemberSignature Language="C#" Value="public Gdk.GC BlackGC { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WhiteGC">
<MemberSignature Language="C#" Value="public Gdk.GC WhiteGC { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.GC</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.GC'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Style (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Style, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Style" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>