Ryujinx-GtkSharp/doc/en/Gtk/MessageDialog.xml

178 lines
7.5 KiB
XML
Raw Normal View History

<Type Name="MessageDialog" FullName="Gtk.MessageDialog">
<TypeSignature Language="C#" Value="public class MessageDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="John Luke" />
<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>Convenient message window</summary>
<remarks>
<para>
<see cref="T:Gtk.MessageDialog" /> presents a <see cref="T:Gtk.Dialog" /> with an image representing the <see cref="T:Gtk.MessageType" /> (Error, Question, etc.) alongside some message text.
It's simply a convenience <see cref="T:Gtk.Widget" />; you could construct the equivalent of <see cref="T:Gtk.MessageDialog" /> from <see cref="T:Gtk.Dialog" /> without too much effort, but <see cref="T:Gtk.MessageDialog" /> saves typing.
</para>
<para>
The easiest way to do a modal message dialog is to use <see cref="M:Gtk.Dialog.Run()" />,
though you can also pass in the <see cref="F:Gtk.DialogFlags.Modal" /> flag, <see cref="M:Gtk.Dialog.Run()" /> automatically makes the <see cref="T:Gtk.MessageDialog" /> from <see cref="T:Gtk.Dialog" /> modal and waits for the user to respond to it.
<see cref="M:Gtk.Dialog.Run()" /> returns when any <see cref="T:Gtk.Button" /> in the <see cref="T:Gtk.Dialog" /> is clicked.
</para>
<para>A modal dialog
<example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
md.Run ();
md.Destroy ();
</code>
</example></para>
<para>A non-modal dialog
<example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
// Destroy the dialog when the user responds to it (e.g. clicks a button)
// ::add signal handler code here::
</code>
</example></para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Dialog</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="Finalize">
<MemberSignature Language="C#" Value="protected virtual 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 MessageDialog (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 <see cref="T:Gtk.MessageDialog" />, 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="protected MessageDialog ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gtk.MessageDialog" /></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 MessageDialog (Gtk.Window parent_window, Gtk.DialogFlags flags, Gtk.MessageType type, Gtk.ButtonsType bt, string msg);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="parent_window" Type="Gtk.Window" />
<Parameter Name="flags" Type="Gtk.DialogFlags" />
<Parameter Name="type" Type="Gtk.MessageType" />
<Parameter Name="bt" Type="Gtk.ButtonsType" />
<Parameter Name="msg" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates an instance of <see cref="T:Gtk.MessageDialog" /></summary>
<param name="parent_window">an object of type <see cref="T:Gtk.Window" /></param>
<param name="flags">an object of type <see cref="T:Gtk.DialogFlags" /></param>
<param name="type">an object of type <see cref="T:Gtk.MessageType" /></param>
<param name="bt">an object of type <see cref="T:Gtk.ButtonsType" /></param>
<param name="msg">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:Gtk.MessageDialog" /></returns>
<remarks>
<para>
Creates an instance of <see cref="T:Gtk.MessageDialog" /><example>
<code lang="C#">
MessageDialog md = new MessageDialog
(parent_window, Gtk.DialogFlags.DestroyWithParent,
Gtk.MessageType.Error, Gtk.ButtonsType.Close, "Error loading file");
</code>
</example></para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.MessageDialog" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.MessageDialog" /> class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="MessageType">
<MemberSignature Language="C#" Value="public Gtk.MessageType MessageType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.MessageType</ReturnType>
</ReturnValue>
<Docs>
<summary>The <see cref="T:Gtk.MessageType" /> of the <see cref="T:Gtk.Dialog" /></summary>
<returns>an object of type <see cref="T:Gtk.MessageDialog" /></returns>
<remarks>The <see cref="T:Gtk.MessageType" /> of the <see cref="T:Gtk.Dialog" /></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected MessageDialog (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of <see cref="T:Gtk.MessageDialog" />, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.MessageDialog" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>