9727ef31e2
* gtk/Gtk.metadata : hide Object and Widget.Destroy. * gtk/Object.custom : manual virtual Destroy impl. * gtk/Widget.custom : manual virtual Destroy impl. * gtk/Window.custom : hold a managed ref for all toplevels. Release it in a Destroy override. Window is frequently subclassed and is never parented, so this keeps a managed ref around to avoid GC. [Fixes #70120] svn path=/trunk/gtk-sharp/; revision=37914
1746 lines
87 KiB
XML
1746 lines
87 KiB
XML
<Type Name="Window" FullName="Gtk.Window">
|
|
<TypeSignature Language="C#" Value="public class Window : Gtk.Bin, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Hector Gomez M" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-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>Toplevel <paramref name="widget" /> which can contain other widgets.</summary>
|
|
<remarks>Toplevel <paramref name="widget" /> which can contain other widgets.</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Bin</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>Atk.Implementor</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="BeginMoveDrag">
|
|
<MemberSignature Language="C#" Value="public void BeginMoveDrag (int button, int root_x, int root_y, uint timestamp);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="button" Type="System.Int32" />
|
|
<Parameter Name="root_x" Type="System.Int32" />
|
|
<Parameter Name="root_y" Type="System.Int32" />
|
|
<Parameter Name="timestamp" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Starts moving a <paramref name="window" />.</summary>
|
|
<param name="button">Mouse button that initiated the drag.</param>
|
|
<param name="root_x">X position where the user clicked to initiate the drag, in root window coordinates.</param>
|
|
<param name="root_y">Y position where the user clicked to initiate the drag.</param>
|
|
<param name="timestamp">Timestamp from the click event that initiated the drag.</param>
|
|
<remarks>
|
|
<para>
|
|
This method is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetFrameDimensions">
|
|
<MemberSignature Language="C#" Value="public void GetFrameDimensions (out int left, out int top, out int right, out int bottom);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="left" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="top" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="right" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="bottom" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Retrieves the dimensions of the frame window for this toplevel.</summary>
|
|
<param name="left">Location to store the width of the frame at the left, or <see langword="null" />.</param>
|
|
<param name="top">Location to store the height of the frame at the top, or <see langword="null" />.</param>
|
|
<param name="right">Location to store the width of the frame at the returns, or <see langword="null" />.</param>
|
|
<param name="bottom">Location to store the height of the frame at the bottom, or <see langword="null" />.</param>
|
|
<remarks>
|
|
<para>
|
|
It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See <see cref="M:Gdk.Window.GetFrameExtents" /> to get the standard window border extents.) See also <see cref="P:Gtk.Window.HasFrame" />, <see cref="M:Gtk.Window.SetFrameDimensions" />.
|
|
</para>
|
|
<para>
|
|
Note: this is a special-purpose method intended for the framebuffer port; see <see cref="M:Gtk.Window.SetFrameDimensions" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Iconify">
|
|
<MemberSignature Language="C#" Value="public void Iconify ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to iconify (i.e. minimize) the specified <paramref name="window" />.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the <paramref name="window" /> will end up iconified. Just do not write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Unstick">
|
|
<MemberSignature Language="C#" Value="public void Unstick ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to unstick <paramref name="window" />, which means that it will appear on only one of the user's desktops.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the <paramref name="window" /> will end up stuck. Just do not write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Unmaximize">
|
|
<MemberSignature Language="C#" Value="public void Unmaximize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to unmaximize <paramref name="window" />.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the <paramref name="window" /> will end up unmaximized. Just don't write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" /></para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetSize">
|
|
<MemberSignature Language="C#" Value="public void GetSize (out int width, out int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="width" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="height" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Obtains the current size of <paramref name="window" />.</summary>
|
|
<param name="width">Return location for width, or <see langword="null" />.</param>
|
|
<param name="height">Return location for height, or <see langword="null" />.</param>
|
|
<remarks>
|
|
<para>
|
|
If <paramref name="window" /> is not onscreen, it returns the size GTK# will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by <see cref="M:Gtk.Window.GetSize" /> is the last size received in a GdkEventConfigure, that is, GTK# uses its locally-stored size, rather than querying the X server for the size. As a result, if you call <see cref="M:Gtk.Window.Resize" /> then immediately call <see cref="M:Gtk.Window.GetSize" />, the size would not have taken effect yet. After the window manager processes the resize request, GTK# receives notification that the size has changed via a configure event, and the size of the <paramref name="window" /> gets updated.
|
|
</para>
|
|
<para>
|
|
Note 1: Nearly any use of this method creates a race condition, because the size of the <paramref name="window" /> may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to <see cref="F:Gtk.Widget.ConfigureEvent" /> on the <paramref name="window" /> and adjust your size-dependent state to match the size delivered in the GdkEventConfigure.
|
|
</para>
|
|
<para>The following example will print the height and width of a <see cref="T:Gtk.Window" /> called myWindow to the console. </para>
|
|
<example>
|
|
<code lang="C#">int height =0;
|
|
int width = 0;
|
|
myWindow.GetSize(out width , out height);
|
|
Console.WriteLine("Width: {0}, Height: {1}" , width , height);</code>
|
|
</example>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetDefaultSize">
|
|
<MemberSignature Language="C#" Value="public void GetDefaultSize (out int width, out int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="width" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="height" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets the default size of the <paramref name="window" />.</summary>
|
|
<param name="width">Location to store the default width, or <see langword="null" />.</param>
|
|
<param name="height">Location to store the default height, or <see langword="null" />.</param>
|
|
<remarks>
|
|
<para>
|
|
A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the <paramref name="window" /> will be used.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Resize">
|
|
<MemberSignature Language="C#" Value="public void Resize (int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Resizes the <paramref name="window" /> as if the user had done so, obeying geometry constraints.</summary>
|
|
<param name="width">Width in pixels to resize the <paramref name="window" /> to.</param>
|
|
<param name="height">Height in pixels to resize the <paramref name="window" /> to.</param>
|
|
<remarks>
|
|
<para>
|
|
The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call <see cref="M:Gtk.Widget.SetSizeRequest" /> to set the <paramref name="window" />'s request to a smaller value.
|
|
</para>
|
|
<para>
|
|
If <see cref="M:Gtk.Window.Resize" /> is called before showing a <paramref name="window" /> for the first time, it overrides any default size set with <see cref="M:Gtk.Window.SetDefaultSize" />. Windows may not be resized smaller than 1 by 1 pixels.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ActivateFocus">
|
|
<MemberSignature Language="C#" Value="public bool ActivateFocus ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Activates the current focused <paramref name="widget" /> within the <paramref name="window" />.</summary>
|
|
<returns>
|
|
<see langword="true" /> if a <paramref name="widget" /> got activated.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ParseGeometry">
|
|
<MemberSignature Language="C#" Value="public bool ParseGeometry (string geometry);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="geometry" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Parses a standard X Window System geometry string.</summary>
|
|
<param name="geometry">
|
|
</param>
|
|
<returns>
|
|
<see langword="true" /> if string was parsed successfully.</returns>
|
|
<remarks>
|
|
<para>
|
|
<see cref="M:Gtk.Window.ParseGeometry" /> does work on all GTK# ports including Win32 but is primarily intended for an X environment.
|
|
</para>
|
|
<para>
|
|
If either a size or a position can be extracted from the geometry string, <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" /> and calls <see cref="M:Gtk.Window.SetDefaultSize" /> and/or <see cref="M:Gtk.Window.Move" /> to resize/move the <paramref name="window" />.
|
|
</para>
|
|
<para>
|
|
If <see cref="M:Gtk.Window.ParseGeometry" /> returns <see langword="true" />, it will also set the <paramref name="F:Gdk.WindowHints.UserPos" /> and/or <see cref="F:Gdk.WindowHints.UserSize" /> hints indicating to the window manager that the size/position of the <paramref name="window" /> was user-specified. This causes most window managers to honor the geometry.
|
|
</para>
|
|
<para>
|
|
Note that for <see cref="M:Gtk.Window.ParseGeometry" /> to work as expected, it has to be called when the <paramref name="window" /> has its "final" size, i.e. after calling <see cref="M:Gtk.Widget.ShowAll" /> on the contents and <see cref="M:Gtk.Window.SetGeometryHints" /> on the <paramref name="window" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveAccelGroup">
|
|
<MemberSignature Language="C#" Value="public void RemoveAccelGroup (Gtk.AccelGroup accel_group);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Reverses the effects of <see cref="M:Gtk.Window.AddAccelGroup" />.</summary>
|
|
<param name="accel_group">A <see cref="T:Gtk.AccelGroup" />.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Stick">
|
|
<MemberSignature Language="C#" Value="public void Stick ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to stick <paramref name="window" />, which means that it will appear on all user desktops.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the <paramref name="window" /> will end up stuck. Just don't write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track stickiness via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget. It's permitted to call this method before showing a <paramref name="window" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetFrameDimensions">
|
|
<MemberSignature Language="C#" Value="public void SetFrameDimensions (int left, int top, int right, int bottom);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="left" Type="System.Int32" />
|
|
<Parameter Name="top" Type="System.Int32" />
|
|
<Parameter Name="right" Type="System.Int32" />
|
|
<Parameter Name="bottom" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>For windows with frames (see <see cref="P:Gtk.Window.HasFrame" />) this method can be used to change the size of the frame border.</summary>
|
|
<param name="left">The width of the left border.</param>
|
|
<param name="top">The height of the top border.</param>
|
|
<param name="right">The width of the right border.</param>
|
|
<param name="bottom">The height of the bottom border.</param>
|
|
<remarks>
|
|
<para>
|
|
Note: this is a special-purpose method intended for the framebuffer port; see <see cref="P:Gtk.Window.HasFrame" />. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddMnemonic">
|
|
<MemberSignature Language="C#" Value="public void AddMnemonic (uint keyval, Gtk.Widget target);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="keyval" Type="System.UInt32" />
|
|
<Parameter Name="target" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adds a mnemonic to this <paramref name="window" />.</summary>
|
|
<param name="keyval">The mnemonic.</param>
|
|
<param name="target">The <paramref name="widget" /> that gets activated by the mnemonic.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="BeginResizeDrag">
|
|
<MemberSignature Language="C#" Value="public void BeginResizeDrag (Gdk.WindowEdge edge, int button, int root_x, int root_y, uint timestamp);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="edge" Type="Gdk.WindowEdge" />
|
|
<Parameter Name="button" Type="System.Int32" />
|
|
<Parameter Name="root_x" Type="System.Int32" />
|
|
<Parameter Name="root_y" Type="System.Int32" />
|
|
<Parameter Name="timestamp" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Starts resizing a <paramref name="window" />.</summary>
|
|
<param name="edge">Position of the resize control.</param>
|
|
<param name="button">Mouse button that initiated the drag.</param>
|
|
<param name="root_x">X position where the user clicked to initiate the drag, in root window coordinates.</param>
|
|
<param name="root_y">Y position where the user clicked to initiate the drag</param>
|
|
<param name="timestamp">Timestamp from the click event that initiated the drag.</param>
|
|
<remarks>
|
|
<para>
|
|
This method is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetPosition">
|
|
<MemberSignature Language="C#" Value="public void GetPosition (out int root_x, out int root_y);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="root_x" Type="System.Int32&" RefType="out" />
|
|
<Parameter Name="root_y" Type="System.Int32&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>This method returns the position you need to pass to <see cref="M:Gtk.Window.Move" /> to keep <paramref name="window" /> in its current position.</summary>
|
|
<param name="root_x">Return location for X coordinate of gravity-determined reference point.</param>
|
|
<param name="root_y">Return location for Y coordinate of gravity-determined reference point.</param>
|
|
<remarks>
|
|
<para>
|
|
If you haven't changed the window gravity, its gravity will be <see cref="F:Gdk.Gravity.NorthWest" />. This means that <see cref="M:Gtk.Window.GetPosition" /> gets the position of the top-left corner of the window manager frame for the <paramref name="window" />. <see cref="M:Gtk.Window.Move" /> sets the position of this same top-left corner.
|
|
</para>
|
|
<para>
|
|
<see cref="M:Gtk.Window.GetPosition" /> is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a <paramref name="window" /> by the window manager. Thus GTK# is using a "best guess" that works with most window managers.
|
|
</para>
|
|
<para>
|
|
Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a <paramref name="window" /> to its current position as returned by <see cref="M:Gtk.Window.GetPostion" /> tends to result in moving the <paramref name="window" /> slightly. Window managers are slowly getting better over time.
|
|
</para>
|
|
<para>
|
|
If a <paramref name="window" /> has gravity <see cref="F.Gdk.Gravity.Static" /> the window manager frame is not relevant, and thus <see cref="M:Gtk.Window.GetPosition" /> will always produce accurate results. However you can't use static gravity to do things like place a <paramref name="window" /> in a corner of the screen, because static gravity ignores the window manager decorations.
|
|
</para>
|
|
<para>
|
|
If you are saving and restoring your application's <paramref name="window" /> positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your <paramref name="window" /> sizes and positions.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Deiconify">
|
|
<MemberSignature Language="C#" Value="public void Deiconify ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to deiconify (i.e. unminimizw) the specified <paramref name="window" />.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.
|
|
</para>
|
|
<para>
|
|
You can track iconification via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on GtkWidget.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MnemonicActivate">
|
|
<MemberSignature Language="C#" Value="public bool MnemonicActivate (uint keyval, Gdk.ModifierType modifier);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="keyval" Type="System.UInt32" />
|
|
<Parameter Name="modifier" Type="Gdk.ModifierType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Activates the targets associated with the mnemonic.</summary>
|
|
<param name="keyval">The mnemonic.</param>
|
|
<param name="modifier">The modifiers.</param>
|
|
<returns>
|
|
<see langword="true" /> if the activation is done.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ActivateDefault">
|
|
<MemberSignature Language="C#" Value="public bool ActivateDefault ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Activates the default <paramref name="widget" /> for the <paramref name="window" />.</summary>
|
|
<returns>
|
|
<see langword="true" /> if a <paramref name="widget" /> is activated.</returns>
|
|
<remarks>
|
|
<para>
|
|
That is unless the current focused <paramref name="widget" /> has been configured to receive the default (see <see cref="F:Gtk.WidgetFlags.ReceivesDefault" />) action in which case the case the focused <paramref name="widget" /> is activated.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Maximize">
|
|
<MemberSignature Language="C#" Value="public void Maximize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to maximize <paramref name="window" />, so that it becomes full-screen.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the <paramref name="window" /> will end up maximized. Just don't write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track maximization via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T.Gtk.Widget" />. It's permitted to call this method before showing a <paramref name="window" />, in which case the <paramref name="window" /> will be maximized when it appears onscreen initially.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveMnemonic">
|
|
<MemberSignature Language="C#" Value="public void RemoveMnemonic (uint keyval, Gtk.Widget target);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="keyval" Type="System.UInt32" />
|
|
<Parameter Name="target" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Removes a mnemonic from this <paramref name="window" />.</summary>
|
|
<param name="keyval">The mnemonic.</param>
|
|
<param name="target">The <paramref name="widget" /> that gets activated by the mnemonic.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddEmbeddedXid">
|
|
<MemberSignature Language="C#" Value="public void AddEmbeddedXid (uint xid);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xid" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Adds an X id number to the list of embedded windows.</summary>
|
|
<param name="xid">an object of type <see cref="T:System.UInt32" /></param>
|
|
<remarks>This is an advanced feature and is not used by typical code. The method adds the specified XID to a list of embedded windows that is maintained as object data on the Window object. This list is used for things like querying X rc settings.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetWmclass">
|
|
<MemberSignature Language="C#" Value="public void SetWmclass (string wmclass_name, string wmclass_class);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="wmclass_name" Type="System.String" />
|
|
<Parameter Name="wmclass_class" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>It sets the X Window System "class" and "name" hints for a <paramref name="window" />. (Don't use this method.)</summary>
|
|
<param name="wmclass_name">Window name hint.</param>
|
|
<param name="wmclass_class">Window class hint.</param>
|
|
<remarks>
|
|
<para>
|
|
According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK# sets them to that value by default, so calling this method is sort of pointless. However, you may want to call <see cref="P:Gtk.Window.Role" /> on each <paramref name="window" /> in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveEmbeddedXid">
|
|
<MemberSignature Language="C#" Value="public void RemoveEmbeddedXid (uint xid);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="xid" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Removes an X id number to the list of embedded windows.</summary>
|
|
<param name="xid">an object of type <see cref="T:System.UInt32" /></param>
|
|
<remarks>This is an advanced feature and is not used by typical code. The method removess the specified XID to a list of embedded windows that is maintained as object data on the Window object. This list is used for things like querying X rc settings.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetDefaultSize">
|
|
<MemberSignature Language="C#" Value="public void SetDefaultSize (int width, int height);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="width" Type="System.Int32" />
|
|
<Parameter Name="height" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the default size of an object, with the specified width and height arguments.</summary>
|
|
<param name="width">Width in pixels, or -1 to unset the default width.</param>
|
|
<param name="height">Height in pixels, or -1 to unset the default height.</param>
|
|
<remarks>
|
|
<para>
|
|
If the <paramref name="window" />'s "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the <paramref name="window" /> (<see cref="M:Gtk.Window.SetGeometryHints" /> can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
|
|
</para>
|
|
<para>
|
|
Unlike <see cref="M:Gtk.Widget.SetSizeRequest" /> which sets a size request for a <paramref name="widget" /> and thus would keep users from shrinking the <paramref name="window" />, this method only sets the initial size, just as if the user had resized the <paramref name="window" /> themselves. Users can still shrink the <paramref name="window" /> again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the <paramref name="window" />).
|
|
</para>
|
|
<para>
|
|
For more control over a <paramref name="window" />'s initial size and how resizing works, investigate <see cref="M:Gtk.Window.SetGeometryHints" />.
|
|
</para>
|
|
<para>
|
|
For some uses, <see cref="M:Gtk.Window.Resize" /> is a more appropriate method. <see cref="M:Gtk.Window.Resize" /> changes the current size of the <paramref name="window" />, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the <paramref name="window" /> itself, not the geometry widget.
|
|
</para>
|
|
<para>
|
|
The default size of a <paramref name="window" /> only affects the first time a <paramref name="window" /> is shown; if a <paramref name="window" /> is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Present">
|
|
<MemberSignature Language="C#" Value="public void Present ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Presents a <paramref name="window" /> to the user.</summary>
|
|
<remarks>
|
|
<para>
|
|
This may mean raising the <paramref name="window" /> in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences. If <paramref name="window" /> is hidden, this method calls <see cref="M:Gtk.Widget.Show" /> as well.
|
|
</para>
|
|
<para>
|
|
This method should be used when the user tries to open a <paramref name="window" /> that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use <see cref="M:Gtk.Window.Present" /> to move the already-open dialog where the user can see it.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReshowWithInitialSize">
|
|
<MemberSignature Language="C#" Value="public void ReshowWithInitialSize ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Hides <paramref name="window" />, then reshows it, resetting the default size and position of the <paramref name="window" />.</summary>
|
|
<remarks>
|
|
<para>
|
|
Used by GUI builders only.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Move">
|
|
<MemberSignature Language="C#" Value="public void Move (int x, int y);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="x" Type="System.Int32" />
|
|
<Parameter Name="y" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Asks the window manager to move <paramref name="window" /> to the given position.</summary>
|
|
<param name="x">X coordinate to move <paramref name="window" /> to.</param>
|
|
<param name="y">Y coordinate to move <paramref name="window" /> to.</param>
|
|
<remarks>
|
|
<para>
|
|
Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the <paramref name="window" /> has already been shown.
|
|
</para>
|
|
<para>
|
|
Note: the position is the position of the gravity-determined reference point for the <paramref name="window" />. The gravity determines two things: first, the location of the reference point in root <paramref name="window" /> coordinates; and second, which point on the <paramref name="window" /> is positioned at the reference point.
|
|
</para>
|
|
<para>
|
|
By default the gravity is <see cref="F:Gdk.Gravity.NorthWest" /> so the reference point is simply the x, y supplied to <see cref="M:Gtk.Window.Move" />. The top-left corner of the <paramref name="window" /> decorations (aka window frame or border) will be placed at <paramref name="x" />, <paramref name="y" />. Therefore, to position a <paramref name="window" /> at the top left of the screen, you want to use the default gravity (which is <see cref="F:Gdk.Gravity.NorthWest" />) and move the <paramref name="window" /> to 0,0.
|
|
</para>
|
|
<para>
|
|
To position a <paramref name="window" /> at the bottom right corner of the screen, you would set <see cref="F:Gdk.Gravity.SouthEast" />, which means that the reference point is at x + the <paramref name="window" /> width and y + the <paramref name="window" /> height, and the bottom-right corner of the window border will be placed at that reference point.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetPosition">
|
|
<MemberSignature Language="C#" Value="public void SetPosition (Gtk.WindowPosition position);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="position" Type="Gtk.WindowPosition" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the position constraint for a <paramref name="window" />.</summary>
|
|
<param name="position">A position constraint.</param>
|
|
<remarks>
|
|
<para>
|
|
Is is used for placing the <paramref name="window" /> in some area, depending on the <paramref name="position" /> constraint.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddAccelGroup">
|
|
<MemberSignature Language="C#" Value="public void AddAccelGroup (Gtk.AccelGroup accel_group);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Associate <paramref name="accel_group" /> with <paramref name="window" />.</summary>
|
|
<param name="accel_group">A <see cref="T:Gtk.AccelGroup" />.</param>
|
|
<remarks>
|
|
<para>
|
|
Such that calling <see cref="T:Gtk.AccelGroupActivate" /> on <paramref name="window" /> will activate accelerators in <paramref name="accel_group" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetGeometryHints">
|
|
<MemberSignature Language="C#" Value="public void SetGeometryHints (Gtk.Widget geometry_widget, Gdk.Geometry geometry, Gdk.WindowHints geom_mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="geometry_widget" Type="Gtk.Widget" />
|
|
<Parameter Name="geometry" Type="Gdk.Geometry" />
|
|
<Parameter Name="geom_mask" Type="Gdk.WindowHints" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>This method sets up hints about how a <paramref name="window" /> can be resized by the user.</summary>
|
|
<param name="geometry_widget">Widget the geometry hints will be applied to.</param>
|
|
<param name="geometry">Struct containing geometry information.</param>
|
|
<param name="geom_mask">Mask indicating which struct fields should be paid attention to.</param>
|
|
<remarks>
|
|
<para>
|
|
You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See <see cref="T:Gdk.Geometry" />.
|
|
</para>
|
|
</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 the object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Window (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 Window, 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 Window (Gtk.WindowType type);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="type" Type="Gtk.WindowType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new Window object, based on the <paramref name="type" />.</summary>
|
|
<param name="type">A <see cref="T:Gtk.WindowType" />.</param>
|
|
<returns>A <see cref="T:Gtk.Window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
Creates a new Window object, wich can be of type TopLevel ( most of the cases ) or PopUp. Take care with the use of PopUp type, since it is not controlled by the window manager.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Window (string title);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="title" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a new TopLevel Window object, with <paramref name="string" /> as the title.</summary>
|
|
<param name="title">A string.</param>
|
|
<returns>A <see cref="T:Gtk.Window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
Creates a new TopLevel Window object, using <paramref name="string" /> as the title. You get the same if you use the public Window ( Gtk.WindowType type ) constructor and later set the string Title property.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Default">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget Default { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or unsets the default <paramref name="widget" /> for a <see cref="T:Gtk.Window" /> about.</summary>
|
|
<param name="value">Widget to be the default, or <see langword="null" /> to unset the default <paramref name="widget" /> for the toplevel.</param>
|
|
<returns>A <see cref="T:Gtk.Widget" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
The default <paramref name="widget" /> is the widget that's activated when the user presses Enter in a dialog (for example). When setting (rather than unsetting) the default <paramref name="widget" /> it's generally easier to call <see cref="M:Gtk.Widget.GrabFocus" /> on the <paramref name="widget" />. Before making a default <paramref name="widget" />, you must set the <see cref="F:Gtk.WidgetFlags.CanDefault" /> flag on the <paramref name="widget" /> you'd like to make the default.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="HasFrame">
|
|
<MemberSignature Language="C#" Value="public bool HasFrame { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>If this function is called on a <paramref name="window" /> with setting of <see langword="true" />, before it is realized or showed, it will have a "frame" <paramref name="window" /> around widget->window, accessible in window->frame. Or it access the "frame" <paramref name="window" /> exterior to widget->window.</summary>
|
|
<param name="value">A <see langword="boolean" />.</param>
|
|
<returns>
|
|
<see langword="true" /> if a frame has been added to the <paramref name="window" /> via <see cref="P:Gtk.Window.HasFrame" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
Using the event <see cref="F:Gtk.WIndow.FrameEvent" /> you can receive all events targeted at the frame. This method is used by the linux-fb port to implement managed windows, but it could concievably be used by X-programs that want to do their own window decorations.
|
|
</para>
|
|
<para>
|
|
Note: This is a special-purpose method for the framebuffer port, this causes GTK# to draw its own window border. For most applications you want <see cref="P:Gtk.Window.Decorated" /> instead, which tells the window manager whether to draw the window border.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Gravity">
|
|
<MemberSignature Language="C#" Value="public Gdk.Gravity Gravity { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Gravity</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the meaning of coordinates passed to <see cref="M:Gtk.Window.Move" />.</summary>
|
|
<param name="value">A window gravity.</param>
|
|
<returns>A window gravity.</returns>
|
|
<remarks>
|
|
<para>
|
|
The default window gravity is <see cref="F:Gdk.Gravity.NorthWest" /> which is typically "do what you mean". See <see cref="M:Gtk.Window.Move" /> and <see cref="T:Gdk.Gravity" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MnemonicModifier">
|
|
<MemberSignature Language="C#" Value="public Gdk.ModifierType MnemonicModifier { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.ModifierType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the mnemonic modifier for this <paramref name="window" />.</summary>
|
|
<param name="value">The modfier mask.</param>
|
|
<returns>The modifier mask used to activate mnemonics on this <paramref name="window" />.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TypeHint">
|
|
<MemberSignature Language="C#" Value="public Gdk.WindowTypeHint TypeHint { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.WindowTypeHint</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the type hint for <paramref name="window" />.</summary>
|
|
<param name="value">The window type.</param>
|
|
<returns>The type hint for <paramref name="window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
By setting the type hint for the <paramref name="window" />, you allow the window manager to decorate and handle the <paramref name="window" /> in a way which is suitable to the function of the <paramref name="window" /> in your application. This property should be called before the <paramref name="window" /> becomes visible.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TransientFor">
|
|
<MemberSignature Language="C#" Value="public Gtk.Window TransientFor { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Window</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the transient parent window.</summary>
|
|
<param name="value">Parent <paramref name="window" />.</param>
|
|
<returns />
|
|
<remarks>
|
|
<para>
|
|
Dialog windows should be transient for the main <paramref name="window" /> they were spawned from, this allows windows managers to e.g. keep the dialog on top of the main <paramref name="window" />, or center the dialog over the main <paramref name="window" />.
|
|
</para>
|
|
<para>
|
|
On Windows(tm), this function will and put the child <paramref name="window" /> on top of the parent, much as the <paramref name="window" /> would have done in X.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Focus">
|
|
<MemberSignature Language="C#" Value="public Gtk.Widget Focus { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Widget</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets a <paramref name="widget" /> to be the focus widget for the <paramref name="window" /> if it is not the current focus widget, and its focusable, or retrieves the current focused <paramref name="widget" /> within the <paramref name="window" />.</summary>
|
|
<param name="value">
|
|
<paramref name="Widget" /> to be the new focus widget, or <see langword="null" /> to unset any focus widget for the toplevel window.</param>
|
|
<returns>The currently focused <paramref name="widget" />, or <see langword="null" /> if there is none.</returns>
|
|
<remarks>
|
|
<para>
|
|
To set the focus to a particular <paramref name="widget" /> in the toplevel, it is usually more convenient to use <see cref="M:Gtk.Widget.GrabFocus" />.
|
|
</para>
|
|
<para>
|
|
Note: when retrieving the current focused <paramref name="widget" /> is the <paramref name="widget" /> that would have the focus if the toplevel focused; if the toplevel <paramref name="window" /> is not focused then <see cref="P:Gtk.Widget.HasFocus" /> will not be <see langword="true" /> for the <paramref name="widget" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Role">
|
|
<MemberSignature Language="C#" Value="public string Role { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the role of the <paramref name="window" />.</summary>
|
|
<param name="value">Unique identifier for the <paramref name="window" /> to be used when restoring a session.</param>
|
|
<returns>The role of the <paramref name="window" /> if set, or <see langword="null" />. The returned is owned by the widget and must not be modified or freed.</returns>
|
|
<remarks>
|
|
<para>
|
|
This property is only useful on X11, not with other GTK# targets.
|
|
</para>
|
|
In combination with the <paramref name="window" /> title, the <paramref name="window" /> role allows a window manager to identify "the same" <paramref name="window" /> when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox <paramref name="window" />, so that when the user restarts their session, the session manager can put the toolbox back in the same place.
|
|
<para>
|
|
If a <paramref name="window" /> already has a unique title, you don't need to set the role, since the WM can use the title to identigy the <paramref name="window" /> when restoring the session.
|
|
</para></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Decorated">
|
|
<MemberSignature Language="C#" Value="public bool Decorated { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains whether the <paramref name="window" /> has been set to have decorations.</summary>
|
|
<param name="value">
|
|
<see langword="true" /> to decorate the <paramref name="window" />.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> has been set to have decorations.</returns>
|
|
<remarks>
|
|
<para>
|
|
With this property you control if a <paramref name="window" /> will be decorated or not.
|
|
</para>
|
|
<para>
|
|
By default, windows are decorated with a title bar and resize controls. Some window managers allow to disable these decorations, creating a borderless Window. If you set this property as false, Gtk# will try to convince the window manager not to decorate the <paramref name="window" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Resizable">
|
|
<MemberSignature Language="C#" Value="public bool Resizable { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains whether a <paramref name="window" /> will be resizable by the user or not.</summary>
|
|
<param name="value">
|
|
<see langword="true" /> if the user can resize this <paramref name="window" />.</param>
|
|
<returns>
|
|
<see langword="true" /> if the user can resize the <paramref name="window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
By default, the <paramref name="window" /> are resizable, so you can change the size of them. But if you set this property to false, the user won't be able to change the size of them.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="WindowPosition">
|
|
<MemberSignature Language="C#" Value="public Gtk.WindowPosition WindowPosition { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.WindowPosition</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting/getting the <paramref name="window" /> position.</summary>
|
|
<param name="value">A <paramref name="window" /> position. See also <see cref="T:Gtk.WindowPosition" />.</param>
|
|
<returns>The <paramref name="window" /> position. See also <see cref="T:Gtk.WindowPosition" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
This property will alow you to define where a <paramref name="window" /> must be displayed on the screen. It work with the <see cref="T:Gtk.WindowPosition" /> enum, so maybe you should check it before use it.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultHeight">
|
|
<MemberSignature Language="C#" Value="public int DefaultHeight { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting or obtaining the default height of a <paramref name="window" />.</summary>
|
|
<param name="value">A <paramref name="window" /> height.</param>
|
|
<returns>The default height of the <paramref name="window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
This property will allow you to define the default height for your <paramref name="window" />. It only define the default one, so if the <paramref name="window" /> is resized, it won't be able to do anything.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DestroyWithParent">
|
|
<MemberSignature Language="C#" Value="public bool DestroyWithParent { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains whether the transient parent of <paramref name="window" /> will also destroy <paramref name="window" /> itself</summary>
|
|
<param name="value">an object of type <see cref="T:System.Int32" /></param>
|
|
<returns>an object of type <see cref="T:System.Int32" /></returns>
|
|
<remarks>
|
|
<para>
|
|
This is useful for dialogs that shouldn't persist beyond the livefime of the main <paramref name="window" /> they're associated with, for example.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Modal">
|
|
<MemberSignature Language="C#" Value="public bool Modal { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the modal status of <paramref name="window" />.</summary>
|
|
<param name="value">Whether the <paramref name="window" /> is modal.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> is set to be modal and establishes a grab when shown.</returns>
|
|
<remarks>
|
|
<para>
|
|
Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use <see cref="P:Gtk.Window.TransientFor" /> to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.
|
|
</para>
|
|
<para>
|
|
There are two status: modal (<see langword="true" />) and non-modal (<see langword="false" />).
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AllowGrow">
|
|
<MemberSignature Language="C#" Value="public bool AllowGrow { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains if the <paramref name="window" /> can be resized to a larger size by the user.</summary>
|
|
<param name="value">If <see langword="true" /> the <paramref name="window" /> can be resized.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> can be resized.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Title">
|
|
<MemberSignature Language="C#" Value="public string Title { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting the <paramref name="window" /> title.</summary>
|
|
<param name="value">Title of the <paramref name="window" />.</param>
|
|
<returns>The title of the <paramref name="window" />, or <see langword="null" /> if none has been set explicitely. The returned string is owned by the <paramref name="widget" /> and must not be modified or freed.</returns>
|
|
<remarks>
|
|
<para>
|
|
This property will allow you to set the <paramref name="window" /> title. The title of a <paramref name="window" /> will be displayed in its title bar. Since the title bar is rendered by the window managers on X Window System, the way it appears will depend on the user preferences. This title should help the users to distinguish a <paramref name="window" /> from others opened. A good title will have the application name an the actual document, for example.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Type">
|
|
<MemberSignature Language="C#" Value="public Gtk.WindowType Type { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.WindowType</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>The type of <paramref name="window" />.</summary>
|
|
<returns>The <paramref name="window" /> type.</returns>
|
|
<remarks>
|
|
<para>
|
|
See also <see cref="T:Gtk.WindowType" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultWidth">
|
|
<MemberSignature Language="C#" Value="public int DefaultWidth { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting or obtaining the default width of a <paramref name="window" />.</summary>
|
|
<param name="value">A <paramref name="window" />.</param>
|
|
<returns>The default width of the <paramref name="window" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
This property will allow you to define the default width for <paramref name="window" />. It only define the default one, so if the <paramref name="window" /> is resized, it won't be able to do anything.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Icon">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Icon { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting the icon for a <paramref name="window" />.</summary>
|
|
<param name="value">An icon.</param>
|
|
<returns>The default icon for <paramref name="window" />.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AllowShrink">
|
|
<MemberSignature Language="C#" Value="public bool AllowShrink { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains if the <paramref name="window" /> has no mininum size.</summary>
|
|
<param name="value">If <see langword="true" /> the <paramref name="window" /> has no minimum size.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> has no minimum size.</returns>
|
|
<remarks>
|
|
<para>
|
|
Setting this to <paramref name="true" /> is 99% of the time a bad idea.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="KeysChanged">
|
|
<MemberSignature Language="C#" Value="public event EventHandler KeysChanged;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>KeysChanged event.</summary>
|
|
<remarks>This event is emited when the <see cref="T:Gtk.AccelGroup" /> or mnemonic associated with the <see cref="T:Gtk.Window" /> is changed.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MoveFocus">
|
|
<MemberSignature Language="C#" Value="public event Gtk.MoveFocusHandler MoveFocus;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.MoveFocusHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>MoveFocus event.</summary>
|
|
<remarks>This event is emited when the focus is moved from one child to another.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetFocus">
|
|
<MemberSignature Language="C#" Value="public event Gtk.SetFocusHandler SetFocus;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SetFocusHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>SetFocus event.</summary>
|
|
<remarks>This event is emited when the focused widget is set.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultActivated">
|
|
<MemberSignature Language="C#" Value="public event EventHandler DefaultActivated;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>DefaultActivated event.</summary>
|
|
<remarks>This event is emited when the keybinding for default widget activation is triggered.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FocusActivated">
|
|
<MemberSignature Language="C#" Value="public event EventHandler FocusActivated;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>FocusActivated event.</summary>
|
|
<remarks>This event is emited when the keybinding for focused widget activation is triggered.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="FrameEvent">
|
|
<MemberSignature Language="C#" Value="public event Gtk.FrameEventHandler FrameEvent;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.FrameEventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>FrameEvent event.</summary>
|
|
<remarks>This event is emited when <see cref="M:Gtk.Window.HasFrame" /> has been set to true and an event occurs on the resulting frame.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AutoStartupNotification">
|
|
<MemberSignature Language="C#" Value="public static bool AutoStartupNotification { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Property used for setting the automatic startup notification.</summary>
|
|
<param name="value">If <see langword="true" /> automatically do startup notification.</param>
|
|
<returns>
|
|
<see langword="true" /> if set to automatically do startup notification.</returns>
|
|
<remarks>
|
|
<para>
|
|
By default, after showing the first <see cref="T:Gtk.Window" /> for each <see cref="T:Gdk.Screen" />, GTK# calls <see cref="M:Gdk.Global.NotifyStartupComplete" />. Use this property to disable the automatic startup notification.
|
|
</para>
|
|
<para>
|
|
You might do this if your first <paramref name="window" /> is a splash screen, and you want to delay notification until after your real main <paramref name="window" /> has been shown, for example. In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main <paramref name="window" /> would automatically result in notification.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Screen">
|
|
<MemberSignature Language="C#" Value="public Gdk.Screen Screen { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Screen</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets or obtains the <see cref="T:Gdk.Screen" /> where the <paramref name="window" /> is displayed.</summary>
|
|
<param name="value">A <see cref="T:Gdk.Screen" />.</param>
|
|
<returns>A <see cref="T:Gdk.Screen" />.</returns>
|
|
<remarks>
|
|
<para>
|
|
If the <paramref name="window" /> is already mapped, it will be unmapped, and then remapped on the new screen.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsActive">
|
|
<MemberSignature Language="C#" Value="public bool IsActive { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Whether the toplevel is the current active <paramref name="window" />.</summary>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> is the toplevel.</returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="HasToplevelFocus">
|
|
<MemberSignature Language="C#" Value="public bool HasToplevelFocus { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>Whether the input focus is within this <paramref name="window" />.</summary>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> has the input focus.</returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SkipPagerHint">
|
|
<MemberSignature Language="C#" Value="public bool SkipPagerHint { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether the <paramref name="window" /> should not be in the pager.</summary>
|
|
<param name="value">If <see langword="true" /> then the <paramref name="window" /> will not be in the pager.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> should not be in the pager.</returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SkipTaskbarHint">
|
|
<MemberSignature Language="C#" Value="public bool SkipTaskbarHint { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Whether the <paramref name="window" /> should not be in the taskbar.</summary>
|
|
<param name="value">If <see langword="true" /> then the <paramref name="window" /> will not be in the taskbar.</param>
|
|
<returns>
|
|
<see langword="true" /> if the <paramref name="window" /> should not be in the taskbar.</returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetDefaultIconFromFile">
|
|
<MemberSignature Language="C#" Value="public static bool SetDefaultIconFromFile (string filename);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets an icon to be used as fallback for windows that haven't had <see cref="P:Gtk.Window.IconList" /> called on them from a file on disk.</summary>
|
|
<param name="filename">Location of icon file.</param>
|
|
<returns>
|
|
<see langword="true" /> if setting the icon succeded.</returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Fullscreen">
|
|
<MemberSignature Language="C#" Value="public void Fullscreen ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to place <paramref name="window" /> in the fullscreen state.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the <paramref name="window" /> will end up restored to its normal state. Just don't write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track the fullscreen state via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetIconFromFile">
|
|
<MemberSignature Language="C#" Value="public bool SetIconFromFile (string filename);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="filename" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the icon for <paramref name="window" />.</summary>
|
|
<param name="filename">Location of icon file.</param>
|
|
<returns>
|
|
<see langword="true" /> if setting the icon succeded.</returns>
|
|
<remarks>
|
|
<para>
|
|
This method is equivalent to calling <see cref="M:Gtk.Window.ParseGeometry" /> with pixbuf created by loading the image from <paramref name="filename" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Unfullscreen">
|
|
<MemberSignature Language="C#" Value="public void Unfullscreen ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Asks to toggle off the fullscreen state for <paramref name="window" />.</summary>
|
|
<remarks>
|
|
<para>
|
|
Note that you shouldn't assume the <paramref name="window" /> is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the <paramref name="window" /> will end up restored to its normal state. Just don't write code that crashes if not.
|
|
</para>
|
|
<para>
|
|
You can track the fullscreen state via the <see cref="F:Gtk.Widget.WindowStateEvent" /> event on <see cref="T:Gtk.Widget" />.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Raw">
|
|
<MemberSignature Language="C#" Value="protected override IntPtr Raw { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raw Property</summary>
|
|
<returns>a <see cref="T:System.IntPtr" /></returns>
|
|
<remarks>Returns the native object handle of this <see cref="T:Gtk.Window" />.</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 GObject type for <see cref="T:Gtk.Window" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnFrameEvent">
|
|
<MemberSignature Language="C#" Value="protected virtual bool OnFrameEvent (Gdk.Event evnt);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="evnt" Type="Gdk.Event" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.FrameEvent" /> event.</summary>
|
|
<param name="evnt">a <see cref="T:Gdk.Event" /></param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.FrameEvent" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnFocusActivated">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnFocusActivated ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.FocusActivated" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.FocusActivated" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnDefaultActivated">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnDefaultActivated ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.DefaultActivated" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.DefaultActivated" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnSetFocus">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnSetFocus (Gtk.Widget focus);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="focus" Type="Gtk.Widget" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.SetFocus" /> event.</summary>
|
|
<param name="focus">a <see cref="T:Gtk.Widget" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.SetFocus" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnMoveFocus">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnMoveFocus (Gtk.DirectionType direction);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="direction" Type="Gtk.DirectionType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.MoveFocus" /> event.</summary>
|
|
<param name="direction">a <see cref="T:Gtk.DirectionType" /></param>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.MoveFocus" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnKeysChanged">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnKeysChanged ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Window.KeysChanged" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Window.KeysChanged" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Window (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:Gtk.Window" /></returns>
|
|
<remarks>Chain to this constructor if you have manually registered a native GType for your subclass.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultIconList">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf [] DefaultIconList { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Sets or obtains the icon list to be used as fallback for windows that haven't had <see cref="M:Gtk.Window.IconList" /> called on them to set up a window-specific icon list.</summary>
|
|
<param name="value">An array of <see cref="T:Gdk.Pixbuf" />.</param>
|
|
<returns>An array of icons list.</returns>
|
|
<remarks>
|
|
<para>
|
|
This method allows you to set up the icon for all windows in your app at once.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IconList">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf [] IconList { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Sets or obtains the list of icons representing a <see cref="T:Gtk.Window" />.</summary>
|
|
<param name="value">An array of <see cref="T:Gdk.Pixbuf" />s.</param>
|
|
<returns>An array of <see cref="T:Gdk.Pixbuf[]" />s.</returns>
|
|
<remarks>
|
|
<para>
|
|
The icon is used when <paramref name="window" /> is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.
|
|
</para>
|
|
<para>
|
|
<see cref="M:Gtk.Window.IconList" /> allows you to pass the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK#. Scaling is postponed unitl the last minute, when the desired final size is known, to allow best quality. By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.
|
|
</para>
|
|
<para>
|
|
Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them).
|
|
</para>
|
|
<para>
|
|
Note that transient windows (those who have been set transient for another <paramref name="window" /> using <see cref="P:Gtk.Window.TransientFor" /> will inherit their icon from their transient parent. So there's no need to explicity set the icon on transient windows.
|
|
</para>
|
|
<para>
|
|
When retrieving the list is copied, but the reference count on each won't be incremented.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ListToplevels">
|
|
<MemberSignature Language="C#" Value="public static Gtk.Window[] ListToplevels ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Window[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Returns a list of all existing toplevel windows.</summary>
|
|
<returns>An array of toplevel widgets.</returns>
|
|
<remarks>
|
|
<para>
|
|
The widgets in the list are not individually referenced.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultSize">
|
|
<MemberSignature Language="C#" Value="public Gdk.Size DefaultSize { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Size</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Sets or obtains the default size of <paramref name="window" />.</summary>
|
|
<returns>a <see cref="T:Gdk.Size" /></returns>
|
|
<remarks>
|
|
<para>
|
|
A value of -1 for the size indicates that a default size has not been explicitly set for that dimension, so the "natural" size of the <paramref name="window" /> will be used.
|
|
</para>
|
|
<para>
|
|
If the <paramref name="window" />'s "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the <paramref name="window" /> (<see cref="M:Gtk.Window.SetGeometryHints" /> can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
|
|
</para>
|
|
<para>
|
|
Unlike <see cref="M:Gtk.Widget.SizeRequest" />, which sets a size request for a <paramref name="widget" /> and thus would keep users from shrinking the <paramref name="window" />, this method only sets the initial size, just as if the user had resized the <paramref name="window" /> themselves. Users can still shrink the <paramref name="window" /> again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the <paramref name="window" />).
|
|
</para>
|
|
<para>
|
|
For more control over a <paramref name="window" />'s initial size and how resizing works, read <see cref="M:Gtk.Window.SetGeometryHints" />.
|
|
</para>
|
|
<para>
|
|
For some uses, <see cref="M:Gtk.Window.Resize" /> is a more appropriate method. <see cref="M:Gtk.Window.Resize" /> changes the current size of the <paramref name="window" />, rather than the size to be used on initial display. <see cref="M:Gtk.Window.Resize" /> always affects the <paramref name="window" /> itself, not the geometry widget.
|
|
</para>
|
|
<para>
|
|
The default size of a <paramref name="window" /> only affects the first time a <paramref name="window" /> is shown; if a <paramref name="window" /> is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
|
|
</para>
|
|
<para>
|
|
Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 is OK, resulting in a 1x1 default size.
|
|
</para>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DefaultIcon">
|
|
<MemberSignature Language="C#" Value="public static Gdk.Pixbuf DefaultIcon { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixbuf</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:Gdk.Pixbuf" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AcceptFocus">
|
|
<MemberSignature Language="C#" Value="public bool AcceptFocus { 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="KeepBelow">
|
|
<MemberSignature Language="C#" Value="public bool KeepBelow { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="KeepAbove">
|
|
<MemberSignature Language="C#" Value="public bool KeepAbove { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ActivateKey">
|
|
<MemberSignature Language="C#" Value="public bool ActivateKey (Gdk.EventKey evnt);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="evnt" Type="Gdk.EventKey" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="evnt">a <see cref="T:Gdk.EventKey" /></param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetPolicy">
|
|
<MemberSignature Language="C#" Value="public void SetPolicy (int allow_shrink, int allow_grow, int auto_shrink);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="allow_shrink" Type="System.Int32" />
|
|
<Parameter Name="allow_grow" Type="System.Int32" />
|
|
<Parameter Name="auto_shrink" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="allow_shrink">a <see cref="T:System.Int32" /></param>
|
|
<param name="allow_grow">a <see cref="T:System.Int32" /></param>
|
|
<param name="auto_shrink">a <see cref="T:System.Int32" /></param>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PropagateKeyEvent">
|
|
<MemberSignature Language="C#" Value="public bool PropagateKeyEvent (Gdk.EventKey evnt);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="evnt" Type="Gdk.EventKey" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>To be added</summary>
|
|
<param name="evnt">a <see cref="T:Gdk.EventKey" /></param>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>To be added</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Destroy">
|
|
<MemberSignature Language="C#" Value="public override void Destroy ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Destroys a Window.</summary>
|
|
<remarks>All toplevel windows must be explicitly destroyed.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|