mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-23 07:00:46 +00:00
Added documentation for NSSlider and NSSlider cell.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@6278 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
James Dessart
parent
2c92f9cdaa
commit
9bab514d34
4 changed files with 550 additions and 8 deletions
|
|
@ -7,8 +7,11 @@
|
|||
<email address="rfm@gnu.org"/>
|
||||
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>28 February, 2000</date>
|
||||
<author name="James Dessart">
|
||||
<email address="skwirl@cam.org"/>
|
||||
</author>
|
||||
<version>0.2</version>
|
||||
<date>11 March, 2000</date>
|
||||
</head>
|
||||
<body>
|
||||
<chapter>
|
||||
|
|
@ -17,172 +20,232 @@
|
|||
<declared>AppKit/NSSlider.h</declared>
|
||||
<conform>NSCoding</conform>
|
||||
<desc>
|
||||
<p>An NSSlider displays, and allows control of, some value in the application.
|
||||
It represents a continuous stream of values of type <code>float</code>, which
|
||||
can be retrieved by the method <code>floatValue</code> and set by the method
|
||||
<code>setFloatValue:</code>.</p>
|
||||
|
||||
<p>The OPENSTEP API describes this control as being continuous, but the current
|
||||
GNUstep implementation defaults to non-continuous. This can be set by the
|
||||
inherited method <code>setContinuous:</code>, by passing <code>YES</code>.</p>
|
||||
|
||||
<p>Although methods for adding and managing a title are provided, the slider's
|
||||
knob can cover this title, so it is recommended that a label be added near the
|
||||
slider, for identification.</p>
|
||||
|
||||
<p>As with many controls, NSSlider relies on its cell counterpart, NSSliderCell.
|
||||
For more information, please see the specification for NSSliderCell.</p>
|
||||
|
||||
<p>Use of an NSSlider to do the role of an NSScroller is not recommended. A
|
||||
scroller is intended to represent the visible portion of a view, whereas a slider
|
||||
is intended to represent some value.</p>
|
||||
</desc>
|
||||
<method type="BOOL">
|
||||
<sel>acceptsFirstMouse:</sel>
|
||||
<arg type="NSEvent*">mouseDownEvent</arg>
|
||||
<desc>
|
||||
<p>Returns <code>YES</code> by default. This will allow the first click sent to
|
||||
the slider, when in an inactive window, to both bring the window into focus and
|
||||
manipulate the slider.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="BOOL">
|
||||
<sel>allowsTickMarkValuesOnly</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>altIncrementValue</sel>
|
||||
<desc>
|
||||
<p>Returns the value by which the slider will be incremented if the user holds down
|
||||
the ALT key.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>closestTickMarkValueToValue:</sel>
|
||||
<arg type="double">aValue</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSImage*">
|
||||
<sel>image</sel>
|
||||
<desc>
|
||||
<p>Returns the image drawn in the slider's track. Returns <code>nil</code> if
|
||||
this has not been set.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>indexOfTickMarkAtPoint:</sel>
|
||||
<arg type="NSPoint">point</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>isVertical</sel>
|
||||
<desc>
|
||||
<p>Returns whether or not the slider is vertical. If, for some reason, this cannot
|
||||
be determined, for such reasons as the slider is not yet displayed, this method
|
||||
returns -1. Generally, a slider is considered vertical if its height is greater
|
||||
than its width.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="float">
|
||||
<sel>knobThickness</sel>
|
||||
<desc>
|
||||
<p>Returns the thickness of the slider's knob. This value is in pixels, and is the
|
||||
size of the knob along the slider's track.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>maxValue</sel>
|
||||
<desc>
|
||||
<p>Returns the maximum value that the slider represents.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>minValue</sel>
|
||||
<desc>
|
||||
<p>Returns the minimum value that the slider represents.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>numberOfTickMarks</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSRect">
|
||||
<sel>rectOfTickMarkAtIndex:</sel>
|
||||
<arg type="int">index</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setAllowsTickMarkValuesOnly:</sel>
|
||||
<arg type="BOOL">flag</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setAltIncrementValue:</sel>
|
||||
<arg type="double">increment</arg>
|
||||
<desc>
|
||||
<p>Sets the value by which the slider will be be incremented when with the
|
||||
ALT key down to <var>increment</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setImage:</sel>
|
||||
<arg type="NSImage*">barImage</arg>
|
||||
<desc>
|
||||
<p>Sets the image to be displayed in the slider's track to <var>barImage</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setKnobThickness:</sel>
|
||||
<arg type="float">thickness</arg>
|
||||
<desc>
|
||||
<p>Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
|
||||
sets the amount of space which the knob takes up in the slider's track.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMaxValue:</sel>
|
||||
<arg type="double">maxValue</arg>
|
||||
<desc>
|
||||
<p>Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMinValue:</sel>
|
||||
<arg type="double">minValue</arg>
|
||||
<desc>
|
||||
<p>Sets the minimum value that the slider represents to <var>minValue</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setNumberOfTickMarks:</sel>
|
||||
<arg type="int">numberOfTickMarks</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTickMarkPosition:</sel>
|
||||
<arg type="NSTickMarkPosition">position</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitle:</sel>
|
||||
<arg type="NSString*">barTitle</arg>
|
||||
<desc>
|
||||
<p>Sets the title of the slider to <var>barTitle</var>. This title is displayed
|
||||
on the slider's track, behind the knob.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleCell:</sel>
|
||||
<arg type="NSCell*">titleCell</arg>
|
||||
<desc>
|
||||
<p>Sets the cell used to draw the title to <var>titleCell</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleColor:</sel>
|
||||
<arg type="NSColor*">color</arg>
|
||||
<desc>
|
||||
<p>Sets the colour with which the title will be drawn to <var>color</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleFont:</sel>
|
||||
<arg type="NSFont*">font</arg>
|
||||
<desc>
|
||||
<p>Sets the font with which the title will be drawm to <var>font</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSTickMarkPosition">
|
||||
<sel>tickMarkPosition</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>tickMarkValueAtIndex:</sel>
|
||||
<arg type="int">index</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSString*">
|
||||
<sel>title</sel>
|
||||
<desc>
|
||||
<p>Returns the title of the slider as an <code>NSString</code>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="id">
|
||||
<sel>titleCell</sel>
|
||||
<desc>
|
||||
<p>Returns the cell used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSColor*">
|
||||
<sel>titleColor</sel>
|
||||
<desc>
|
||||
<p>Returns the colour used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSFont*">
|
||||
<sel>titleFont</sel>
|
||||
<desc>
|
||||
<p>Returns the font used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
</class>
|
||||
|
|
|
|||
|
|
@ -10,9 +10,11 @@
|
|||
<dl>
|
||||
<dt><a href="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
|
||||
<dd>
|
||||
<dt>James Dessart
|
||||
<dd>
|
||||
</dl>
|
||||
<p>Version: 0.1</p>
|
||||
<p>Date: 28 February, 2000</p>
|
||||
<p>Version: 0.2</p>
|
||||
<p>Date: 11 March, 2000</p>
|
||||
<h2><a name="cont-0">NSSlider</a></h2>
|
||||
<h2><a name="NSSlider">NSSlider</a></h2>
|
||||
<p><b>Declared in:</b> AppKit/NSSlider.h</p>
|
||||
|
|
@ -21,6 +23,60 @@
|
|||
</p>
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
An NSSlider displays, and allows control of, some value in the application.
|
||||
It represents a continuous stream of values of type <code>float</code>, which
|
||||
can be retrieved by the method <code>floatValue</code> and set by the method
|
||||
<code>setFloatValue:</code>.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
The OPENSTEP API describes this control as being continuous, but the current
|
||||
GNUstep implementation defaults to non-continuous. This can be set by the
|
||||
inherited method <code>setContinuous:</code>, by passing <code>YES</code>.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Although methods for adding and managing a title are provided, the slider's
|
||||
knob can cover this title, so it is recommended that a label be added near the
|
||||
slider, for identification.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
As with many controls, NSSlider relies on its cell counterpart, NSSliderCell.
|
||||
For more information, please see the specification for NSSliderCell.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Use of an NSSlider to do the role of an NSScroller is not recommended. A
|
||||
scroller is intended to represent the visible portion of a view, whereas a slider
|
||||
is intended to represent some value.</p>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="NSSlider.html#method-0">-acceptsFirstMouse:</a>
|
||||
|
|
@ -58,151 +114,282 @@
|
|||
<h2><a name="method-0">acceptsFirstMouse:</a></h2>
|
||||
- (BOOL) <b>acceptsFirstMouse:</b> (NSEvent*)mouseDownEvent<br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns <code>YES</code> by default. This will allow the first click sent to
|
||||
the slider, when in an inactive window, to both bring the window into focus and
|
||||
manipulate the slider.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-1">allowsTickMarkValuesOnly</a></h2>
|
||||
- (BOOL) <b>allowsTickMarkValuesOnly</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-2">altIncrementValue</a></h2>
|
||||
- (double) <b>altIncrementValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the value by which the slider will be incremented if the user holds down
|
||||
the ALT key.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-3">closestTickMarkValueToValue:</a></h2>
|
||||
- (double) <b>closestTickMarkValueToValue:</b> (double)aValue<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-4">image</a></h2>
|
||||
- (NSImage*) <b>image</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the image drawn in the slider's track. Returns <code>nil</code> if
|
||||
this has not been set.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-5">indexOfTickMarkAtPoint:</a></h2>
|
||||
- (int) <b>indexOfTickMarkAtPoint:</b> (NSPoint)point<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-6">isVertical</a></h2>
|
||||
- (int) <b>isVertical</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns whether or not the slider is vertical. If, for some reason, this cannot
|
||||
be determined, for such reasons as the slider is not yet displayed, this method
|
||||
returns -1. Generally, a slider is considered vertical if its height is greater
|
||||
than its width.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-7">knobThickness</a></h2>
|
||||
- (float) <b>knobThickness</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the thickness of the slider's knob. This value is in pixels, and is the
|
||||
size of the knob along the slider's track.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-8">maxValue</a></h2>
|
||||
- (double) <b>maxValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the maximum value that the slider represents.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-9">minValue</a></h2>
|
||||
- (double) <b>minValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the minimum value that the slider represents.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-10">numberOfTickMarks</a></h2>
|
||||
- (int) <b>numberOfTickMarks</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-11">rectOfTickMarkAtIndex:</a></h2>
|
||||
- (NSRect) <b>rectOfTickMarkAtIndex:</b> (int)index<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-12">setAllowsTickMarkValuesOnly:</a></h2>
|
||||
- (void) <b>setAllowsTickMarkValuesOnly:</b> (BOOL)flag<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-13">setAltIncrementValue:</a></h2>
|
||||
- (void) <b>setAltIncrementValue:</b> (double)increment<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the value by which the slider will be be incremented when with the
|
||||
ALT key down to <var>increment</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-14">setImage:</a></h2>
|
||||
- (void) <b>setImage:</b> (NSImage*)barImage<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the image to be displayed in the slider's track to <var>barImage</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-15">setKnobThickness:</a></h2>
|
||||
- (void) <b>setKnobThickness:</b> (float)thickness<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
|
||||
sets the amount of space which the knob takes up in the slider's track.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-16">setMaxValue:</a></h2>
|
||||
- (void) <b>setMaxValue:</b> (double)maxValue<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-17">setMinValue:</a></h2>
|
||||
- (void) <b>setMinValue:</b> (double)minValue<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the minimum value that the slider represents to <var>minValue</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-18">setNumberOfTickMarks:</a></h2>
|
||||
- (void) <b>setNumberOfTickMarks:</b> (int)numberOfTickMarks<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-19">setTickMarkPosition:</a></h2>
|
||||
- (void) <b>setTickMarkPosition:</b> (NSTickMarkPosition)position<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-20">setTitle:</a></h2>
|
||||
- (void) <b>setTitle:</b> (NSString*)barTitle<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the title of the slider to <var>barTitle</var>. This title is displayed
|
||||
on the slider's track, behind the knob.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-21">setTitleCell:</a></h2>
|
||||
- (void) <b>setTitleCell:</b> (NSCell*)titleCell<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the cell used to draw the title to <var>titleCell</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-22">setTitleColor:</a></h2>
|
||||
- (void) <b>setTitleColor:</b> (NSColor*)color<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the colour with which the title will be drawn to <var>color</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-23">setTitleFont:</a></h2>
|
||||
- (void) <b>setTitleFont:</b> (NSFont*)font<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the font with which the title will be drawm to <var>font</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-24">tickMarkPosition</a></h2>
|
||||
- (NSTickMarkPosition) <b>tickMarkPosition</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-25">tickMarkValueAtIndex:</a></h2>
|
||||
- (double) <b>tickMarkValueAtIndex:</b> (int)index<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-26">title</a></h2>
|
||||
- (NSString*) <b>title</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the title of the slider as an <code>NSString</code>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-27">titleCell</a></h2>
|
||||
- (id) <b>titleCell</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the cell used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-28">titleColor</a></h2>
|
||||
- (NSColor*) <b>titleColor</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the colour used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-29">titleFont</a></h2>
|
||||
- (NSFont*) <b>titleFont</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the font used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
|
|
|
|||
|
|
@ -7,8 +7,11 @@
|
|||
<email address="rfm@gnu.org"/>
|
||||
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>28 February, 2000</date>
|
||||
<author name="James Dessart">
|
||||
<email address="skwirl@cam.org"/>
|
||||
</author>
|
||||
<version>0.2</version>
|
||||
<date>11 March, 2000</date>
|
||||
</head>
|
||||
<body>
|
||||
<chapter>
|
||||
|
|
@ -17,26 +20,45 @@
|
|||
<declared>AppKit/NSSliderCell.h</declared>
|
||||
<conform>NSCoding</conform>
|
||||
<desc>
|
||||
<p>An NSSliderCell controls the behaviour and appearance of an associated NSSlider,
|
||||
or a single slider in an NSMatrix. Tick marks are defined in the official
|
||||
standard, but are not implemented in GNUstep.</p>
|
||||
|
||||
<p>An NSSliderCell can be customized through its <code>set...</code> methods.
|
||||
If these do not provide enough customization, a subclass can be created, which
|
||||
overrides any of the follwing methods: <code>knobRectFlipped:</code>,
|
||||
<code>drawBarInside:flipped:</code>, <code>drawKnob:</code>,
|
||||
or <code>prefersTrackingUntilMouseUp</code>.</p>
|
||||
</desc>
|
||||
<method type="BOOL" factory="yes">
|
||||
<sel>prefersTrackingUntilMouseUp</sel>
|
||||
<desc>
|
||||
<p>The default implementation returns <code>YES</code>, so that the slider
|
||||
continues to track the user's movement even if the cursor leaves the slider's
|
||||
track.</p>
|
||||
|
||||
<p>Do not call this method directly. Override it in subclasses where the tracking
|
||||
behaviour needs to be different.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="BOOL">
|
||||
<sel>allowsTickMarkValuesOnly</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>altIncrementValue</sel>
|
||||
<desc>
|
||||
<p>Returns the value by which the slider is incremented when the user holds down
|
||||
the ALT key.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>closestTickMarkValueToValue:</sel>
|
||||
<arg type="double">aValue</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
|
|
@ -45,162 +67,217 @@
|
|||
<sel>flipped:</sel>
|
||||
<arg type="BOOL">flipped</arg>
|
||||
<desc>
|
||||
<p>Draws the slider's track, not including the bezel, in <var>aRect</var></p>
|
||||
|
||||
<p><var>flipped</var> indicates whether the control view has a flipped
|
||||
coordinate system.</p>
|
||||
|
||||
<p>Do not call this method directly, it is provided for subclassing only.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>drawKnob</sel>
|
||||
<desc>
|
||||
<p>Calculates the rect in which to draw the knob, then calls <code>drawKnob</code>
|
||||
Before calling this method, a <code>lockFocus</code> message must be sent to the
|
||||
cell's control view.</p>
|
||||
|
||||
<p>When subclassing NSSliderCell, do not override this method. Override
|
||||
<code>drawKnob:</code> instead.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>drawKnob:</sel>
|
||||
<arg type="NSRect">knobRect</arg>
|
||||
<desc>
|
||||
<p>Draws the knob in <var>knobRect</var>. Before calling this method, a
|
||||
<code>lockFocus</code> message must be sent to the cell's control view.</p>
|
||||
|
||||
<p>Do not call this method directly. It is included for subclassing only.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>indexOfTickMarkAtPoint:</sel>
|
||||
<arg type="NSPoint">point</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>isVertical</sel>
|
||||
<desc>
|
||||
<p>Returns whether or not the slider is vertical. If, for some reason, this cannot
|
||||
be determined, for such reasons as the slider is not yet displayed, this method
|
||||
returns -1. Generally, a slider is considered vertical if its height is greater
|
||||
than its width.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSRect">
|
||||
<sel>knobRectFlipped:</sel>
|
||||
<arg type="BOOL">flipped</arg>
|
||||
<desc>
|
||||
<p>Returns the rect in which to draw the knob, based on the coordinate system
|
||||
of the NSSlider or NSMatrix this NSSliderCell is associated with.
|
||||
<var>flipped</var> indicates whether or not that coordinate system is flipped,
|
||||
which can be determined by sending the <code>isFlipped</code> message to the
|
||||
associated NSSlider or NSMatrix.</p>
|
||||
|
||||
<p>Do not call this method directly. It is included for subclassing only.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="float">
|
||||
<sel>knobThickness</sel>
|
||||
<desc>
|
||||
<p>Returns the thickness of the slider's knob. This value is in pixels, and is the
|
||||
size of the knob along the slider's track.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>maxValue</sel>
|
||||
<desc>
|
||||
<p>Returns the maximum value that the slider represents.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>minValue</sel>
|
||||
<desc>
|
||||
<p>Returns the minimum value that the slider represents.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="int">
|
||||
<sel>numberOfTickMarks</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSRect">
|
||||
<sel>rectOfTickMarkAtIndex:</sel>
|
||||
<arg type="int">index</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setAllowsTickMarkValuesOnly:</sel>
|
||||
<arg type="BOOL">flag</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setAltIncrementValue:</sel>
|
||||
<arg type="double">increment</arg>
|
||||
<desc>
|
||||
<p>Sets the value by which the slider will be be incremented when with the
|
||||
ALT key down to <var>increment</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setKnobThickness:</sel>
|
||||
<arg type="float">thickness</arg>
|
||||
<desc>
|
||||
<p>Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
|
||||
sets the amount of space which the knob takes up in the slider's track.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMaxValue:</sel>
|
||||
<arg type="double">aDouble</arg>
|
||||
<desc>
|
||||
<p>Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMinValue:</sel>
|
||||
<arg type="double">aDouble</arg>
|
||||
<desc>
|
||||
<p>Sets the minimum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setNumberOfTickMarks:</sel>
|
||||
<arg type="int">numberOfTickMarks</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTickMarkPosition:</sel>
|
||||
<arg type="NSTickMarkPosition">position</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitle:</sel>
|
||||
<arg type="NSString*">title</arg>
|
||||
<desc>
|
||||
<p>Sets the title of the slider to <var>barTitle</var>. This title is displayed
|
||||
on the slider's track, behind the knob.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleCell:</sel>
|
||||
<arg type="NSCell*">aCell</arg>
|
||||
<desc>
|
||||
<p>Sets the cell used to draw the title to <var>titleCell</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleColor:</sel>
|
||||
<arg type="NSColor*">color</arg>
|
||||
<desc>
|
||||
<p>Sets the colour with which the title will be drawn to <var>color</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTitleFont:</sel>
|
||||
<arg type="NSFont*">font</arg>
|
||||
<desc>
|
||||
<p>Sets the font with which the title will be drawm to <var>font</var>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSTickMarkPosition">
|
||||
<sel>tickMarkPosition</sel>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="double">
|
||||
<sel>tickMarkValueAtIndex:</sel>
|
||||
<arg type="int">index</arg>
|
||||
<desc>
|
||||
<p>As of yet, unimplemented.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSString*">
|
||||
<sel>title</sel>
|
||||
<desc>
|
||||
<p>Returns the title of the slider as an <code>NSString</code>.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="id">
|
||||
<sel>titleCell</sel>
|
||||
<desc>
|
||||
<p>Returns the cell used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSColor*">
|
||||
<sel>titleColor</sel>
|
||||
<desc>
|
||||
<p>Returns the colour used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSFont*">
|
||||
<sel>titleFont</sel>
|
||||
<desc>
|
||||
<p>Returns the font used to draw the title.</p>
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSRect">
|
||||
<sel>trackRect</sel>
|
||||
<desc>
|
||||
<p>Returns the rect of the track, minus the bezel.</p>
|
||||
</desc>
|
||||
</method>
|
||||
</class>
|
||||
|
|
|
|||
|
|
@ -10,9 +10,11 @@
|
|||
<dl>
|
||||
<dt><a href="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
|
||||
<dd>
|
||||
<dt>James Dessart
|
||||
<dd>
|
||||
</dl>
|
||||
<p>Version: 0.1</p>
|
||||
<p>Date: 28 February, 2000</p>
|
||||
<p>Version: 0.2</p>
|
||||
<p>Date: 11 March, 2000</p>
|
||||
<h2><a name="cont-0">NSSliderCell</a></h2>
|
||||
<h2><a name="NSSliderCell">NSSliderCell</a></h2>
|
||||
<p><b>Declared in:</b> AppKit/NSSliderCell.h</p>
|
||||
|
|
@ -21,6 +23,23 @@
|
|||
</p>
|
||||
<hr>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
An NSSliderCell controls the behaviour and appearance of an associated NSSlider,
|
||||
or a single slider in an NSMatrix. Tick marks are defined in the official
|
||||
standard, but are not implemented in GNUstep.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
An NSSliderCell can be customized through its <code>set...</code> methods.
|
||||
If these do not provide enough customization, a subclass can be created, which
|
||||
overrides any of the follwing methods: <code>knobRectFlipped:</code>,
|
||||
<code>drawBarInside:flipped:</code>, <code>drawKnob:</code>,
|
||||
or <code>prefersTrackingUntilMouseUp</code>.</p>
|
||||
|
||||
|
||||
<ul>
|
||||
<li><a href="NSSliderCell.html#method-0">+prefersTrackingUntilMouseUp</a>
|
||||
|
|
@ -61,166 +80,362 @@
|
|||
<h2><a name="method-0">prefersTrackingUntilMouseUp</a></h2>
|
||||
+ (BOOL) <b>prefersTrackingUntilMouseUp</b><br>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
The default implementation returns <code>YES</code>, so that the slider
|
||||
continues to track the user's movement even if the cursor leaves the slider's
|
||||
track.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Do not call this method directly. Override it in subclasses where the tracking
|
||||
behaviour needs to be different.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-1">allowsTickMarkValuesOnly</a></h2>
|
||||
- (BOOL) <b>allowsTickMarkValuesOnly</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-2">altIncrementValue</a></h2>
|
||||
- (double) <b>altIncrementValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the value by which the slider is incremented when the user holds down
|
||||
the ALT key.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-3">closestTickMarkValueToValue:</a></h2>
|
||||
- (double) <b>closestTickMarkValueToValue:</b> (double)aValue<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-4">drawBarInside:flipped:</a></h2>
|
||||
- (void) <b>drawBarInside:</b> (NSRect)aRect <b>flipped:</b> (BOOL)flipped<br>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Draws the slider's track, not including the bezel, in <var>aRect</var></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
<var>flipped</var> indicates whether the control view has a flipped
|
||||
coordinate system.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Do not call this method directly, it is provided for subclassing only.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-5">drawKnob</a></h2>
|
||||
- (void) <b>drawKnob</b><br>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Calculates the rect in which to draw the knob, then calls <code>drawKnob</code>
|
||||
Before calling this method, a <code>lockFocus</code> message must be sent to the
|
||||
cell's control view.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
When subclassing NSSliderCell, do not override this method. Override
|
||||
<code>drawKnob:</code> instead.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-6">drawKnob:</a></h2>
|
||||
- (void) <b>drawKnob:</b> (NSRect)knobRect<br>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Draws the knob in <var>knobRect</var>. Before calling this method, a
|
||||
<code>lockFocus</code> message must be sent to the cell's control view.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Do not call this method directly. It is included for subclassing only.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-7">indexOfTickMarkAtPoint:</a></h2>
|
||||
- (int) <b>indexOfTickMarkAtPoint:</b> (NSPoint)point<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-8">isVertical</a></h2>
|
||||
- (int) <b>isVertical</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns whether or not the slider is vertical. If, for some reason, this cannot
|
||||
be determined, for such reasons as the slider is not yet displayed, this method
|
||||
returns -1. Generally, a slider is considered vertical if its height is greater
|
||||
than its width.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-9">knobRectFlipped:</a></h2>
|
||||
- (NSRect) <b>knobRectFlipped:</b> (BOOL)flipped<br>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Returns the rect in which to draw the knob, based on the coordinate system
|
||||
of the NSSlider or NSMatrix this NSSliderCell is associated with.
|
||||
<var>flipped</var> indicates whether or not that coordinate system is flipped,
|
||||
which can be determined by sending the <code>isFlipped</code> message to the
|
||||
associated NSSlider or NSMatrix.</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
Do not call this method directly. It is included for subclassing only.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-10">knobThickness</a></h2>
|
||||
- (float) <b>knobThickness</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the thickness of the slider's knob. This value is in pixels, and is the
|
||||
size of the knob along the slider's track.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-11">maxValue</a></h2>
|
||||
- (double) <b>maxValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the maximum value that the slider represents.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-12">minValue</a></h2>
|
||||
- (double) <b>minValue</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the minimum value that the slider represents.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-13">numberOfTickMarks</a></h2>
|
||||
- (int) <b>numberOfTickMarks</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-14">rectOfTickMarkAtIndex:</a></h2>
|
||||
- (NSRect) <b>rectOfTickMarkAtIndex:</b> (int)index<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-15">setAllowsTickMarkValuesOnly:</a></h2>
|
||||
- (void) <b>setAllowsTickMarkValuesOnly:</b> (BOOL)flag<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-16">setAltIncrementValue:</a></h2>
|
||||
- (void) <b>setAltIncrementValue:</b> (double)increment<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the value by which the slider will be be incremented when with the
|
||||
ALT key down to <var>increment</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-17">setKnobThickness:</a></h2>
|
||||
- (void) <b>setKnobThickness:</b> (float)thickness<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
|
||||
sets the amount of space which the knob takes up in the slider's track.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-18">setMaxValue:</a></h2>
|
||||
- (void) <b>setMaxValue:</b> (double)aDouble<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-19">setMinValue:</a></h2>
|
||||
- (void) <b>setMinValue:</b> (double)aDouble<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the minimum value that the sliders represents to <var>maxValue</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-20">setNumberOfTickMarks:</a></h2>
|
||||
- (void) <b>setNumberOfTickMarks:</b> (int)numberOfTickMarks<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-21">setTickMarkPosition:</a></h2>
|
||||
- (void) <b>setTickMarkPosition:</b> (NSTickMarkPosition)position<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-22">setTitle:</a></h2>
|
||||
- (void) <b>setTitle:</b> (NSString*)title<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the title of the slider to <var>barTitle</var>. This title is displayed
|
||||
on the slider's track, behind the knob.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-23">setTitleCell:</a></h2>
|
||||
- (void) <b>setTitleCell:</b> (NSCell*)aCell<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the cell used to draw the title to <var>titleCell</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-24">setTitleColor:</a></h2>
|
||||
- (void) <b>setTitleColor:</b> (NSColor*)color<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the colour with which the title will be drawn to <var>color</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-25">setTitleFont:</a></h2>
|
||||
- (void) <b>setTitleFont:</b> (NSFont*)font<br>
|
||||
|
||||
|
||||
<p>
|
||||
Sets the font with which the title will be drawm to <var>font</var>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-26">tickMarkPosition</a></h2>
|
||||
- (NSTickMarkPosition) <b>tickMarkPosition</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-27">tickMarkValueAtIndex:</a></h2>
|
||||
- (double) <b>tickMarkValueAtIndex:</b> (int)index<br>
|
||||
|
||||
|
||||
<p>
|
||||
As of yet, unimplemented.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-28">title</a></h2>
|
||||
- (NSString*) <b>title</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the title of the slider as an <code>NSString</code>.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-29">titleCell</a></h2>
|
||||
- (id) <b>titleCell</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the cell used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-30">titleColor</a></h2>
|
||||
- (NSColor*) <b>titleColor</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the colour used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-31">titleFont</a></h2>
|
||||
- (NSFont*) <b>titleFont</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the font used to draw the title.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
<h2><a name="method-32">trackRect</a></h2>
|
||||
- (NSRect) <b>trackRect</b><br>
|
||||
|
||||
|
||||
<p>
|
||||
Returns the rect of the track, minus the bezel.</p>
|
||||
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Reference in a new issue