GtkSharp/doc/en/Gdk/Global.xml

503 lines
19 KiB
XML
Raw Normal View History

<Type Name="Global" FullName="Gdk.Global">
<TypeSignature Language="C#" Value="public class Global" 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>Global API elements for <see cref="N:Gdk" /></summary>
<remarks>Shouldn't be called explicitly if Gtk.Application.Init() is used.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="EventsPending">
<MemberSignature Language="C#" Value="public static bool EventsPending ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetPointerHooks">
<MemberSignature Language="C#" Value="public static Gdk.PointerHooks SetPointerHooks (Gdk.PointerHooks new_hooks);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.PointerHooks</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_hooks" Type="Gdk.PointerHooks" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_hooks">a <see cref="T:Gdk.PointerHooks" /></param>
<returns>a <see cref="T:Gdk.PointerHooks" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NotifyStartupComplete">
<MemberSignature Language="C#" Value="public static void NotifyStartupComplete ();" />
<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="UnicodeToKeyval">
<MemberSignature Language="C#" Value="public static uint UnicodeToKeyval (uint wc);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="wc" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="wc">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddClientMessageFilter">
<MemberSignature Language="C#" Value="public static void AddClientMessageFilter (Gdk.Atom message_type, Gdk.FilterFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message_type" Type="Gdk.Atom" />
<Parameter Name="func" Type="Gdk.FilterFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="message_type">a <see cref="T:Gdk.Atom" /></param>
<param name="func">a <see cref="T:Gdk.FilterFunc" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetLocale">
<MemberSignature Language="C#" Value="public static string SetLocale ();" />
<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="SettingGet">
<MemberSignature Language="C#" Value="public static bool SettingGet (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=".ctor">
<MemberSignature Language="C#" Value="public Global ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Defaul constructor</summary>
<returns>a <see cref="T:Gdk.Global" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DoubleClickTime">
<MemberSignature Language="C#" Value="public static uint DoubleClickTime { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Display">
<MemberSignature Language="C#" Value="public static string Display { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ShowEvents">
<MemberSignature Language="C#" Value="public static bool ShowEvents { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SmClientId">
<MemberSignature Language="C#" Value="public static string SmClientId { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DisplayArgName">
<MemberSignature Language="C#" Value="public static string DisplayArgName { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the display name specified in the command line arguments passed to Global.ParseArgs.</summary>
<returns>A <see cref="T:System.String" /> containing the name specified.</returns>
<remarks>If the name was not specified then null is returned.</remarks>
</Docs>
</Member>
<Member MemberName="ProgramClass">
<MemberSignature Language="C#" Value="public static string ProgramClass { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DefaultRootWindow">
<MemberSignature Language="C#" Value="public static Gdk.Window DefaultRootWindow { 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="FreeCompoundText">
<MemberSignature Language="C#" Value="public static byte FreeCompoundText ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Byte" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DevicesList">
<MemberSignature Language="C#" Value="public static Gdk.Device[] DevicesList ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Device[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Device[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ListVisuals">
<MemberSignature Language="C#" Value="public static 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="SupportedWindowManagerHints">
<MemberSignature Language="C#" Value="public static Gdk.Atom [] SupportedWindowManagerHints { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Atom[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Atom[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WindowManagerClientWindows">
<MemberSignature Language="C#" Value="public static Gdk.Window [] WindowManagerClientWindows { 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="NumberOfDesktops">
<MemberSignature Language="C#" Value="public static int NumberOfDesktops { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CurrentDesktop">
<MemberSignature Language="C#" Value="public static int CurrentDesktop { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ActiveWindow">
<MemberSignature Language="C#" Value="public static Gdk.Window ActiveWindow { 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="DesktopWorkareas">
<MemberSignature Language="C#" Value="public static Gdk.Rectangle [] DesktopWorkareas { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Rectangle[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Rectangle[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="InitCheck">
<MemberSignature Language="C#" Value="public static bool InitCheck (ref string [] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argv" Type="System.String[]&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Initializes the library for usage.</summary>
<param name="argv">A <see cref="T:System.String[]" /> containing the args used to initialize the library.</param>
<returns>A <see cref="T:System.Boolean" />, that is true if its able to open and set the default display, otherwise its false.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ParseArgs">
<MemberSignature Language="C#" Value="public static void ParseArgs (ref string [] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argv" Type="System.String[]&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Parses command line arguments and stores them for future usage.</summary>
<param name="argv">A <see cref="T:System.String[]" /> containing the args to parse.</param>
<remarks>Shouldn't be called explicitly if Global.InitCheck or Gtk.Application.Init or Gtk.Application.InitCheck are being used.</remarks>
</Docs>
</Member>
<Member MemberName="QueryDepths">
<MemberSignature Language="C#" Value="public static int [] QueryDepths ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Int32[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="QueryVisualTypes">
<MemberSignature Language="C#" Value="public static Gdk.VisualType[] QueryVisualTypes ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.VisualType[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.VisualType[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UseXshm">
<MemberSignature Language="C#" Value="public static bool UseXshm { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StringMeasure">
<MemberSignature Language="C#" Value="public static int StringMeasure (Gdk.Font font, string str1ng);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="font" Type="Gdk.Font" />
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="font">a <see cref="T:Gdk.Font" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StringHeight">
<MemberSignature Language="C#" Value="public static int StringHeight (Gdk.Font font, string str1ng);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="font" Type="Gdk.Font" />
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="font">a <see cref="T:Gdk.Font" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StringExtents">
<MemberSignature Language="C#" Value="public static void StringExtents (Gdk.Font font, string str1ng, out int lbearing, out int rbearing, out int width, out int ascent, out int descent);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="font" Type="Gdk.Font" />
<Parameter Name="str1ng" Type="System.String" />
<Parameter Name="lbearing" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="rbearing" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="ascent" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="descent" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="font">a <see cref="T:Gdk.Font" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<param name="lbearing">a <see cref="T:System.Int32" /></param>
<param name="rbearing">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="ascent">a <see cref="T:System.Int32" /></param>
<param name="descent">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StringWidth">
<MemberSignature Language="C#" Value="public static int StringWidth (Gdk.Font font, string str1ng);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="font" Type="Gdk.Font" />
<Parameter Name="str1ng" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="font">a <see cref="T:Gdk.Font" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>