GtkSharp/doc/en/Gtk/WidgetFlags.xml
Duncan Mak 6a0ba3d687 Update docs for Gtk.
svn path=/trunk/gtk-sharp/; revision=12567
2003-03-15 22:50:24 +00:00

326 lines
12 KiB
XML

<Type Name="WidgetFlags" FullName="Gtk.WidgetFlags">
<TypeSignature Language="C#" Value="public sealed struct WidgetFlags;" Maintainer="hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>Tells about certain properties of the <paramref name="widget" />.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IComparable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IConvertible</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IFormattable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Toplevel">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags Toplevel;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Widgets without a real parent, as there are <see cref="T:Gtk.Window" />s and <see cref="T:Gtk.Menu" />s have this flag set throughout their lifetime.</summary>
<remarks>
<para>
Toplevel widgets always contain their own <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="NoWindow">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags NoWindow;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicative for a <paramref name="widget" /> that does not provide its own <see cref="T:Gdk.Window" />.</summary>
<remarks>
<para>
Visible action (e.g. drawing) is performed on the parent's <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Realized">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags Realized;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Realize" />, unset by <see cref="M:Gtk.Widget.Unrealize" />.</summary>
<remarks>
<para>
A realized <paramref name="widget" /> has an associated <see cref="T:Gdk.Window" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Mapped">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags Mapped;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set by <see cref="M:Gtk.Widget.Map" />, unset by <see cref="M:Gtk.Widget.Map" />.</summary>
<remarks>
<para>
Only realized widgets can be mapped. It means that <see cref="M:Gdk.Window.Show" /> has been called on the widgets window(s).
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Visible">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags Visible;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.Show" />, unset by <see cref="M:Gtk.Widget.Hide" />. Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.</summary>
<remarks>
<para>
Implies that a <paramref name="widget" /> will be mapped as soon as its parent is mapped.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Sensitive">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags Sensitive;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" />. The sensitivity of a <paramref name="widget" /> determines whether it will receive certain events (e.g. button or key presses).</summary>
<remarks>
<para>
One premise for the widgets sensitivity is to have this flag set.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ParentSensitive">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags ParentSensitive;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.Sensitive" /> operations on the parents of the <paramref name="widget" />.</summary>
<remarks>
<para>
This is the second premise for the widgets sensitivity. Once it has <see cref="F:Gtk.WidgetFlags.Sensitive" /> and <see cref="F:Gtk.Widget.ParentSensitive" /> set, its state is effectively sensitive.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CanFocus">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags CanFocus;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether a <paramref name="widget" /> is able to handle focus grabs.</summary>
<remarks>
<para>
Determines whether a <paramref name="widget" /> is able to handle focus grabs.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HasFocus">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags HasFocus;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabFocus" /> for widgets that also have <see cref="F:Gtk.WidgetFlags.CanFocus" /> set.</summary>
<remarks>
<para>
The flag will be unset once another widget grabs the focus.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CanDefault">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags CanDefault;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.</summary>
<remarks>
<para>
The <paramref name="widget" /> is allowed to receive the default action via <see cref="M:Gtk.Widget.GrabDefault" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HasDefault">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags HasDefault;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> The <paramref name="widget" /> currently is receiving the default action.</summary>
<remarks>
<para>
The <paramref name="widget" /> currently is receiving the default action.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="HasGrab">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags HasGrab;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Set by <see cref="M:Gtk.Widget.GrabDefault" />gtk_grab_add(), unset by gtk_grab_remove().</summary>
<remarks>
<para>
It means that the widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="RcStyle">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags RcStyle;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates that the widgets style has been looked up through the rc mechanism.</summary>
<remarks>
<para>
It does not imply that the <paramref name="widget" /> actually had a style defined through the rc mechanism.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CompositeChild">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags CompositeChild;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Indicates that the <paramref name="widget" /> is a composite child of its parent.</summary>
<remarks>
<para>
See <see cref="M:Gtk.Widget.PushCompositeChild" />, <see cref="M:Gtk.Widget.PopCompositeChild" />.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="NoReparent">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags NoReparent;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Unused since before GTK+ 1.2, will be removed in a future version.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AppPaintable">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags AppPaintable;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.AppPaintable" />.</summary>
<remarks>
<para>
Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ReceivesDefault">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags ReceivesDefault;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.</summary>
<remarks>
<para>
The <paramref name="widget" /> when focused will receive the default action and have <see cref="F:Gtk.WidgetFlags.HasDefault" /> set even if there is a different widget set as default.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DoubleBuffered">
<MemberSignature Language="C#" Value="public static Gtk.WidgetFlags DoubleBuffered;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.WidgetFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set and unset by <see cref="P:Gtk.Widget.DoubleBuffered" />. Indicates that exposes done on the <paramref name="widget" /> should be double-buffered. </summary>
<remarks>
<para>
Indicates that exposes done on the <paramref name="widget" /> should be double-buffered.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="value__">
<MemberSignature Language="C#" Value="public int value__;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>