Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/GNUstep/Documentation/Developer/Gui/Reference/
Upload File :
Current File : //usr/share/GNUstep/Documentation/Developer/Gui/Reference/NSColorList.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSColorList</title>
</head>
<body>
<font face="serif">
<a href="Gui.html">Up</a>
<br />
<h1><a name="title$NSColorList">NSColorList</a></h1>
<h3>Authors</h3>
<dl>
<dt>Scott Christley (<a href="mailto:scottc@net-community.com"><code>scottc@net-community.com</code></a>)</dt>
<dd>
</dd>
<dt>Nicola Pero (<a href="mailto:n.pero@mi.flashnet.it"><code>n.pero@mi.flashnet.it</code></a>)</dt>
<dd>
</dd>
</dl>
<blockquote>
Manage named lists of NSColors.
</blockquote>
<p><b>Copyright:</b> (C) 1996, 2000 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSColorList class
</a></h1>
<h2><a name="class$NSColorList">NSColorList</a> : <a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>AppKit/NSColorList.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSObject.html#protocol$(NSCoding)">NSCoding</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="50%" align="left" />
<a href="#_NSColorList_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList+availableColorLists">+availableColorLists</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList+colorListNamed$">+colorListNamed:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-allKeys">-allKeys</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-colorWithKey$">-colorWithKey:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-encodeWithCoder$">-encodeWithCoder:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-initWithCoder$">-initWithCoder:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-initWithName$">-initWithName:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-initWithName$fromFile$">-initWithName:fromFile:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-insertColor$key$atIndex$">-insertColor:key:atIndex:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-isEditable">-isEditable</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-name">-name</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-removeColorWithKey$">-removeColorWithKey:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-removeFile">-removeFile</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-setColor$forKey$">-setColor:forKey:</a></li>
<li><a rel="gsdoc" href="NSColorList.html#method$NSColorList-writeToFile$">-writeToFile:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSColorList+availableColorLists">availableColorLists </a></h3>
+ (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSArray.html#class$NSArray">NSArray</a>*) <b>availableColorLists</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList+colorListNamed$">colorListNamed: </a></h3>
+ (<a rel="gsdoc" href="#class$NSColorList">NSColorList</a>*) <b>colorListNamed:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)name;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the first color list (from the array of
available lists) matching <var>name</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-allKeys">allKeys </a></h3>
- (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSArray.html#class$NSArray">NSArray</a>*) <b>allKeys</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an array containing all the keyus in the
color list
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-colorWithKey$">colorWithKey: </a></h3>
- (<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>*) <b>colorWithKey:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the color for the specified <var>key</var>
(if any).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-encodeWithCoder$">encodeWithCoder: </a></h3>
- (void) <b>encodeWithCoder:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSCoder.html#class$NSCoder">NSCoder</a>*)aCoder;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-initWithCoder$">initWithCoder: </a></h3>
- (id) <b>initWithCoder:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSCoder.html#class$NSCoder">NSCoder</a>*)aDecoder;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-initWithName$">initWithName: </a></h3>
- (id) <b>initWithName:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)name;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initializes a new, empty color list registered
under given <var>name</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-initWithName$fromFile$">initWithName: fromFile: </a></h3>
- (id) <b>initWithName:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)name<b> fromFile:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)path;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Initializes a new color list registered under
given <var>name</var>, taking contents from the
file specified in <var>path</var>. (Path should
include the filename with extension (usually
".clr"), and by convention <var>name</var>
should be the same as filename <em>without</em>
the extension.)
</p>
<p>
</p>
<p>
The format of the file can be either an archive of an
NSColorList or an ASCII format. ASCII files
follow this format:
</p>
<p>
</p>
<p>
first line = [#/colors] <br /> each subsequent line
describes a color as [<strong>int</strong>
float+ string] <br /> the first
<strong>int</strong> describes the method (RGBA,
etc.), the floats provide its arguments (e.g., r,
g, b, alpha), and string is <var>name</var>.
</p>
<p>
</p>
<p>
The <em>method</em> corresponds to one of the
<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>
initializers. We are looking for
documentation of the exact correspondence
on OpenStep; for now the only supported method is
"0", which is an RGBA format with the arguments in
order R,G,B, A.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-insertColor$key$atIndex$">insertColor: key: atIndex: </a></h3>
- (void) <b>insertColor:</b> (<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>*)color<b> key:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)key<b> atIndex:</b> (unsigned)location;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Inserts a <var>color</var> into the
<var>color</var> list at the specified index. Removes
any other <var>color</var> with the same name.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-isEditable">isEditable </a></h3>
- (BOOL) <b>isEditable</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a flag indicating whether the receiver is
editable.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-name">name </a></h3>
- (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*) <b>name</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the name of the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-removeColorWithKey$">removeColorWithKey: </a></h3>
- (void) <b>removeColorWithKey:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes the color for the specified <var>key</var>
from the list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-removeFile">removeFile </a></h3>
- (void) <b>removeFile</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes the on-disk representation of the list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-setColor$forKey$">setColor: forKey: </a></h3>
- (void) <b>setColor:</b> (<a rel="gsdoc" href="NSColor.html#class$NSColor">NSColor</a>*)aColor<b> forKey:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets the color for this <var>key</var> and appends it
to the color list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSColorList-writeToFile$">writeToFile: </a></h3>
- (BOOL) <b>writeToFile:</b> (<a rel="gsdoc" href="/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSString.html#class$NSString">NSString</a>*)path;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Writes the receiver to the specified <var>path</var>
. <br /> If <var>path</var> is <code>nil</code>, writes
to a file located in the current user's personal Colors
directory whose name is that of the list with the
extension 'clr' appended. <br /> If
<var>path</var> is a directory, writes to a file in
that directory whose name is that of the list with the
extension 'clr' appended. <br /> Otherwise (
<var>path</var> is neither <code>nil</code> nor a
directory), writes to the <var>path</var>
without appending the l.ist name. <br /> Returns
<code>YES</code> on success, <code>NO</code> on
failure. <br /> Writing with a <var>path</var> of
<code>nil</code> will cause the receiver to be added
to the
<a rel="gsdoc" href="#method$NSColorList+availableColorLists">
+availableColorLists
</a>
if it is not already there.
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSColorList_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSColorList Class</h2>
<h3><a name="ivariable$NSColorList*_colorDictionary">_colorDictionary</a></h3>
@protected NSMutableDictionary* <b>_colorDictionary</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSColorList*_fullFileName">_fullFileName</a></h3>
@protected NSString* <b>_fullFileName</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSColorList*_is_editable">_is_editable</a></h3>
@protected BOOL <b>_is_editable</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSColorList*_name">_name</a></h3>
@protected NSString* <b>_name</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSColorList*_orderedColorKeys">_orderedColorKeys</a></h3>
@protected NSMutableArray* <b>_orderedColorKeys</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="Gui.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)