File: Scale.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 (316 lines) | stat: -rw-r--r-- 14,213 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<Type Name="Scale" FullName="Gtk.Scale">
  <TypeSignature Language="C#" Maintainer="auto" Value="public class Scale : Gtk.Range" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Scale extends Gtk.Range" />
  <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>Gtk.Range</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Docs>
    <summary>A base class for the concrete slider widgets; <see cref="T:Gtk.HScale" /> and <see cref="T:Gtk.VScale" />.</summary>
    <remarks>
      <para>A Scale is a slider control used to select a numeric value. Specific manipulation can be done with methods and properties on its base class, <see cref="T:Gtk.Range" />. To set the value of a scale, you would normally use the <see cref="P:Gtk.Range.Value" /> property. To detect changes to the value, connect an event handler to the <see cref="F:Gtk.Range.ValueChanged" /> event.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Scale (IntPtr raw);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="raw">Pointer to the C object.</param>
        <summary>Internal constructor</summary>
        <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="public Scale (Gtk.Orientation orientation, Gtk.Adjustment adjustment);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Gtk.Orientation orientation, class Gtk.Adjustment adjustment) cil managed" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="orientation" Type="Gtk.Orientation" />
        <Parameter Name="adjustment" Type="Gtk.Adjustment" />
      </Parameters>
      <Docs>
        <param name="orientation">To be added.</param>
        <param name="adjustment">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Scale (Gtk.Orientation orientation, double min, double max, double step);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Gtk.Orientation orientation, float64 min, float64 max, float64 step) cil managed" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="orientation" Type="Gtk.Orientation" />
        <Parameter Name="min" Type="System.Double" />
        <Parameter Name="max" Type="System.Double" />
        <Parameter Name="step" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="orientation">To be added.</param>
        <param name="min">To be added.</param>
        <param name="max">To be added.</param>
        <param name="step">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="AddMark">
      <MemberSignature Language="C#" Value="public void AddMark (double value, Gtk.PositionType position, string markup);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddMark(float64 value, valuetype Gtk.PositionType position, string markup) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Double" />
        <Parameter Name="position" Type="Gtk.PositionType" />
        <Parameter Name="markup" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <param name="position">To be added.</param>
        <param name="markup">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="ClearMarks">
      <MemberSignature Language="C#" Value="public void ClearMarks ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ClearMarks() cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="Digits">
      <MemberSignature Language="C#" Value="public int Digits { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Digits" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("digits")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage the number of decimal places for this slider.</summary>
        <value>The number of decimal places currently being displayed.</value>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="DrawValue">
      <MemberSignature Language="C#" Value="public bool DrawValue { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool DrawValue" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("draw-value")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage whether a label is displayed to show the current value.</summary>
        <value>Whether the value is currently being displayed.</value>
        <remarks>
          <para>Use the <see cref="P:Gtk.Scale.ValuePos" /> property to alter the position of displayed value.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatValue">
      <MemberSignature Language="C#" Value="public event Gtk.FormatValueHandler FormatValue;" />
      <MemberSignature Language="ILAsm" Value=".event class Gtk.FormatValueHandler FormatValue" />
      <MemberType>Event</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Signal("format-value")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Gtk.FormatValueHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Allows the format of the displayed value to be altered.</summary>
        <remarks>
          <para>Note: The signature of this event handler is currently incorrect.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetLayoutOffsets">
      <MemberSignature Language="C#" Value="public void GetLayoutOffsets (out int x, out int y);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetLayoutOffsets(int32 x, int32 y) cil managed" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="y" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="x">a <see cref="T:System.Int32" />, location to store X offset of layout</param>
        <param name="y">a <see cref="T:System.Int32" />, location to store Y offset of layout </param>
        <summary>
	  Obtains the coordinates where the scale will draw the <see cref="T:Pango.Layout" />
	  representing the text in the scale. 
	</summary>
        <remarks>
	  Remember that when working with Pango you need to convert to
	  and from pixels using PANGO_PIXELS() or <see cref="F:Pango.Scale.PangoScale" />.
	  If <see cref="P:Gtk.Scale.DrawValue" /> is <see langword="false" />, the return values are 
	  undefined.
	</remarks>
        <since version="Gtk# 2.4" />
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
      <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:Gtk.Scale" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Layout">
      <MemberSignature Language="C#" Value="public Pango.Layout Layout { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Pango.Layout Layout" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Pango.Layout</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the <see cref="T:Pango.Layout" /> used to display the scale. </summary>
        <value>a <see cref="T:Pango.Layout" /></value>
        <remarks>
        </remarks>
        <since version="Gtk# 2.4" />
      </Docs>
    </Member>
    <Member MemberName="OnDrawValue">
      <MemberSignature Language="C#" Value="protected virtual void OnDrawValue ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnDrawValue() cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideDrawValue", Type=typeof(Gtk.Scale))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="OnFormatValue">
      <MemberSignature Language="C#" Value="protected virtual string OnFormatValue (double value);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string OnFormatValue(float64 value) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideFormatValue", Type=typeof(Gtk.Scale))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="value">a <see cref="T:System.Double" /></param>
        <summary>Default handler for the <see cref="M:Gtk.Scale.FormatValue" /> event.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Scale.FormatValue" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnGetLayoutOffsets">
      <MemberSignature Language="C#" Value="protected virtual void OnGetLayoutOffsets (out int x, out int y);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnGetLayoutOffsets(int32 x, int32 y) cil managed" />
      <MemberType>Method</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetLayoutOffsets", Type=typeof(Gtk.Scale))</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="y" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="x">To be added.</param>
        <param name="y">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version="Gtk# 3.0" />
      </Docs>
    </Member>
    <Member MemberName="ValuePos">
      <MemberSignature Language="C#" Value="public Gtk.PositionType ValuePos { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.PositionType ValuePos" />
      <MemberType>Property</MemberType>
      <Attributes>
        <Attribute>
          <AttributeName>GLib.Property("value-pos")</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Gtk.PositionType</ReturnType>
      </ReturnValue>
      <Parameters>
      </Parameters>
      <Docs>
        <summary>Manage the position of the value, relative to the slider.</summary>
        <value>Where the value is currently being drawn.</value>
        <remarks>
          <para>Note: This property is only meaningful if a value is being drawn. To ensure a value is drawn, use the <see cref="P:Gtk.Scale.DrawValue" /> property.</para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>