GtkSharp/doc/en/Gtk/Accelerator.xml

<Type Name="Accelerator" FullName="Gtk.Accelerator">
  <TypeSignature Language="C#" Value="public class Accelerator" 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>An accelerator.</summary>
    <remarks>TODO: explain the relationship between this class and <see cref="T:Gtk.Accel" />.</remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Valid">
      <MemberSignature Language="C#" Value="public static bool Valid (uint keyval, Gdk.ModifierType modifiers);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="keyval" Type="System.UInt32" />
        <Parameter Name="modifiers" Type="Gdk.ModifierType" />
      </Parameters>
      <Docs>
        <summary>Determines whether a given keyval and modifier mask constitute
	  a valid keyboard accelerator. For example, <see cref="F:Gdk.Key.A" /> 
	  keyval plus <see cref="F:Gdk.ModifierType.ControlMask" /> is valid; 
	  this is a "Ctrl+a" accelerator. However, you can't use the 
	  <see cref="F:Gdk.Control_L" /> keyval as an accelerator.</summary>
        <param name="keyval">a <see cref="T:System.UInt32" />, see <see cref="Gkd.Key" /> for useful values</param>
        <param name="modifiers">a <see cref="T:Gdk.ModifierType" /></param>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public static string Name (uint accelerator_key, Gdk.ModifierType accelerator_mods);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="accelerator_key" Type="System.UInt32" />
        <Parameter Name="accelerator_mods" Type="Gdk.ModifierType" />
      </Parameters>
      <Docs>
        <summary>Converts an accelerator keyval and modifier mask into 
	  a string parseable by <see cref="M:Gtk.Accelerator.Parse" />.
	  For example, if you pass in <see cref="F:Gdk.Key.Q" /> and 
	  <see cref="F:Gdk.ModifierType.ControlMask" />,
	  this function returns "&lt;Control&gt;q". 
	</summary>
        <param name="accelerator_key">a <see cref="T:System.UInt32" /></param>
        <param name="accelerator_mods">a <see cref="T:Gdk.ModifierType" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>In Gtk+, the return value must be freed by the caller, but not in Gtk#.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Accelerator ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Basic constructor.</summary>
        <returns>a <see cref="T:Gtk.Accelerator" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="DefaultModMask">
      <MemberSignature Language="C#" Value="public static Gdk.ModifierType DefaultModMask { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.ModifierType</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>A mask to specify the default modifier key(s).</summary>
        <param name="value">a <see cref="T:Gdk.ModifierType" /></param>
        <returns>a <see cref="T:Gdk.ModifierType" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Parse">
      <MemberSignature Language="C#" Value="public static void Parse (string accelerator, out uint accelerator_key, out Gdk.ModifierType accelerator_mods);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="accelerator" Type="System.String" />
        <Parameter Name="accelerator_key" Type="System.UInt32&amp;" RefType="out" />
        <Parameter Name="accelerator_mods" Type="Gdk.ModifierType&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary> Parses a string representing an accelerator. The format looks like "&lt;Control&gt;a" or "&lt;Shift&gt;&lt;Alt&gt;F1" or "&lt;Release&gt;z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "&lt;Ctl&gt;" and "&lt;Ctrl&gt;".</summary>
        <param name="accelerator">a <see cref="T:System.String" /></param>
        <param name="accelerator_key">a <see cref="T:System.UInt32&amp;" />, thekey to map to.</param>
        <param name="accelerator_mods">a <see cref="T:Gdk.ModifierType&amp;" /> to fill with data.</param>
        <remarks>If the parse fails, <paramref name="accelerator_key" /> and <paramref name="accelerator_mods" /> will be set to 0 (zero).</remarks>
      </Docs>
    </Member>
  </Members>
</Type>