GtkSharp/doc/en/Gdk/DisplayManager.xml
John Luke 70635096fa 2004-12-29 John Luke <john.luke@gmail.com>
* gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor
        * gen-gtype-ctor-docs.cs: docs for Type (GType) ctor
        * gen-finalize-docs.cs: docs Finalize methods
        * gen-gtype-docs.cs: docs GType properties, based off
        of gen-vm-docs.cs
        * en/*.xml: run these 4 tools for all the assemblies


svn path=/trunk/gtk-sharp/; revision=38159
2004-12-29 18:36:31 +00:00

163 lines
No EOL
6.5 KiB
XML

<Type Name="DisplayManager" FullName="Gdk.DisplayManager">
<TypeSignature Language="C#" Value="public class DisplayManager : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<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>The purpose of this class is to offer notification when displays appear or disappear or the default display changes.</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="Get">
<MemberSignature Language="C#" Value="public static Gdk.DisplayManager Get ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.DisplayManager</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the global DisplayManager instance.</summary>
<returns>The global <see cref="T:Gdk.DisplayManager" /> instance.</returns>
<remarks>This is the only valid way to access this class.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with this <see cref="T:Gdk.DisplayManager" /> object.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DisplayManager (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor.</summary>
<param name="raw">raw unmanaged pointer.</param>
<returns>A new <see cref="T:Gdk.DisplayManager" /></returns>
<remarks>This constructor is internal and should not be used.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultDisplay">
<MemberSignature Language="C#" Value="public Gdk.Display DefaultDisplay { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Display</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Access and modify the default display.</summary>
<param name="value">Sets the <see cref="T:Gdk.Display" /> as the default display.</param>
<returns>The default <see cref="T:Gdk.Display" />.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayOpened">
<MemberSignature Language="C#" Value="public event Gdk.DisplayOpenedHandler DisplayOpened;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Gdk.DisplayOpenedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Event emitted when a display is opened.</summary>
<remarks>None.</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>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.DisplayManager" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnDisplayOpened">
<MemberSignature Language="C#" Value="protected virtual void OnDisplayOpened (Gdk.Display display);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Gdk.DisplayManager.DisplayOpened" /> event.</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gdk.DisplayManager.DisplayOpened" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DisplayManager (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gdk.DisplayManager" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName="ListDisplays">
<MemberSignature Language="C#" Value="public Gdk.Display[] ListDisplays ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Display[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>List all currently open displays.</summary>
<returns>The currently open displays as an array of <see cref="T:Gdk.Display" />.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DisplayManager ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Do not use.</summary>
<returns>A useless <see cref="T:Gdk.DisplayManager" /></returns>
<remarks>This object is a singleton object, and should be accessed through <see cref="M:Gdk.DisplayManager.Get" /> instead of creating a new instance.</remarks>
</Docs>
</Member>
</Members>
</Type>