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

Committed Widget.xml: has full documentation for methods. Properties and events are for another commit

Browse source 
WidgetFlags: Full Doc.

svn path=/trunk/gtk-sharp/; revision=12396
This commit is contained in:
Hector E. Gomez Morales 2003-03-10 01:27:13 +00:00
parent 2b4bb4b9f2
commit f73bb14661
2 changed files with 658 additions and 271 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

777
doc/en/Gtk/Widget.xml
View file

File diff suppressed because it is too large Load diff

152
doc/en/Gtk/WidgetFlags.xml
View file

@ -1,5 +1,5 @@
<Type Name="WidgetFlags" FullName="Gtk.WidgetFlags">
<TypeSignature Language="C#" Value="public sealed struct WidgetFlags;" Maintainer="auto" />
<TypeSignature Language="C#" Value="public sealed struct WidgetFlags;" Maintainer="hector Gomez M" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Tells about certain properties of the <paramref name="widget"/>.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -34,8 +34,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -46,8 +50,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -58,8 +66,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -70,8 +82,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -82,8 +98,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -94,8 +114,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -106,8 +130,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -118,8 +146,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -130,8 +162,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -142,8 +178,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -154,8 +194,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -166,8 +210,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -178,8 +226,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -190,8 +242,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -202,8 +258,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Unused since before GTK+ 1.2, will be removed in a future version.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AppPaintable">
@ -214,8 +270,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -226,8 +286,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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">
@ -238,8 +302,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<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__">
@ -250,9 +318,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>