GtkSharp/doc/en/Gnome/Program.xml

<Type Name="Program" FullName="Gnome.Program">
  <TypeSignature Language="C#" Value="public class Program : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gnome-sharp</AssemblyName>
    <AssemblyPublicKey></AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <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>To be added</summary>
    <remarks>To be added</remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <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="Initv">
      <MemberSignature Language="C#" Value="public static Gnome.Program Initv (uint 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="System.UInt32" />
        <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">To be added: an object of type 'uint'</param>
        <param name="app_id">To be added: an object of type 'string'</param>
        <param name="app_version">To be added: an object of type 'string'</param>
        <param name="module_info">To be added: an object of type 'Gnome.ModuleInfo'</param>
        <param name="argc">To be added: an object of type 'int'</param>
        <param name="argv">To be added: an object of type 'string'</param>
        <param name="first_property_name">To be added: an object of type 'string'</param>
        <param name="args">To be added: an object of type 'IntPtr'</param>
        <returns>To be added: an object of type 'Gnome.Program'</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="Finalize">
      <MemberSignature Language="C#" Value="protected override 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 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>
        <returns>An instance of Program, 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 Program ();" />
      <MemberType>Constructor</MemberType>
      <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=".ctor">
      <MemberSignature Language="C#" Value="public Program (string app_id, string app_version, Gnome.ModuleInfo module, string [] argv, object [] props);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <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 []" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="app_id">To be added: an object of type 'string'</param>
        <param name="app_version">To be added: an object of type 'string'</param>
        <param name="module">To be added: an object of type 'Gnome.ModuleInfo'</param>
        <param name="argv">To be added: an object of type 'string []'</param>
        <param name="props">To be added: an object of type 'object []'</param>
        <returns>To be added: an object of type 'Gnome.Program'</returns>
        <remarks>To be added</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 GLib Type for Gnome.Program</summary>
        <returns>The GLib Type for the Gnome.Program class.</returns>
        <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>
        <returns>To be added: an object of type 'IntPtr'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <param name="value">To be added: an object of type 'string'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="EnableSound">
      <MemberSignature Language="C#" Value="public bool EnableSound { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <param name="value">To be added: an object of type 'string'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="Espeaker">
      <MemberSignature Language="C#" Value="public string Espeaker { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <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>
      </Docs>
    </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>
        <param name="value">To be added: an object of type 'string'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <param name="value">To be added: an object of type 'string'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </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>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Program (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 Program, using the GLib-provided type</returns>
        <remarks>
          <para>This is a constructor used by derivative types of <see cref="T:Gnome.Program" /> that would have their own GLib type assigned to it.  This is not typically used by C# code.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>