mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-23 19:45:37 +00:00
First draft of Statusbar and related docs.
svn path=/trunk/gtk-sharp/; revision=12223
This commit is contained in:
Lee Mallabone
parent
9d2b95bcc6
commit
eddfeb7c5f
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="Statusbar" FullName="Gtk.Statusbar">
|
||||
<TypeSignature Language="C#" Value="public class Statusbar : Gtk.HBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class Statusbar : Gtk.HBox, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
|
|
@ -7,8 +7,13 @@
|
|||
</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>Report messages of minor importance to the user.</summary>
|
||||
<remarks><para>The Statusbar widget displays textual messages to the user. Statusbars are typically placed at the bottom of application <see cref="T:Gtk.Window"/>s.</para>
|
||||
<para>A Statusbar may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example).</para>
|
||||
<para>As a finishing touch to the StatusBar, it can have a "resize grip" added in the lower right corner. This is a triangular area that can be clicked on to resize the window containing the statusbar.</para>
|
||||
<para>Status bars in Gtk+ maintain a stack of messages. The message at the top of the each bar's stack is the one that will currently be displayed.</para>
|
||||
<para>Any messages added to a statusbar's stack must specify a <paramref name="context_id"/> that is used to uniquely identify the source of a message. This <paramref name="context_id"/> can be generated with <see cref="M:Gtk.Statusbar.GetContextId"/>, given a message. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context identifier of a message.</para>
|
||||
<para>Messages are added to the bar's stack with <see cref="M:Gtk.Statusbar.Push"/>, and the message at the top of the stack can be removed using <see cref="M:Gtk.Statusbar.Pop"/>. A message can be removed from anywhere in the stack if it's <paramref name="message_id"/> was recorded at the time it was added. This is done using <see cref="M:Gtk.Statusbar.Remove"/>.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>Gtk.HBox</BaseTypeName>
|
||||
|
|
@ -40,11 +45,11 @@
|
|||
<Parameter Name="text" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="context_id">To be added: an object of type 'uint'</param>
|
||||
<param name="text">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Pushes a new message onto the stack.</summary>
|
||||
<param name="context_id">The new message's context ID, as generated by <see cref="M:Gtk.Statusbar.GenerateContextId"/>.</param>
|
||||
<param name="text">The message to display to the user.</param>
|
||||
<returns>The message's new message id for use with <see cref="M:Gtk.Statusbar.Remove"/>.</returns>
|
||||
<remarks><para>Note that the <paramref name="context_id"/> and the returned <paramref name="message_id"/> are equivalent and are both required for <see cref="M:Gtk.Statusbar.Remove"/> to work.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Remove">
|
||||
|
|
@ -58,10 +63,10 @@
|
|||
<Parameter Name="message_id" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="context_id">To be added: an object of type 'uint'</param>
|
||||
<param name="message_id">To be added: an object of type 'uint'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Forces the removal of a message from a statusbar's stack.</summary>
|
||||
<param name="context_id">A context identifier.</param>
|
||||
<param name="message_id">A message identifier.</param>
|
||||
<remarks><para>The exact <paramref name="context_id"/> and <paramref name="message_id"/> must be specified.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Pop">
|
||||
|
|
@ -74,9 +79,9 @@
|
|||
<Parameter Name="context_id" Type="System.UInt32" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="context_id">To be added: an object of type 'uint'</param>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Removes the message at the top of the Statusbar's stack.</summary>
|
||||
<param name="context_id">A context identifier</param>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GetContextId">
|
||||
|
|
@ -89,10 +94,10 @@
|
|||
<Parameter Name="context_description" Type="System.String" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="context_description">To be added: an object of type 'string'</param>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Generates an identifier based on the <paramref name="context_description"/>.</summary>
|
||||
<param name="context_description">A description of the message you want to generate an identifier for.</param>
|
||||
<returns>An integer identifier</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Finalize">
|
||||
|
|
@ -145,9 +150,9 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'Gtk.Statusbar'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>The main way to create a new status bar.</summary>
|
||||
<returns>A new Statusbar</returns>
|
||||
<remarks><para>Creates a new Statusbar with an empty message stack.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="GType">
|
||||
|
|
@ -172,10 +177,10 @@
|
|||
<Parameter Name="value" Type="System.Boolean" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="value">To be added: an object of type 'bool'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Manage whether this Statusbar has a resizable grip over its bottom right corner.</summary>
|
||||
<param name="value">Set to <see langword="true"/> to render a resize grip over the Statusbar, <see langword="false"/> otherwise.</param>
|
||||
<returns>Whether or not there is currently a resize grip on the Statusbar.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="TextPushed">
|
||||
|
|
@ -184,8 +189,8 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An event that is fired when a message is pushed onto the Statusbar's message stack using the <see cref="M:Gtk.Statusbar.Push"/> method.</summary>
|
||||
<remarks><para>Connect to this event with a <see cref="T:GtkSharp.TextPushedHandler"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="TextPopped">
|
||||
|
|
@ -194,8 +199,8 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>An event that is fired when a message is popped off the Statusbar's message stack using the <see cref="M:Gtk.Statusbar.Pop"/> method.</summary>
|
||||
<remarks><para>Connect to this event with a <see cref="T:GtkSharp.TextPoppedHandler"/>.</para></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="TextPoppedArgs" FullName="GtkSharp.TextPoppedArgs">
|
||||
<TypeSignature Language="C#" Value="public class TextPoppedArgs : GtkSharp.SignalArgs" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class TextPoppedArgs : GtkSharp.SignalArgs" Maintainer="Lee Mallabone" />
|
||||
<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>Passes data to handlers of <see cref="F:Gtk.Statusbar.TextPoppedHandler"/> events.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>GtkSharp.SignalArgs</BaseTypeName>
|
||||
|
|
@ -22,9 +22,9 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'GtkSharp.TextPoppedArgs'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates a new object that encapsulates the data that has been popped from a message stack.</summary>
|
||||
<returns>A new TextPoppedArgs object.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Text">
|
||||
|
|
@ -34,9 +34,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'string'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the text that was 'popped'.</summary>
|
||||
<returns>The string removed from the top of the Statusbar's message stack</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ContextId">
|
||||
|
|
@ -46,9 +46,9 @@
|
|||
<ReturnType>System.UInt32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the context identifier for the message that was removed.</summary>
|
||||
<returns>An integer context ID.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="TextPoppedHandler" FullName="GtkSharp.TextPoppedHandler">
|
||||
<TypeSignature Language="C#" Value="public sealed delegate void TextPoppedHandler (object o, GtkSharp.TextPoppedArgs args);" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public sealed delegate void TextPoppedHandler (object o, GtkSharp.TextPoppedArgs args);" Maintainer="Lee Mallabone" />
|
||||
<AssemblyInfo>
|
||||
<AssemblyName>gtk-sharp</AssemblyName>
|
||||
<AssemblyVersion>0.0.0.0</AssemblyVersion>
|
||||
|
|
@ -7,9 +7,9 @@
|
|||
</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>
|
||||
</Docs>
|
||||
<summary>An event that is fired when messages are popped from the message stack of a <see cref="T:Gtk.Statusbar"/>.</summary>
|
||||
<remarks><para>This event passes data to its handlers with the <see cref="T:GtkSharp.TextPoppedArgs"/> class.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Delegate</BaseTypeName>
|
||||
</Base>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="TextPushedArgs" FullName="GtkSharp.TextPushedArgs">
|
||||
<TypeSignature Language="C#" Value="public class TextPushedArgs : GtkSharp.SignalArgs" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public class TextPushedArgs : GtkSharp.SignalArgs" Maintainer="Lee Mallabone" />
|
||||
<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>Passes data to handlers of <see cref="F:Gtk.Statusbar.TextPushedHandler"/> events.</summary>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>GtkSharp.SignalArgs</BaseTypeName>
|
||||
|
|
@ -22,9 +22,9 @@
|
|||
<ReturnValue />
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'GtkSharp.TextPushedArgs'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Creates a new object that encapsulates the data that has been pushed onto a message stack.</summary>
|
||||
<returns>A new TextPushedArgs object.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Text">
|
||||
|
|
@ -34,9 +34,9 @@
|
|||
<ReturnType>System.String</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'string'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the text that was 'pushed'.</summary>
|
||||
<returns>The string added to the top of the Statusbar's message stack</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="ContextId">
|
||||
|
|
@ -46,9 +46,9 @@
|
|||
<ReturnType>System.UInt32</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'uint'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
<summary>Retrieve the context identifier for the message that was added.</summary>
|
||||
<returns>An integer context ID.</returns>
|
||||
<remarks></remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<Type Name="TextPushedHandler" FullName="GtkSharp.TextPushedHandler">
|
||||
<TypeSignature Language="C#" Value="public sealed delegate void TextPushedHandler (object o, GtkSharp.TextPushedArgs args);" Maintainer="auto" />
|
||||
<TypeSignature Language="C#" Value="public sealed delegate void TextPushedHandler (object o, GtkSharp.TextPushedArgs args);" Maintainer="Lee Mallabone" />
|
||||
<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>An event that is fired when messages are pushed onto the message stack of a <see cref="T:Gtk.Statusbar"/>.</summary>
|
||||
<remarks><para>This event passes data to its handlers with the <see cref="T:GtkSharp.TextPushedArgs"/> class.</para></remarks>
|
||||
</Docs>
|
||||
<Base>
|
||||
<BaseTypeName>System.Delegate</BaseTypeName>
|
||||
|
|
|
|||
Loading…
Reference in a new issue