File: Accelerator.xml

package info (click to toggle)
gtk-sharp3 2.99.3-4.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 25,488 kB
  • sloc: xml: 308,885; cs: 38,796; sh: 11,336; perl: 1,295; makefile: 1,099; ansic: 903
file content (133 lines) | stat: -rw-r--r-- 7,328 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<Type Name="Accelerator" FullName="Gtk.Accelerator">
  <TypeSignature Language="C#" Value="public class Accelerator" Maintainer="auto" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Accelerator extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>gtk-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
  </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>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>An accelerator.</summary>
    <remarks>TODO: explain the relationship between this class and <see cref="T:Gtk.Accel" />.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Accelerator ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Basic constructor.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="DefaultModMask">
      <MemberSignature Language="C#" Value="public static Gdk.ModifierType DefaultModMask { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Gdk.ModifierType DefaultModMask" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.ModifierType</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>A mask to specify the default modifier key(s).</summary>
        <value>a <see cref="T:Gdk.ModifierType" /></value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetLabel">
      <MemberSignature Language="C#" Value="public static string GetLabel (uint accelerator_key, Gdk.ModifierType accelerator_mods);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig string GetLabel(unsigned int32 accelerator_key, valuetype Gdk.ModifierType accelerator_mods) cil managed" />
      <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>
        <param name="accelerator_key">A <see cref="T:System.UInt32" /> representing the accelerator keyval.</param>
        <param name="accelerator_mods">A <see cref="T:System.Int32" /> representing the accelerator modifier mask.</param>
        <summary>Converts an accelerator keyval and modifier mask into a string which can be used to represent the accelerator to the user.</summary>
        <returns>A newly-allocated string representing the accelerator.</returns>
        <remarks />
        <since version="Gtk# 2.6" />
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public static string Name (uint accelerator_key, Gdk.ModifierType accelerator_mods);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig string Name(unsigned int32 accelerator_key, valuetype Gdk.ModifierType accelerator_mods) cil managed" />
      <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>
        <param name="accelerator_key">a <see cref="T:System.UInt32" /></param>
        <param name="accelerator_mods">a <see cref="T:Gdk.ModifierType" /></param>
        <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>
        <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="Parse">
      <MemberSignature Language="C#" Value="public static void Parse (string accelerator, out uint accelerator_key, out Gdk.ModifierType accelerator_mods);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void Parse(string accelerator, unsigned int32 accelerator_key, valuetype Gdk.ModifierType accelerator_mods) cil managed" />
      <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>
        <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>
        <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>
        <remarks>If the parse fails, <paramref name="accelerator_key" /> and <paramref name="accelerator_mods" /> will be set to 0 (zero).</remarks>
      </Docs>
    </Member>
    <Member MemberName="Valid">
      <MemberSignature Language="C#" Value="public static bool Valid (uint keyval, Gdk.ModifierType modifiers);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool Valid(unsigned int32 keyval, valuetype Gdk.ModifierType modifiers) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="keyval" Type="System.UInt32" />
        <Parameter Name="modifiers" Type="Gdk.ModifierType" />
      </Parameters>
      <Docs>
        <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>
        <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>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks />
      </Docs>
    </Member>
  </Members>
</Type>