ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs for new 2.12 members on existing types.

Browse source 
svn path=/trunk/gtk-sharp/; revision=95091
This commit is contained in:
Mike Kestner 2008-02-06 22:53:56 +00:00
parent eff44f31b1
commit ee187f73a8
9 changed files with 243 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/en/Gdk/Display.xml
View file

@ -754,5 +754,18 @@
<since version="Gtk# 2.10" />
</Docs>
</Member>
<Member MemberName="SupportsComposite">
<MemberSignature Language="C#" Value="public bool SupportsComposite { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Indicates if Compositing is supported.</summary>
<value>If compositing is supported, <see langword="true" />, otherwise <see langword="false" />.</value>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

16
doc/en/Gdk/EventHelper.xml
View file

@ -325,5 +325,21 @@ This could be used for communicating between different applications, though the
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.EventHelper" />.</remarks>
</Docs>
</Member>
<Member MemberName="RequestMotions">
<MemberSignature Language="C#" Value="public static void RequestMotions (Gdk.EventMotion evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.EventMotion" />
</Parameters>
<Docs>
<param name="evnt">A MotionNotify event.</param>
<summary>Requests additional motion notify events.</summary>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

14
doc/en/Gdk/Keymap.xml
View file

@ -274,5 +274,19 @@
</remarks>
</Docs>
</Member>
<Member MemberName="HaveBidiLayouts">
<MemberSignature Language="C#" Value="public bool HaveBidiLayouts ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Requests Bidi layout status.</summary>
<returns>If <see langword="true" />, bi-directional layout is in use.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

14
doc/en/Gdk/Pixbuf.xml
View file

@ -1882,5 +1882,19 @@ Gdk.Pixbuf pb = new Gdk.Pixbuf(buffer, 10, 10);
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplyEmbeddedOrientation">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf ApplyEmbeddedOrientation ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Applies an embedded orientation transform.</summary>
<returns>Returns a new pixbuf, or the existing one if no transform exists.</returns>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

76
doc/en/Gdk/Spawn.xml
View file

@ -7,8 +7,8 @@
</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>
<summary>Process spawning methods</summary>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
<Base>
@ -27,11 +27,11 @@
<Parameter Name="command_line" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Spawns a process on a Screen using a commandline string.</summary>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<param name="command_line">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@ -40,8 +40,72 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Do not use.</summary>
<remarks>No instance methods exist.</remarks>
</Docs>
</Member>
<Member MemberName="OnScreen">
<MemberSignature Language="C#" Value="public static bool OnScreen (Gdk.Screen screen, string working_directory, string[] argv, string[] envp, GLib.SpawnFlags flags, GLib.SpawnChildSetupFunc child_setup, out int child_pid);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="screen" Type="Gdk.Screen" />
<Parameter Name="working_directory" Type="System.String" />
<Parameter Name="argv" Type="System.String[]" />
<Parameter Name="envp" Type="System.String[]" />
<Parameter Name="flags" Type="GLib.SpawnFlags" />
<Parameter Name="child_setup" Type="GLib.SpawnChildSetupFunc" />
<Parameter Name="child_pid" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="screen">A screen to spawn on.</param>
<param name="working_directory">The process working directory.</param>
<param name="argv">Argument list, with program at index 0.</param>
<param name="envp">List of environment variables.</param>
<param name="flags">Spawning flags.</param>
<param name="child_setup">Child setup callback.</param>
<param name="child_pid">Returns the child process id.</param>
<summary>Spawns a process on a screen using argument and environment lists.</summary>
<returns>If <see langword="true"/>, the process was spawned successfully.</returns>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="OnScreenWithPipes">
<MemberSignature Language="C#" Value="public static bool OnScreenWithPipes (Gdk.Screen screen, string working_directory, string[] argv, string[] envp, GLib.SpawnFlags flags, GLib.SpawnChildSetupFunc child_setup, out int child_pid, out int standard_input, out int standard_output, out int standard_error);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="screen" Type="Gdk.Screen" />
<Parameter Name="working_directory" Type="System.String" />
<Parameter Name="argv" Type="System.String[]" />
<Parameter Name="envp" Type="System.String[]" />
<Parameter Name="flags" Type="GLib.SpawnFlags" />
<Parameter Name="child_setup" Type="GLib.SpawnChildSetupFunc" />
<Parameter Name="child_pid" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="standard_input" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="standard_output" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="standard_error" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="screen">A screen to spawn on.</param>
<param name="working_directory">The process working directory.</param>
<param name="argv">Argument list, with program at index 0.</param>
<param name="envp">List of environment variables.</param>
<param name="flags">Spawning flags.</param>
<param name="child_setup">Child setup callback.</param>
<param name="child_pid">Returns the child process id.</param>
<param name="standard_input">Returns a stdin pipe.</param>
<param name="standard_output">Returns a stdout pipe.</param>
<param name="standard_error">Returns a stderr pipe.</param>
<summary>Spawns a process on a screen using argument and environment lists.</summary>
<returns>If <see langword="true"/>, the process was spawned successfully.</returns>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>

42
doc/en/Gdk/Threads.xml
View file

@ -88,7 +88,47 @@ static void Main (string[] args)
<Parameters />
<Docs>
<summary>The default constructor.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="AddIdle">
<MemberSignature Language="C#" Value="public static uint AddIdle (int priority, GLib.GSourceFunc function);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="priority" Type="System.Int32" />
<Parameter Name="function" Type="GLib.GSourceFunc" />
</Parameters>
<Docs>
<param name="priority">Priority value for handler.</param>
<param name="function">Idle callback.</param>
<summary>Adds an idle handler.</summary>
<returns>A source id.</returns>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="AddTimeout">
<MemberSignature Language="C#" Value="public static uint AddTimeout (int priority, uint interval, GLib.GSourceFunc function);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="priority" Type="System.Int32" />
<Parameter Name="interval" Type="System.UInt32" />
<Parameter Name="function" Type="GLib.GSourceFunc" />
</Parameters>
<Docs>
<param name="priority">Priority value for handler.</param>
<param name="interval">Timeout interval.</param>
<param name="function">Timeout callback.</param>
<summary>Adds a timeout handler.</summary>
<returns>A source id.</returns>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>

52
doc/en/Gdk/Window.xml
View file

@ -2093,5 +2093,57 @@ The color must be allocated;
<since version="Gtk# 2.10" />
</Docs>
</Member>
<Member MemberName="Beep">
<MemberSignature Language="C#" Value="public void Beep ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emits a short beep.</summary>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="Composited">
<MemberSignature Language="C#" Value="public bool Composited { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Sets Composited indicator of window.</summary>
<value>If <see langword="true"/> window is composited.</value>
<remarks>Composited windows are not automatically drawn to the screen, but are instead rendered to an offscreen buffer and an expose event is sent to the window's parent.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="Opacity">
<MemberSignature Language="C#" Value="public double Opacity { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Opacity Property.</summary>
<value>A double between 0 and 1.</value>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="StartupId">
<MemberSignature Language="C#" Value="public string StartupId { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Startup notification ID.</summary>
<value>A string.</value>
<remarks>When using Gtk, consider using <see cref="M:Gtk.Window.StartupId"/> instead.</remarks>
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

12
doc/en/Gdk/WindowAttr.xml
View file

@ -293,5 +293,17 @@
<remarks />
</Docs>
</Member>
<Member MemberName="TypeHint">
<MemberSignature Language="C#" Value="public Gdk.WindowTypeHint TypeHint;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.WindowTypeHint</ReturnType>
</ReturnValue>
<Docs>
<summary>Type Hints for the window.</summary>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>

11
doc/en/Gdk/WindowAttributesType.xml
View file

@ -127,5 +127,16 @@
</remarks>
</Docs>
</Member>
<Member MemberName="TypeHint">
<MemberSignature Language="C#" Value="TypeHint" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.WindowAttributesType</ReturnType>
</ReturnValue>
<Docs>
<summary>Honor the TypeHint field.</summary>
<since version="Gtk# 2.12" />
</Docs>
</Member>
</Members>
</Type>