gnustep/libs-gui
0
0
Fork 0
mirror of https://github.com/gnustep/libs-gui.git synced 2025-04-26 03:41:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
libs-gui/Documentation/gsdoc/NSSlider.html
Adam Fedor 05bdcda840 Updated docs 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@12233 72102866-910b-0410-8b05-ffd578937521
2002-01-28 04:50:14 +00:00

421 lines
17 KiB
HTML
Raw Blame History

<html>
<head>
<title>NSSlider</title>
</head>
<body>
<a href="Gui.html">Up</a>
<br />
<h1><a name="title$NSSlider">NSSlider</a></h1>
<h3>Authors</h3>
<dl>
<dt>Ovidiu Predescu(<a href="mailto:ovidiu@net-community.com"><code>
ovidiu@net-community.com
</code></a>)</dt>
<dd>
</dd>
<dt>Felipe A. Rodriguez(<a href="mailto:far@ix.netcom.com"><code>
far@ix.netcom.com
</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1996 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Class Description</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">Class Description</a></h1>
<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>
This control is a continuous control. It sends its action
message as long as the user is manipulating it. This
can be changed by passing <code>NO</code> to the
<code>setContinuous:</code> message of a given NSSlider.
</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>
<h2><a name="class$NSSlider">NSSlider</a> : <a rel="gsdoc" href="NSControl.html#class$NSControl">NSControl</a></h2>
<blockquote>
<dl>
<dt><b>Declared in:</b></dt>
<dd>AppKit/NSSlider.h</dd>
</dl>
</blockquote>
<blockquote>
<b>Standards:</b>
<ul>
<li>GNUstep</li>
<li>MacOS-X</li>
<li>OpenStep</li>
</ul>
</blockquote>
<p>
</p>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-acceptsFirstMouse:">-acceptsFirstMouse:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-allowsTickMarkValuesOnly">-allowsTickMarkValuesOnly</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-altIncrementValue">-altIncrementValue</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-closestTickMarkValueToValue:">-closestTickMarkValueToValue:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-image">-image</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-indexOfTickMarkAtPoint:">-indexOfTickMarkAtPoint:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-isVertical">-isVertical</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-knobThickness">-knobThickness</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-maxValue">-maxValue</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-minValue">-minValue</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-numberOfTickMarks">-numberOfTickMarks</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-rectOfTickMarkAtIndex:">-rectOfTickMarkAtIndex:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setAllowsTickMarkValuesOnly:">-setAllowsTickMarkValuesOnly:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setAltIncrementValue:">-setAltIncrementValue:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setImage:">-setImage:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setKnobThickness:">-setKnobThickness:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setMaxValue:">-setMaxValue:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setMinValue:">-setMinValue:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setNumberOfTickMarks:">-setNumberOfTickMarks:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setTickMarkPosition:">-setTickMarkPosition:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setTitle:">-setTitle:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setTitleCell:">-setTitleCell:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setTitleColor:">-setTitleColor:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-setTitleFont:">-setTitleFont:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-tickMarkPosition">-tickMarkPosition</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-tickMarkValueAtIndex:">-tickMarkValueAtIndex:</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-title">-title</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-titleCell">-titleCell</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-titleColor">-titleColor</a></li>
<li><a rel="gsdoc" href="NSSlider.html#method$NSSlider-titleFont">-titleFont</a></li>
</ul>
<hr width="50%" align="left" />
<h3><a name="method$NSSlider-acceptsFirstMouse:">acceptsFirstMouse:</a></h3>
- (BOOL) <b>acceptsFirstMouse:</b> (<a rel="gsdoc" href="NSEvent.html#class$NSEvent">NSEvent</a>*)theEvent;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<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 width="25%" align="left" />
<h3><a name="method$NSSlider-allowsTickMarkValuesOnly">allowsTickMarkValuesOnly</a></h3>
- (BOOL) <b>allowsTickMarkValuesOnly</b>;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-altIncrementValue">altIncrementValue</a></h3>
- (double) <b>altIncrementValue</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the value by which the slider will be
incremented if the user holds down the ALT key.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-closestTickMarkValueToValue:">closestTickMarkValueToValue:</a></h3>
- (double) <b>closestTickMarkValueToValue:</b> (double)aValue;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-image">image</a></h3>
- (<a rel="gsdoc" href="NSImage.html#class$NSImage">NSImage</a>*) <b>image</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the image drawn in the slider's track.
Returns <code>nil</code> if this has not been set.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-indexOfTickMarkAtPoint:">indexOfTickMarkAtPoint:</a></h3>
- (int) <b>indexOfTickMarkAtPoint:</b> (NSPoint)point;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-isVertical">isVertical</a></h3>
- (int) <b>isVertical</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<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 width="25%" align="left" />
<h3><a name="method$NSSlider-knobThickness">knobThickness</a></h3>
- (float) <b>knobThickness</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<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 width="25%" align="left" />
<h3><a name="method$NSSlider-maxValue">maxValue</a></h3>
- (double) <b>maxValue</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the maximum value that the slider
represents.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-minValue">minValue</a></h3>
- (double) <b>minValue</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the minimum value that the slider
represents.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-numberOfTickMarks">numberOfTickMarks</a></h3>
- (int) <b>numberOfTickMarks</b>;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-rectOfTickMarkAtIndex:">rectOfTickMarkAtIndex:</a></h3>
- (NSRect) <b>rectOfTickMarkAtIndex:</b> (int)index;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setAllowsTickMarkValuesOnly:">setAllowsTickMarkValuesOnly:</a></h3>
- (void) <b>setAllowsTickMarkValuesOnly:</b> (BOOL)flag;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setAltIncrementValue:">setAltIncrementValue:</a></h3>
- (void) <b>setAltIncrementValue:</b> (double)increment;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the value by which the slider will be
incremented, when the ALT key is held down, to
<var>increment</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setImage:">setImage:</a></h3>
- (void) <b>setImage:</b> (<a rel="gsdoc" href="NSImage.html#class$NSImage">NSImage</a>*)backgroundImage;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the image to be displayed in the slider's track
to <var>barImage</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setKnobThickness:">setKnobThickness:</a></h3>
- (void) <b>setKnobThickness:</b> (float)aFloat;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<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 width="25%" align="left" />
<h3><a name="method$NSSlider-setMaxValue:">setMaxValue:</a></h3>
- (void) <b>setMaxValue:</b> (double)aDouble;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the maximum value that the sliders represents to
<var>maxValue</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setMinValue:">setMinValue:</a></h3>
- (void) <b>setMinValue:</b> (double)aDouble;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the minimum value that the slider represents to
<var>minValue</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setNumberOfTickMarks:">setNumberOfTickMarks:</a></h3>
- (void) <b>setNumberOfTickMarks:</b> (int)numberOfTickMarks;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setTickMarkPosition:">setTickMarkPosition:</a></h3>
- (void) <b>setTickMarkPosition:</b> (NSTickMarkPosition)position;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setTitle:">setTitle:</a></h3>
- (void) <b>setTitle:</b> (<a rel="gsdoc" href="/usr/GNUstep-devel/System/Documentation/Base/NSString.html#class$NSString">NSString</a>*)aString;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<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 width="25%" align="left" />
<h3><a name="method$NSSlider-setTitleCell:">setTitleCell:</a></h3>
- (void) <b>setTitleCell:</b> (<a rel="gsdoc" href="NSCell.html#class$NSCell">NSCell</a>*)aCell;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the cell used to draw the title to
<var>titleCell</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setTitleColor:">setTitleColor:</a></h3>
- (void) <b>setTitleColor:</b> (<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>*)aColor;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the colour with which the title will be drawn to
<var>color</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-setTitleFont:">setTitleFont:</a></h3>
- (void) <b>setTitleFont:</b> (<a rel="gsdoc" href="NSFont.html#class$NSFont">NSFont</a>*)fontObject;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Sets the font with which the title will be drawm to
<var>font</var>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-tickMarkPosition">tickMarkPosition</a></h3>
- (NSTickMarkPosition) <b>tickMarkPosition</b>;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-tickMarkValueAtIndex:">tickMarkValueAtIndex:</a></h3>
- (double) <b>tickMarkValueAtIndex:</b> (int)index;<br />
<b>Standards:</b> NotOpenStep, GNUstep, MacOS-X<br />
<p>
<em>Description forthcoming.</em>
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-title">title</a></h3>
- (<a rel="gsdoc" href="/usr/GNUstep-devel/System/Documentation/Base/NSString.html#class$NSString">NSString</a>*) <b>title</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the title of the slider as an
<code>NSString</code>.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-titleCell">titleCell</a></h3>
- (id) <b>titleCell</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the cell used to draw the title.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-titleColor">titleColor</a></h3>
- (<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>*) <b>titleColor</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the colour used to draw the title.
</p>
<hr width="25%" align="left" />
<h3><a name="method$NSSlider-titleFont">titleFont</a></h3>
- (<a rel="gsdoc" href="NSFont.html#class$NSFont">NSFont</a>*) <b>titleFont</b>;<br />
<b>Standards:</b> GNUstep, MacOS-X, OpenStep<br />
<p>
Returns the font used to draw the title.
</p>
<hr width="25%" align="left" />
<br />
<a href="Gui.html">Up</a>
</body>
</html>
Reference in a new issue View git blame Copy permalink