GtkSharp/doc/en/Gnome/Program.xml

<Type Name="Program" FullName="Gnome.Program">
  <TypeSignature Language="C#" Maintainer="auto" Value="public class Program : GLib.Object" />
  <AssemblyInfo>
    <AssemblyName>gnome-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>2.20.0.0</AssemblyVersion>
  </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>
  <Base>
    <BaseTypeName>GLib.Object</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Members>
    <Member MemberName="Get">
      <MemberSignature Language="C#" Value="public static Gnome.Program Get ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Program</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'Gnome.Program'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ModuleRegistered">
      <MemberSignature Language="C#" Value="public static bool ModuleRegistered (Gnome.ModuleInfo module_info);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="module_info" Type="Gnome.ModuleInfo" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="module_info">To be added: an object of type 'Gnome.ModuleInfo'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ModuleRegister">
      <MemberSignature Language="C#" Value="public static void ModuleRegister (Gnome.ModuleInfo module_info);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="module_info" Type="Gnome.ModuleInfo" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="module_info">To be added: an object of type 'Gnome.ModuleInfo'</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ModuleLoad">
      <MemberSignature Language="C#" Value="public static Gnome.ModuleInfo ModuleLoad (string mod_name);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.ModuleInfo</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="mod_name" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="mod_name">To be added: an object of type 'string'</param>
        <returns>To be added: an object of type 'Gnome.ModuleInfo'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Quit">
      <MemberSignature Language="C#" Value="public void Quit ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Run">
      <MemberSignature Language="C#" Value="public void Run ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="LocateFile">
      <MemberSignature Language="C#" Value="public string LocateFile (Gnome.FileDomain domain, string file_name, bool only_if_exists, GLib.SList ret_locations);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="domain" Type="Gnome.FileDomain" />
        <Parameter Name="file_name" Type="System.String" />
        <Parameter Name="only_if_exists" Type="System.Boolean" />
        <Parameter Name="ret_locations" Type="GLib.SList" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="domain">To be added: an object of type 'Gnome.FileDomain'</param>
        <param name="file_name">To be added: an object of type 'string'</param>
        <param name="only_if_exists">To be added: an object of type 'bool'</param>
        <param name="ret_locations">To be added: an object of type 'GLib.SList'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Postinit">
      <MemberSignature Language="C#" Value="public void Postinit ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="ParseArgs">
      <MemberSignature Language="C#" Value="public void ParseArgs ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Program (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>
        <remarks>
          <para>This is an internal constructor, and should not be used by user code.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PoptContext">
      <MemberSignature Language="C#" Value="public IntPtr PoptContext { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'IntPtr'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("popt-context")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GnomePrefix">
      <MemberSignature Language="C#" Value="public string GnomePrefix { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("gnome-prefix")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppVersion">
      <MemberSignature Language="C#" Value="public string AppVersion { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-version")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="HumanReadableName">
      <MemberSignature Language="C#" Value="public string HumanReadableName { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("human-readable-name")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppId">
      <MemberSignature Language="C#" Value="public string AppId { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-id")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GnomeSysconfdir">
      <MemberSignature Language="C#" Value="public string GnomeSysconfdir { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("gnome-sysconfdir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GnomeLibdir">
      <MemberSignature Language="C#" Value="public string GnomeLibdir { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("gnome-libdir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppSysconfdir">
      <MemberSignature Language="C#" Value="public string AppSysconfdir { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-sysconfdir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="CreateDirectories">
      <MemberSignature Language="C#" Value="public bool CreateDirectories { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'bool'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("create-directories")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="EnableSound">
      <MemberSignature Language="C#" Value="public bool EnableSound { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'bool'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("enable-sound")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppDatadir">
      <MemberSignature Language="C#" Value="public string AppDatadir { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-datadir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="Espeaker">
      <MemberSignature Language="C#" Value="public string Espeaker { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("espeaker")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppLibdir">
      <MemberSignature Language="C#" Value="public string AppLibdir { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-libdir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="AppPrefix">
      <MemberSignature Language="C#" Value="public string AppPrefix { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("app-prefix")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GnomeDatadir">
      <MemberSignature Language="C#" Value="public string GnomeDatadir { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("gnome-datadir")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GnomePath">
      <MemberSignature Language="C#" Value="public string GnomePath { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <value>To be added: an object of type 'string'</value>
        <remarks>To be added</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("gnome-path")</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <value>a <see cref="T:GLib.GType" /></value>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.Program" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Initv">
      <MemberSignature Language="C#" Value="public static Gnome.Program Initv (GLib.GType type, string app_id, string app_version, Gnome.ModuleInfo module_info, int argc, string argv, string first_property_name, IntPtr args);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gnome.Program</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="type" Type="GLib.GType" />
        <Parameter Name="app_id" Type="System.String" />
        <Parameter Name="app_version" Type="System.String" />
        <Parameter Name="module_info" Type="Gnome.ModuleInfo" />
        <Parameter Name="argc" Type="System.Int32" />
        <Parameter Name="argv" Type="System.String" />
        <Parameter Name="first_property_name" Type="System.String" />
        <Parameter Name="args" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="type">a <see cref="T:GLib.GType" /></param>
        <param name="app_id">a <see cref="T:System.String" /></param>
        <param name="app_version">a <see cref="T:System.String" /></param>
        <param name="module_info">a <see cref="T:Gnome.ModuleInfo" /></param>
        <param name="argc">a <see cref="T:System.Int32" /></param>
        <param name="argv">a <see cref="T:System.String" /></param>
        <param name="first_property_name">a <see cref="T:System.String" /></param>
        <param name="args">a <see cref="T:System.IntPtr" /></param>
        <returns>a <see cref="T:Gnome.Program" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Program (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Protected Constructor.</summary>
        <param name="gtype">a <see cref="T:GLib.GType" /></param>
        <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
      </Docs>
      <Attributes>
        <Attribute>
          <AttributeName>System.Obsolete</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Program ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Program (string app_id, string app_version, Gnome.ModuleInfo module, string[] argv, object[] props);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="app_id" Type="System.String" />
        <Parameter Name="app_version" Type="System.String" />
        <Parameter Name="module" Type="Gnome.ModuleInfo" />
        <Parameter Name="argv" Type="System.String[]" />
        <Parameter Name="props" Type="System.Object[]">
          <Attributes>
            <Attribute>
              <AttributeName>System.ParamArray</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="app_id">To be added.</param>
        <param name="app_version">To be added.</param>
        <param name="module">To be added.</param>
        <param name="argv">To be added.</param>
        <param name="props">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GoptionContext">
      <MemberSignature Language="C#" Value="public IntPtr GoptionContext { get; };" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("goption-context")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version="Gnome# 2.16" />
      </Docs>
    </Member>
  </Members>
</Type>