GtkSharp/doc/en/Gtk/Rc.xml

<Type Name="Rc" FullName="Gtk.Rc">
  <TypeSignature Language="C#" Value="public class Rc" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gtk-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>Object for rc-file handling--- for example, ~/.gtkrc--- and application style and default setting. Rc files can be used to set the colors of just about any widget, and they can also be used to tile pixmaps onto the background of some widgets.</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="GetStyle">
      <MemberSignature Language="C#" Value="public static Gtk.Style GetStyle (Gtk.Widget widget);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Style</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="widget" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Finds all matching RC styles for a given widget, composites them together, and then creates a <see cref="T:Gtk.Style" /> representing the composite appearance.</summary>
        <param name="widget">a <see cref="T:Gtk.Widget" /></param>
        <returns>a <see cref="T:Gtk.Style" /></returns>
        <remarks>(GTK+ actually keeps a cache of previously created styles, so a new style may not be created.)</remarks>
      </Docs>
    </Member>
    <Member MemberName="Parse">
      <MemberSignature Language="C#" Value="public static void Parse (string filename);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="filename" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Parses an rc file into the internal data structure.</summary>
        <param name="filename">a <see cref="T:System.String" />, the file to parse.</param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="FindModuleInPath">
      <MemberSignature Language="C#" Value="public static string FindModuleInPath (string module_file);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="module_file" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Searches for a theme engine in the GTK+ search path. This function is not useful for applications and should not be used.</summary>
        <param name="module_file">a <see cref="T:System.String" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ParseString">
      <MemberSignature Language="C#" Value="public static void ParseString (string rc_string);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="rc_string" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Parses resource information directly from a string.</summary>
        <param name="rc_string">a <see cref="T:System.String" /> to parse.</param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ReparseAllForSettings">
      <MemberSignature Language="C#" Value="public static bool ReparseAllForSettings (Gtk.Settings settings, bool force_load);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="settings" Type="Gtk.Settings" />
        <Parameter Name="force_load" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>If the modification time on any previously read file for the given <see cref="T:Gtk.Settings" /> has changed, discard all style information and then reread all previously read RC files.</summary>
        <param name="settings">a <see cref="T:Gtk.Settings" /></param>
        <param name="force_load">a <see cref="T:System.Boolean" />, force reload whether or not anything changed if TRUE</param>
        <returns>a <see cref="T:System.Boolean" />, TRUE if the files were re-read.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="AddDefaultFile">
      <MemberSignature Language="C#" Value="public static void AddDefaultFile (string filename);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="filename" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Adds a file to the list of files to be parsed at the end of <see cref="M:Gtk.Init()" />.</summary>
        <param name="filename">a <see cref="T:System.String" />, the filename to add to the parse list</param>
        <remarks>If <paramref name="filename" /> is not absolute, it is searched in the current directory.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ReparseAll">
      <MemberSignature Language="C#" Value="public static bool ReparseAll ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>If the modification time on any previously read file for the default <see cref="T:Gtk.Settings" /> has changed, discard all style information and then reread all previously read RC files.</summary>
        <returns>a <see cref="T:System.Boolean" />, TRUE if files were re-read.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Rc ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Public constructor; generates a new RC parser.</summary>
        <returns>a <see cref="T:Gtk.Rc" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ModuleDir">
      <MemberSignature Language="C#" Value="public static string ModuleDir { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the name a directory in which GTK# looks for theme engines.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>Unlike the underlying GTK+ function, the return value of this method is a string, not a directory handle that must be freed later. (FIXME: the GTK+ docs point at the "GTK_PATH" section of "Running GTK applications", which is very detailed and may or may not need included here.)</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThemeDir">
      <MemberSignature Language="C#" Value="public static string ThemeDir { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the standard directory in which themes should be installed. (GTK+ does not actually use this directory itself.)</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>Unlike the underlying GTK+ function, the return value of this method is a string, not a directory handle that must be freed later.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ImModuleFile">
      <MemberSignature Language="C#" Value="public static string ImModuleFile { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The path to the IM module file specified by the RC file. This may be overridden by the GTK_IM_MODULE_FILE environment variable.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>(FIXME: does this apply for Gtk# too?) In standard Gtk+ applications, the GTK_IM_MODULE_FILE environment variable overrides the im_module_file specified in the RC files, which in turn overrides the default value sysconfdir/gtk-2.0/gtk.immodules  (sysconfdir is the sysconfdir specified when GTK+ was configured, usually /usr/local/etc.)</remarks>
      </Docs>
    </Member>
    <Member MemberName="ImModulePath">
      <MemberSignature Language="C#" Value="public static string ImModulePath { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Obtains the path in which to look for IM modules. 
</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>(FIXME: "See the documentation of the GTK_PATH environment variable for more details about looking up modules.") This function is useful solely for utilities supplied with GTK+ and should not be used by applications under normal circumstances.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DefaultFiles">
      <MemberSignature Language="C#" Value="public static string DefaultFiles { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>The current list of RC files that will be parsed at the end of <see cref="M:Gtk.Init()" />.</summary>
        <param name="value">a <see cref="T:System.String" /></param>
        <returns>a <see cref="T:System.String" />, a list of filenames.</returns>
        <remarks>Unlike the underlying GTK+ function, this function's return string does not use memory owned by the application.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetStyleByPaths">
      <MemberSignature Language="C#" Value="public static Gtk.Style GetStyleByPaths (Gtk.Settings settings, string widget_path, string class_path, GLib.GType type);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Style</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="settings" Type="Gtk.Settings" />
        <Parameter Name="widget_path" Type="System.String" />
        <Parameter Name="class_path" Type="System.String" />
        <Parameter Name="type" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Creates up a <see cref="T:Gtk.Style" /> from styles defined in a RC file by providing the raw components used in matching. This function may be useful when creating pseudo-widgets that should be themed like widgets but don't actually have corresponding GTK# widgets. An example of this would be items inside a GNOME canvas widget.</summary>
        <param name="settings">a <see cref="T:Gtk.Settings" /></param>
        <param name="widget_path">a <see cref="T:System.String" />,  the widget path to use when looking up the style, or <see langword="null" />  if no matching against the widget path should be done</param>
        <param name="class_path">a <see cref="T:System.String" />,  the class path to use when looking up the style, or <see langword="null" />  if no matching against the class path should be done.</param>
        <param name="type">a <see cref="T:GLib.GType" />,  a type that will be used along with parent types of this type when matching against class styles, or G_TYPE_NONE</param>
        <returns>a <see cref="T:Gtk.Style" />,a style created by matching with the supplied paths, or <see langword="null" /> if nothing matching was specified and the default style should be used. 
</returns>
        <remarks>The returned value is owned by GTK+ as part of an internal cache, so you must call g_object_ref() on the returned value if you want to keep a reference to it. (FIXME: what's the GTK# equivalent of g_object_ref()?)</remarks>
      </Docs>
    </Member>
  </Members>
</Type>