2003-02-12 02:00:12 +00:00
<Type Name= "Dialog" FullName= "Gtk.Dialog" >
2005-05-23 20:41:51 +00:00
<TypeSignature Language= "C#" Maintainer= "Duncan Mak" Value= "public class Dialog : Gtk.Window" />
2011-11-09 16:01:51 +00:00
<TypeSignature Language= "ILAsm" Value= ".class public auto ansi beforefieldinit Dialog extends Gtk.Window" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2011-11-09 16:01:51 +00:00
<Base >
<BaseTypeName > Gtk.Window</BaseTypeName>
</Base>
<Interfaces >
</Interfaces>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-18 01:46:37 +00:00
<summary > Creates popup windows.</summary>
<remarks >
2003-07-17 06:38:40 +00:00
<para >
<see cref= "T:Gtk.Dialog" /> boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort by the user.</para>
2003-06-15 16:44:25 +00:00
<para > Gtk# treats a dialog as a window split vertically. The top section is a <see cref= "T:Gtk.VBox" /> , and is where widgets such as a <see cref= "T:Gtk.Label" /> or an <see cref= "T:Gtk.Entry" /> should be packed. The bottom area is known as the <see cref= "P:Gtk.Dialog.ActionArea" /> . This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a <see cref= "T:Gtk.HSeparator" /> .</para>
<para > The two primary areas of a dialog can be accessed as the <see cref= "P:Gtk.Dialog.Vbox" /> property and the <see cref= "P:Gtk.Dialog.ActionArea" /> property. To set the dialog to be modal, use the <see cref= "P:Gtk.Window.Modal" /> property.</para>
2003-07-17 06:38:40 +00:00
<para > If you want to block waiting for a dialog to return before returning control flow to your code, you can call <see cref= "M:Gtk.Dialog.Run" /> . This function enters a recursive main loop and waits for the user to respond to the dialog, returning the <see cref= "T:Gtk.ResponseType" /> corresponding to the <see cref= "T:Gtk.Button" /> the user clicked.</para>
<para > For a simple dialog, you would probably use <see cref= "T:Gtk.MessageDialog" /> to save yourself some effort. However, you would need to create the <see cref= "T:Gtk.Dialog" /> contents manually if you had more than a simple message in the <see cref= "T:Gtk.Dialog" /> .</para>
2003-06-16 02:44:35 +00:00
<example >
<code lang= "C#" >
using System;
using Gtk;
namespace GtkDialogSample
{
public class GtkDialogSample
{
Dialog dialog;
Window win;
static void Main()
{
new GtkDialogSample ();
}
GtkDialogSample ()
{
Application.Init ();
win = new Window ("Test");
win.SetDefaultSize (250, 250);
2008-09-12 21:41:55 +00:00
win.DeleteEvent += delegate {
Application.Quit ();
}
2003-06-16 02:44:35 +00:00
Button btn = new Button ("Show About");
2008-09-12 21:41:55 +00:00
btn.Clicked += on_btn_clicked;
2003-06-16 02:44:35 +00:00
win.Add (btn);
win.ShowAll ();
Application.Run ();
}
void on_btn_clicked (object obj, EventArgs args)
{
dialog = new Dialog
("Sample", win, Gtk.DialogFlags.DestroyWithParent);
dialog.Modal = true;
2004-06-19 18:25:02 +00:00
dialog.AddButton ("Close", ResponseType.Close);
2008-09-12 21:41:55 +00:00
dialog.Response += on_dialog_response;
2003-06-16 02:44:35 +00:00
dialog.Run ();
dialog.Destroy ();
}
void on_dialog_response (object obj, ResponseArgs args)
{
Console.WriteLine (args.ResponseId);
}
}
}
</code>
</example>
2004-11-04 19:59:38 +00:00
<para >
You also can subclass the <see cref= "T:Gtk.Dialog" /> when you want to use the same Dialog on several places in your application.
</para>
<example >
<code lang= "C#" >
using System;
using Gtk;
namespace GtkDialogSample
{
public class MyDialog:Dialog
{
public MyDialog(Window w,DialogFlags f ):base("Sample", w, f)
{
this.Modal = true;
this.AddButton ("Close", ResponseType.Close);
}
protected override void OnResponse (ResponseType response_id){
Console.WriteLine (response_id);
}
}
public class GtkDialogSample
{
MyDialog dialog;
Window win;
static void Main()
{
new GtkDialogSample ();
}
GtkDialogSample ()
{
Application.Init ();
win = new Window ("Test");
win.SetDefaultSize (250, 250);
win.DeleteEvent += new DeleteEventHandler (on_win_delete);
Button btn = new Button ("Show About");
btn.Clicked += new EventHandler (on_btn_clicked);
win.Add (btn);
win.ShowAll ();
Application.Run ();
}
void on_btn_clicked (object obj, EventArgs args)
{
dialog = new MyDialog(win, Gtk.DialogFlags.DestroyWithParent);
dialog.Run ();
dialog.Destroy ();
}
void on_win_delete (object obj, DeleteEventArgs args)
{
Application.Quit ();
}
}
}
</code>
</example>
2003-02-23 07:26:30 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
<Members >
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Dialog ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType > Constructor</MemberType>
<ReturnValue />
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Creates a new dialog box.</summary>
2003-06-15 16:44:25 +00:00
<remarks >
2011-11-09 16:01:51 +00:00
Creates a new dialog box.
This is an internal constructor, and should not be used by user code.
2003-06-15 16:44:25 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Dialog (IntPtr raw);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<param name= "raw" > Pointer to the C object.</param>
2011-11-09 16:01:51 +00:00
<summary > Internal constructor</summary>
2003-02-23 07:26:30 +00:00
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
2005-05-23 20:41:51 +00:00
<MemberSignature Language= "C#" Value= "public Dialog (string title, Gtk.Window parent, Gtk.DialogFlags flags, object[] button_data);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(string title, class Gtk.Window parent, valuetype Gtk.DialogFlags flags, object[] button_data) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "title" Type= "System.String" />
<Parameter Name= "parent" Type= "Gtk.Window" />
<Parameter Name= "flags" Type= "Gtk.DialogFlags" />
2005-05-23 20:41:51 +00:00
<Parameter Name= "button_data" Type= "System.Object[]" >
<Attributes >
<Attribute >
<AttributeName > System.ParamArray</AttributeName>
</Attribute>
</Attributes>
</Parameter>
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2005-01-28 16:03:27 +00:00
<param name= "title" > a title <see cref= "T:System.String" /> </param>
2005-04-21 17:10:54 +00:00
<param name= "parent" > a parent <see cref= "T:Gtk.Window" /> , or <see langword= "null" /> for an unparented dialog.</param>
2005-01-28 16:03:27 +00:00
<param name= "flags" > dialog characteristic such as modality and destruction policy.</param>
<param name= "button_data" > a list of button text/response pairs if desired.</param>
2011-11-09 16:01:51 +00:00
<summary > Creates a new dialog box.</summary>
2003-06-15 16:44:25 +00:00
<remarks >
2008-09-12 21:41:55 +00:00
<para > Creates a new <see cref= "T:Gtk.Dialog" /> with the specified title and parent widget.</para>
<para >
The <see cref= "T:Gtk.DialogFlags" /> argument can be used to make the dialog modal (<see cref= "F:Gtk.DialogFlags.Modal" /> )
and/or to have it destroyed along with its parent (<see cref= "F:Gtk.DialogFlags.DestroyWithParent" /> ).
</para>
<example >
<code lang= "C#" >
using System;
using Gtk;
class MainClass
{
public static void Main (string[] args)
{
Application.Init ();
// Shows two buttons that use stock icons, and a custom button
// Add button will return 1000
// Delete button will return 2000
// "My Own Butotn" will return 3000
Dialog d = new Gtk.Dialog ("What to do?", null, DialogFlags.Modal,
Stock.Add, 1000,
Stock.Delete, 2000,
"My Own Button", 3000);
int response = d.Run ();
if (response == (int) ResponseType.DeleteEvent)
Console.WriteLine ("The user closed the dialog box");
Console.WriteLine (response);
}
}
</code>
</example>
2003-06-15 16:44:25 +00:00
</remarks>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "ActionArea" >
<MemberSignature Language= "C#" Value= "public Gtk.ButtonBox ActionArea { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gtk.ButtonBox ActionArea" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.ButtonBox</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > The area of the Dialog where the action widgets are placed.</summary>
<value > a <see cref= "T:Gtk.HButtonBox" /> </value>
2004-11-04 19:59:38 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "AddActionWidget" >
<MemberSignature Language= "C#" Value= "public void AddActionWidget (Gtk.Widget child, Gtk.ResponseType response);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void AddActionWidget(class Gtk.Widget child, valuetype Gtk.ResponseType response) cil managed" />
<MemberType > Method</MemberType>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "response" Type= "Gtk.ResponseType" />
2003-12-24 01:35:30 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "child" > a <see cref= "T:Gtk.Widget" /> </param>
<param name= "response" > a <see cref= "T:Gtk.ResponseType" /> </param>
<summary > Adds an activatable widget to the <see cref= "T:Gtk.Dialog.ActionArea" /> of a <see cref= "T:Gtk.Dialog" /> .</summary>
<remarks >
Adds an activatable <see cref= "T:Gtk.Widget" /> to the <see cref= "T:Gtk.Dialog.ActionArea" /> of a <see cref= "T:Gtk.Dialog" /> , connecting a signal handler that will <see cref= "E:Gtk.Dialog.Response" /> on the <see cref= "T:Gtk.Dialog" /> when the <see cref= "T:Gtk.Widget" /> is activated.
The <see cref= "T:Gtk.Widget" /> is appended to the end of the <see cref= "T:Gtk.Dialog.ActionArea" /> . If you want to add a non-activatable <see cref= "T:Gtk.Widget" /> , simply pack it into the <see cref= "T:Gtk.Dialog.ActionArea" /> field of the <see cref= "T:Gtk.Dialog" /> .
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "AddActionWidget" >
<MemberSignature Language= "C#" Value= "public void AddActionWidget (Gtk.Widget child, int response_id);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void AddActionWidget(class Gtk.Widget child, int32 response_id) cil managed" />
<MemberType > Method</MemberType>
2003-09-17 21:56:59 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-09-17 21:56:59 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "child" Type= "Gtk.Widget" />
<Parameter Name= "response_id" Type= "System.Int32" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "child" > an object of type <see cref= "T:Gtk.Widget" /> .</param>
<param name= "response_id" > an object of type <see cref= "T:System.UInt32" /> .</param>
<summary > Adds an activatable widget to the <see cref= "T:Gtk.Dialog.ActionArea" /> of a <see cref= "T:Gtk.Dialog" /> .</summary>
2003-06-15 16:44:25 +00:00
<remarks >
2011-11-09 16:01:51 +00:00
Adds an activatable <see cref= "T:Gtk.Widget" /> to the <see cref= "T:Gtk.Dialog.ActionArea" /> of a <see cref= "T:Gtk.Dialog" /> , connecting a signal handler that will <see cref= "E:Gtk.Dialog.Response" /> on the <see cref= "T:Gtk.Dialog" /> when the <see cref= "T:Gtk.Widget" /> is activated.
The <see cref= "T:Gtk.Widget" /> is appended to the end of the <see cref= "T:Gtk.Dialog.ActionArea" /> . If you want to add a non-activatable <see cref= "T:Gtk.Widget" /> , simply pack it into the <see cref= "T:Gtk.Dialog.ActionArea" /> field of the <see cref= "T:Gtk.Dialog" /> .
</remarks>
</Docs>
</Member>
<Member MemberName= "AddButton" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget AddButton (string button_text, Gtk.ResponseType response);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance class Gtk.Widget AddButton(string button_text, valuetype Gtk.ResponseType response) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "button_text" Type= "System.String" />
<Parameter Name= "response" Type= "Gtk.ResponseType" />
</Parameters>
<Docs >
<param name= "button_text" > a <see cref= "T:System.String" /> , text for the button</param>
<param name= "response" > a <see cref= "T:Gtk.ResponseType" /> , the numeric response code emitted when the button is pressed.</param>
<summary > Adds a new response button to the dialog.</summary>
<returns > a <see cref= "T:Gtk.Widget" /> representing the button added.</returns>
<remarks />
<since version= "Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName= "AddButton" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget AddButton (string button_text, int response_id);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance class Gtk.Widget AddButton(string button_text, int32 response_id) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "button_text" Type= "System.String" />
<Parameter Name= "response_id" Type= "System.Int32" />
</Parameters>
<Docs >
<param name= "button_text" > an object of type <see cref= "T:System.String" /> .</param>
<param name= "response_id" > an object of type <see cref= "T:System.UInt32" /> .</param>
<summary > Adds a <see cref= "T:Gtk.Button" /> with the given text.</summary>
<returns > an object of type <see cref= "T:Gtk.Widget" /> </returns>
<remarks >
Adds a <see cref= "T:Gtk.Button" /> with the given text (or a stock button, if button_text is a stock ID)
and sets things up so that clicking the <see cref= "T:Gtk.Button" /> will emit a <see cref= "E:Gtk.Dialog.Response" /> with the given response_id.
The <see cref= "T:Gtk.Button" /> is appended to the end of the <see cref= "T:Gtk.Dialog.ActionArea" /> .
The <see cref= "T:Gtk.Button" /> is returned, but usually you do not need it.
</remarks>
</Docs>
</Member>
<Member MemberName= "AlternativeButtonOrder" >
<MemberSignature Language= "C#" Value= "public int[] AlternativeButtonOrder { set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32[] AlternativeButtonOrder" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > System.Int32[]</ReturnType>
</ReturnValue>
<Docs >
<summary > AlternativeButtonOrder property.</summary>
<value > An array of Response IDs.</value>
<remarks > Sets the button order to an alternative arrangement when the gtk-alternive-button-order setting is <see langword= "true" /> .</remarks>
<since version= "Gtk# 2.10" />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2003-02-12 02:00:12 +00:00
<Member MemberName= "Close" >
<MemberSignature Language= "C#" Value= "public event EventHandler Close;" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".event class System.EventHandler Close" />
2003-02-12 02:00:12 +00:00
<MemberType > Event</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > GLib.Signal("close")</AttributeName>
</Attribute>
</Attributes>
2003-09-17 21:56:59 +00:00
<ReturnValue >
<ReturnType > System.EventHandler</ReturnType>
</ReturnValue>
2003-02-12 02:00:12 +00:00
<Parameters />
<Docs >
2004-08-29 08:58:39 +00:00
<summary > Emitted when the dialog is closed.</summary>
2004-11-04 19:59:38 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "ContentArea" >
<MemberSignature Language= "C#" Value= "public Gtk.Box ContentArea { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gtk.Box ContentArea" />
2003-10-12 09:06:39 +00:00
<MemberType > Property</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.Box</ReturnType>
2003-10-12 09:06:39 +00:00
</ReturnValue>
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added.</summary>
<value > To be added.</value>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName= "DefaultResponse" >
<MemberSignature Language= "C#" Value= "public Gtk.ResponseType DefaultResponse { set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance valuetype Gtk.ResponseType DefaultResponse" />
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > Gtk.ResponseType</ReturnType>
</ReturnValue>
<Docs >
<summary > Sets the default response_id.</summary>
<value > a <see cref= "T:Gtk.ResponseType" /> </value>
<remarks > Sets the default response_id.</remarks>
</Docs>
</Member>
<Member MemberName= "GetResponseForWidget" >
<MemberSignature Language= "C#" Value= "public int GetResponseForWidget (Gtk.Widget widget);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance int32 GetResponseForWidget(class Gtk.Widget widget) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "widget" Type= "Gtk.Widget" />
</Parameters>
<Docs >
<param name= "widget" > A <see cref= "T:Gtk.Widget" /> in the action area of the dialog.</param>
<summary > Gets the response id associated with an action area Widget.</summary>
<returns > an <see cref= "T:System.Int32" /> representing the response id or <see cref= "F:Gtk.Response.None" /> if the widget has no response id set.</returns>
2004-11-04 19:59:38 +00:00
<remarks />
2011-11-09 16:01:51 +00:00
<since version= "Gtk# 2.8" />
</Docs>
</Member>
<Member MemberName= "GetWidgetForResponse" >
<MemberSignature Language= "C#" Value= "public Gtk.Widget GetWidgetForResponse (int response_id);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance class Gtk.Widget GetWidgetForResponse(int32 response_id) cil managed" />
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "response_id" Type= "System.Int32" />
</Parameters>
<Docs >
<param name= "response_id" > To be added.</param>
<summary > To be added.</summary>
<returns > To be added.</returns>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-10-12 09:06:39 +00:00
</Docs>
</Member>
2003-12-24 01:35:30 +00:00
<Member MemberName= "GType" >
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property valuetype GLib.GType GType" />
2003-12-24 01:35:30 +00:00
<MemberType > Property</MemberType>
<ReturnValue >
<ReturnType > GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-21 20:14:42 +00:00
<summary > GType Property.</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:GLib.GType" /> </value>
2004-06-21 20:14:42 +00:00
<remarks > Returns the native <see cref= "T:GLib.GType" /> value for <see cref= "T:Gtk.Dialog" /> .</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
<Member MemberName= "OnClose" >
<MemberSignature Language= "C#" Value= "protected virtual void OnClose ();" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method familyhidebysig newslot virtual instance void OnClose() cil managed" />
2003-12-24 01:35:30 +00:00
<MemberType > Method</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > GLib.DefaultSignalHandler(ConnectionMethod="OverrideClose", Type=typeof(Gtk.Dialog))</AttributeName>
</Attribute>
</Attributes>
2003-12-24 01:35:30 +00:00
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
2004-06-15 15:41:25 +00:00
<summary > Default handler for the <see cref= "M:Gtk.Dialog.Close" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Dialog.Close" /> event.</remarks>
2003-12-24 01:35:30 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "OnResponse" >
<MemberSignature Language= "C#" Value= "protected virtual void OnResponse (Gtk.ResponseType response_id);" />
<MemberSignature Language= "ILAsm" Value= ".method familyhidebysig newslot virtual instance void OnResponse(valuetype Gtk.ResponseType response_id) cil managed" />
<MemberType > Method</MemberType>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.DefaultSignalHandler(ConnectionMethod="OverrideResponse", Type=typeof(Gtk.Dialog))</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2004-01-09 01:32:46 +00:00
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "response_id" Type= "Gtk.ResponseType" />
2004-01-09 01:32:46 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "response_id" > a <see cref= "T:System.Int32" /> </param>
<summary > Default handler for the <see cref= "M:Gtk.Dialog.Response" /> event.</summary>
<remarks > Override this method in a subclass to provide a default handler for the <see cref= "M:Gtk.Dialog.Response" /> event.</remarks>
2004-01-09 01:32:46 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Respond" >
<MemberSignature Language= "C#" Value= "public void Respond (Gtk.ResponseType response);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void Respond(valuetype Gtk.ResponseType response) cil managed" />
2004-02-26 18:46:28 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2004-02-26 18:46:28 +00:00
</ReturnValue>
<Parameters >
<Parameter Name= "response" Type= "Gtk.ResponseType" />
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "response" > a <see cref= "T:System.Int32" /> , the chosen response.</param>
<summary > Activate one of the responses.</summary>
2004-11-04 19:59:38 +00:00
<remarks />
2004-02-26 18:46:28 +00:00
</Docs>
</Member>
<Member MemberName= "Respond" >
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "C#" Value= "public void Respond (int response_id);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void Respond(int32 response_id) cil managed" />
2004-02-26 18:46:28 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "response_id" Type= "System.Int32" />
2004-02-26 18:46:28 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "response_id" > an object of type <see cref= "T:System.UInt32" /> .</param>
<summary > Emits the <see cref= "E:Gtk.Dialog.Response" /> event with the given response ID.</summary>
<remarks >
Emits the <see cref= "E:Gtk.Dialog.Response" /> event with the given response ID.
Used to indicate that the user has responded to the <see cref= "T:Gtk.Dialog" /> in some way;
typically either you or <see cref= "M:Gtk.Dialog.Run()" /> will be monitoring the <see cref= "E:Gtk.Dialog.Response" /> event and take appropriate action.
</remarks>
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Response" >
<MemberSignature Language= "C#" Value= "public event Gtk.ResponseHandler Response;" />
<MemberSignature Language= "ILAsm" Value= ".event class Gtk.ResponseHandler Response" />
<MemberType > Event</MemberType>
<Attributes >
<Attribute >
<AttributeName > GLib.Signal("response")</AttributeName>
</Attribute>
</Attributes>
2004-05-27 19:02:19 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.ResponseHandler</ReturnType>
2004-05-27 19:02:19 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2004-05-27 19:02:19 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary >
Emitted when an action widget is clicked, the <see cref= "T:Gtk.Dialog" />
receives a delete event, or the application programmer calls <see cref= "M:Gtk.Dialog.Respond(System.Int32)" /> .
</summary>
<remarks >
On a delete event, the response ID is <see cref= "F:Gtk.ResponseType.None" /> .
Otherwise, it depends on which action widget was clicked.
</remarks>
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Run" >
<MemberSignature Language= "C#" Value= "public int Run ();" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance int32 Run() cil managed" />
2004-05-27 19:02:19 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Int32</ReturnType>
2004-05-27 19:02:19 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2004-05-27 19:02:19 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Waits for the <see cref= "E:Gtk.Dialog.Response" /> event or the <see cref= "T:Gtk.Dialog" /> to be destroyed.</summary>
<returns > an object of type <see cref= "T:System.UInt32" /> .</returns>
<remarks >
<para >
Waits for the <see cref= "E:Gtk.Dialog.Response" /> event or the <see cref= "T:Gtk.Dialog" /> to be destroyed.
If the <see cref= "T:Gtk.Dialog" /> is destroyed during the call to <see cref= "M:Gtk.Dialog.Run()" /> , <see cref= "T:Gtk.Dialog" /> returns <see cref= "F:Gtk.ResponseType.None" /> .
Otherwise, it returns the response ID from the <see cref= "E:Gtk.Dialog.Response" /> event.
Before entering the recursive main loop, <see cref= "M:Gtk.Dialog.Run()" /> calls <see cref= "M:Gtk.Widget.Show()" /> on the <see cref= "T:Gtk.Dialog" /> for you.
Note that you still need to show any children of the <see cref= "T:Gtk.Dialog" /> yourself.
</para>
<para >
During <see cref= "M:Gtk.Dialog.Run()" /> , the default behavior of <see cref= "E:Gtk.Window.DeleteEvent" /> is disabled;
if the <see cref= "T:Gtk.Dialog" /> receives <see cref= "E:Gtk.Window.DeleteEvent" /> , it will not be destroyed as usual, and <see cref= "M:Gtk.Dialog.Run()" /> will return <see cref= "F:Gtk.ResponseType.DeleteEvent" /> .
Also, during <see cref= "M:Gtk.Dialog.Run()" /> the <see cref= "T:Gtk.Dialog" /> will be modal.
You can force <see cref= "M:Gtk.Dialog.Run()" /> to return at any time by calling <see cref= "M:Gtk.Dialog.Respond" /> to emit the <see cref= "E:Gtk.Dialog.Response" /> event.
Destroying the <see cref= "T:Gtk.Dialog" /> during <see cref= "M:Gtk.Dialog.Run()" /> is a very bad idea, because your post-run code will not know whether the <see cref= "T:Gtk.Dialog" /> was destroyed or not.
</para>
<para >
After <see cref= "M:Gtk.Dialog.Run()" /> returns, you are responsible for hiding or destroying the <see cref= "T:Gtk.Dialog" /> if you wish to do so.
</para>
</remarks>
2004-05-27 19:02:19 +00:00
</Docs>
</Member>
2005-04-21 17:10:54 +00:00
<Member MemberName= "SetAlternativeButtonOrderFromArray" >
<MemberSignature Language= "C#" Value= "public int SetAlternativeButtonOrderFromArray (int n_params);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance int32 SetAlternativeButtonOrderFromArray(int32 n_params) cil managed" />
2005-04-21 17:10:54 +00:00
<MemberType > Method</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > System.Obsolete("Replaced by AlternativeButtonOrder property")</AttributeName>
</Attribute>
</Attributes>
2005-04-21 17:10:54 +00:00
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters >
<Parameter Name= "n_params" Type= "System.Int32" />
</Parameters>
<Docs >
<param name= "n_params" > a <see cref= "T:System.Int32" /> </param>
2011-11-09 16:01:51 +00:00
<summary > To be added</summary>
2005-04-21 17:10:54 +00:00
<returns > a <see cref= "T:System.Int32" /> </returns>
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "SetResponseSensitive" >
<MemberSignature Language= "C#" Value= "public void SetResponseSensitive (Gtk.ResponseType response_id, bool setting);" />
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void SetResponseSensitive(valuetype Gtk.ResponseType response_id, bool setting) cil managed" />
2005-12-09 23:12:49 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2005-12-09 23:12:49 +00:00
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "response_id" Type= "Gtk.ResponseType" />
<Parameter Name= "setting" Type= "System.Boolean" />
2005-12-09 23:12:49 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<param name= "response_id" > a <see cref= "T:System.Int32" /> </param>
<param name= "setting" > a <see cref= "T:System.Boolean" /> </param>
<summary > A convenient way to sensitize/desensitize dialog buttons.</summary>
<remarks > Sets <see cref= "P:Gtk.Widget.Sensitive" /> = <see langword= "true" /> for each widget in the <see cref= "P:Gtk.Dialog.ActionArea" /> with the given response_id. A convenient way to sensitize/desensitize dialog buttons.</remarks>
2007-03-01 19:10:21 +00:00
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2011-11-09 16:01:51 +00:00
</Type>