gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/Dialog.xml

<Type Name="Dialog" FullName="Terminal.Gui.Dialog">
  <TypeSignature Language="C#" Value="public class Dialog : Terminal.Gui.Window" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Dialog extends Terminal.Gui.Window" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Terminal.Gui.Window</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The dialog box is a window that by default is centered and contains one 
            or more buttons.  It defaults to the Colors.Dialog color scheme and has a
             1 cell padding around the edges.
            </summary>
    <remarks>
             To run the dialog modally, create the Dialog, and pass this to Application.Run which
            will execute the dialog until it terminates via the [ESC] key, or when one of the views
            or buttons added to the dialog set the Running property on the Dialog to false.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Dialog (NStack.ustring title, int width, int height, Terminal.Gui.Button[] buttons);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class NStack.ustring title, int32 width, int32 height, class Terminal.Gui.Button[] buttons) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="title" Type="NStack.ustring" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="buttons" Type="Terminal.Gui.Button[]">
          <Attributes>
            <Attribute>
              <AttributeName>System.ParamArray</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="title">Title for the dialog.</param>
        <param name="width">Width for the dialog.</param>
        <param name="height">Height for the dialog.</param>
        <param name="buttons">Optional buttons to lay out at the bottom of the dialog.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Terminal.Gui.Dialog" /> class with an optional set of buttons to display
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddButton">
      <MemberSignature Language="C#" Value="public void AddButton (Terminal.Gui.Button button);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddButton(class Terminal.Gui.Button button) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="button" Type="Terminal.Gui.Button" />
      </Parameters>
      <Docs>
        <param name="button">Button to add.</param>
        <summary>
            Adds a button to the dialog, its layout will be controled by the dialog
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LayoutSubviews">
      <MemberSignature Language="C#" Value="public override void LayoutSubviews ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void LayoutSubviews() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProcessKey">
      <MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
      </Parameters>
      <Docs>
        <param name="kb">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>