GtkSharp/doc/en/Gdk/Screen.xml
Mike Kestner 2b6efdc91c 2004-06-21 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : document GType props via script-fu. 620 TBAs killed.

svn path=/trunk/gtk-sharp/; revision=30066
2004-06-21 20:14:42 +00:00

420 lines
15 KiB
XML

<Type Name="Screen" FullName="Gdk.Screen">
<TypeSignature Language="C#" Value="public class Screen : GLib.Opaque, IWrapper" 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>Object representing a physical screen.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Screen (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 Screen, 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="Default">
<MemberSignature Language="C#" Value="public static Gdk.Screen Default { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NMonitors">
<MemberSignature Language="C#" Value="public int NMonitors { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>
<para>Returns an <see cref="T:System.Int32" /> of the number of monitors attached to the current <see cref="T:Gdk.Screen" />.</para>
<para>The following example will print the number of monitors in the current display to the console.</para>
<example>
<code lang="C#">Display theDisplay = Display.OpenDefaultLibgtkOnly();
Screen defaultScreen = theDisplay.DefaultScreen;
int numMonitors = defaultScreen.NMonitors;
Console.WriteLine("You have {0} monitors.",numMonitors);
</code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="RootWindow">
<MemberSignature Language="C#" Value="public Gdk.Window RootWindow { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Window" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public int Height { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Display">
<MemberSignature Language="C#" Value="public Gdk.Display Display { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Display</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Display" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Number">
<MemberSignature Language="C#" Value="public int Number { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SystemVisual">
<MemberSignature Language="C#" Value="public Gdk.Visual SystemVisual { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Visual" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HeightMm">
<MemberSignature Language="C#" Value="public int HeightMm { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WidthMm">
<MemberSignature Language="C#" Value="public int WidthMm { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DefaultColormap">
<MemberSignature Language="C#" Value="public Gdk.Colormap DefaultColormap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:Gdk.Colormap" /></param>
<returns>a <see cref="T:Gdk.Colormap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RgbVisual">
<MemberSignature Language="C#" Value="public Gdk.Visual RgbVisual { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Visual" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SystemColormap">
<MemberSignature Language="C#" Value="public Gdk.Colormap SystemColormap { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Colormap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RgbColormap">
<MemberSignature Language="C#" Value="public Gdk.Colormap RgbColormap { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Colormap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SizeChanged">
<MemberSignature Language="C#" Value="public event EventHandler SizeChanged;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetMonitorAtWindow">
<MemberSignature Language="C#" Value="public int GetMonitorAtWindow (Gdk.Window window);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetMonitorAtPoint">
<MemberSignature Language="C#" Value="public int GetMonitorAtPoint (int x, int y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="BroadcastClientMessage">
<MemberSignature Language="C#" Value="public void BroadcastClientMessage (Gdk.Event evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="evnt">a <see cref="T:Gdk.Event" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSetting">
<MemberSignature Language="C#" Value="public bool GetSetting (string name, GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MakeDisplayName">
<MemberSignature Language="C#" Value="public string MakeDisplayName ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</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>To be added</summary>
<remarks>To be added</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.Screen" />.</remarks>
</Docs>
</Member>
<Member MemberName="OnSizeChanged">
<MemberSignature Language="C#" Value="protected virtual void OnSizeChanged ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gdk.Screen.SizeChanged" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gdk.Screen.SizeChanged" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Screen (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ToplevelWindows">
<MemberSignature Language="C#" Value="public Gdk.Window [] ToplevelWindows { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Window[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListVisuals">
<MemberSignature Language="C#" Value="public Gdk.Visual[] ListVisuals ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Visual[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetMonitorGeometry">
<MemberSignature Language="C#" Value="public Gdk.Rectangle GetMonitorGeometry (int monitor_num);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Rectangle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="monitor_num" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="monitor_num">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Rectangle" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Screen ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Screen" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>