mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-26 15:10:55 +00:00
04a3436aff
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@11341 72102866-910b-0410-8b05-ffd578937521
261 lines
9.7 KiB
HTML
261 lines
9.7 KiB
HTML
<html><head>
|
|
<title>NSTableColumn</title>
|
|
</head>
|
|
<body>
|
|
<a href ="NSTabViewItem.html">[Previous] </a>
|
|
<a href ="Gui.html">[Up] </a>
|
|
<a href ="NSTableHeaderCell.html">[Next] </a>
|
|
<h1>NSTableColumn</h1>
|
|
<h3>Authors </h3>
|
|
<dl>
|
|
<dt><a href ="http://www.gnustep.org/developers/whoiswho.html">Nicola Pero</a>
|
|
<dd>
|
|
</dl>
|
|
<p>Version: $Revision$</p>
|
|
<p>Date: $Date$</p>
|
|
<h2><a name ="cont-0">Description of NSTableColumn</a></h2>
|
|
<p>
|
|
|
|
NSTableColumn objects represent columns in NSTableViews.
|
|
</p>
|
|
<h3><a name ="cont-1">The Column Identifier</a></h3>
|
|
<p>
|
|
|
|
Each NSTableColumn object is identified by an object, called
|
|
the column identifier. The reason is that, after a column has been
|
|
added to a table view, the user might move the columns around, so
|
|
there is a need to identify the columns regardless of their position
|
|
in the table.
|
|
</p>
|
|
<p>
|
|
|
|
The identifier is typically a string describing the column.
|
|
This identifier object is never displayed to the user !
|
|
It is only used internally by the program to identify
|
|
the column - so yes, you may use a funny string for it
|
|
and nobody will know, except people reading the code.
|
|
</p>
|
|
<h3><a name ="cont-2">Information Stored in an NSTableColumn Object</a></h3>
|
|
<p>
|
|
|
|
An NSTableColumn object mainly keeps information about the width
|
|
of the column, its minimum and maximum width; whether the column
|
|
can be edited or resized; and the cells used to draw the column
|
|
header and the data in the column. You can change all these
|
|
attributes of the column by calling the appropriate methods.
|
|
Please note that the table column does not hold nor has access
|
|
to the data to be displayed in the column; this data is maintained
|
|
in the table view's data source, as described in the NSTableView
|
|
documentation. A last hint: to set the title of a table column,
|
|
ask the table column for its header cell, and set the string value
|
|
of this header cell to the desired title.
|
|
</p>
|
|
<h2><a name ="cont-3">NSTableColumn Reference</a></h2>
|
|
<h2><a name ="NSTableColumn">NSTableColumn</a></h2>
|
|
<p><b>Declared in: </b> Gui/NSTableColumn.h</p>
|
|
<p><b>Inherits from: </b> NSObject</p>
|
|
<p><b>Conforms to: </b> NSObject
|
|
</p>
|
|
<hr>
|
|
|
|
<p>
|
|
|
|
NSTableColumn objects represent columns in NSTableViews.
|
|
</p>
|
|
|
|
|
|
<h2>Instance Variables </h2>
|
|
<ul>
|
|
</ul>
|
|
<h2>Methods </h2>
|
|
<ul>
|
|
<li ><a href ="NSTableColumn.html#method-0">-dataCell</a>
|
|
<li ><a href ="NSTableColumn.html#method-1">-headerCell</a>
|
|
<li ><a href ="NSTableColumn.html#method-3">-identifier</a>
|
|
<li ><a href ="NSTableColumn.html#method-2">-initWithIdentifier:</a>
|
|
<li ><a href ="NSTableColumn.html#method-4">-isEditable</a>
|
|
<li ><a href ="NSTableColumn.html#method-5">-isResizable</a>
|
|
<li ><a href ="NSTableColumn.html#method-6">-maxWidth</a>
|
|
<li ><a href ="NSTableColumn.html#method-7">-minWidth</a>
|
|
<li ><a href ="NSTableColumn.html#method-8">-setDataCell:</a>
|
|
<li ><a href ="NSTableColumn.html#method-9">-setEditable:</a>
|
|
<li ><a href ="NSTableColumn.html#method-10">-setHeaderCell:</a>
|
|
<li ><a href ="NSTableColumn.html#method-11">-setIdentifier:</a>
|
|
<li ><a href ="NSTableColumn.html#method-12">-setMaxWidth:</a>
|
|
<li ><a href ="NSTableColumn.html#method-13">-setMinWidth:</a>
|
|
<li ><a href ="NSTableColumn.html#method-14">-setResizable:</a>
|
|
<li ><a href ="NSTableColumn.html#method-15">-setTableView:</a>
|
|
<li ><a href ="NSTableColumn.html#method-16">-setWidth:</a>
|
|
<li ><a href ="NSTableColumn.html#method-17">-sizeToFit</a>
|
|
<li ><a href ="NSTableColumn.html#method-18">-tableView</a>
|
|
<li ><a href ="NSTableColumn.html#method-19">-width</a>
|
|
</ul>
|
|
<hr><h2>Instances Methods </h2>
|
|
<h3><a name ="method-0">dataCell</a></h3>
|
|
- (id) <b>dataCell</b>;<br>
|
|
|
|
Return the cell used to display data in the column. The default
|
|
data cell is an NSTextFieldCell.
|
|
|
|
<hr>
|
|
<h3><a name ="method-1">headerCell</a></h3>
|
|
- (id) <b>headerCell</b>;<br>
|
|
|
|
Return the cell used to display the column title. The default
|
|
header cell is an NSTableHeaderCell.
|
|
|
|
<hr>
|
|
<h3><a name ="method-2">initWithIdentifier:</a></h3>
|
|
- (id) <b>initWithIdentifier:</b> anObject;<br>
|
|
|
|
Initialize the column. anObject is an object used to identify
|
|
the column; it is usually a string, but might be any kind of object.
|
|
anObject is retained.
|
|
|
|
<hr>
|
|
<h3><a name ="method-3">identifier</a></h3>
|
|
- (id) <b>identifier</b>;<br>
|
|
|
|
Return the column identifier, an object used to identify the column.
|
|
This object is usually a string, but might be any kind of object.
|
|
|
|
<hr>
|
|
<h3><a name ="method-4">isEditable</a></h3>
|
|
- (BOOL) <b>isEditable</b>;<br>
|
|
|
|
Return whether data displayed in the column can be edited
|
|
by the user by double-cliking on them.
|
|
|
|
<hr>
|
|
<h3><a name ="method-5">isResizable</a></h3>
|
|
- (BOOL) <b>isResizable</b>;<br>
|
|
|
|
Return whether the column might be resized by the user by dragging
|
|
the column header border.
|
|
|
|
<hr>
|
|
<h3><a name ="method-6">maxWidth</a></h3>
|
|
- (float) <b>maxWidth</b>;<br>
|
|
|
|
Return the column's max width. The column can in no way be resized
|
|
to a width bigger than this max width. The default max width is
|
|
100000.
|
|
|
|
<hr>
|
|
<h3><a name ="method-7">minWidth</a></h3>
|
|
- (float) <b>minWidth</b>;<br>
|
|
|
|
Return the column's min width. The column can in no way be resized
|
|
to a width smaller than this min width. The default min width is
|
|
zero.
|
|
|
|
<hr>
|
|
<h3><a name ="method-8">setDataCell:</a></h3>
|
|
- (void) <b>setDataCell:</b> (NSCell*)aCell;<br>
|
|
|
|
Set the cell used to display data in the column. aCell can't be nil,
|
|
otherwise a warning will be generated and the method ignored. The old
|
|
cell is released, the new one is retained.
|
|
If you want to change the attributes in which a single row in a column
|
|
is displayed, you should better use a delegate for your
|
|
NSTableView implementing tableView:willDisplayCell:forTableColumn:row:.
|
|
|
|
<hr>
|
|
<h3><a name ="method-9">setEditable:</a></h3>
|
|
- (void) <b>setEditable:</b> (BOOL)flag;<br>
|
|
|
|
Set whether data in the column might be edited by the user by
|
|
double-cliking on them.
|
|
|
|
<hr>
|
|
<h3><a name ="method-10">setHeaderCell:</a></h3>
|
|
- (void) <b>setHeaderCell:</b> (NSCell*)aCell;<br>
|
|
|
|
Set the cell used to display the column header. aCell can't be nil,
|
|
otherwise a warning will be generated and the method call ignored.
|
|
The old cell is released, the new one is retained.
|
|
|
|
<hr>
|
|
<h3><a name ="method-11">setIdentifier:</a></h3>
|
|
- (void) <b>setIdentifier:</b> (id)anObject;<br>
|
|
|
|
Set the identifier used to identify the table. The old identifier
|
|
is released, and the new one is retained.
|
|
|
|
<hr>
|
|
<h3><a name ="method-12">setMaxWidth:</a></h3>
|
|
- (void) <b>setMaxWidth:</b> (float)maxWidth;<br>
|
|
|
|
Set the max width of the table column, eventually adjusting
|
|
the width of the column if it is bigger than the new max width.
|
|
In no way a table column can be made bigger than its max width.
|
|
|
|
<hr>
|
|
<h3><a name ="method-13">setMinWidth:</a></h3>
|
|
- (void) <b>setMinWidth:</b> (float)minWidth;<br>
|
|
|
|
Set the min width of the table column, eventually adjusting
|
|
the width of the column if it is smaller than the new min width.
|
|
In no way a table column can be made smaller than its min width.
|
|
|
|
<hr>
|
|
<h3><a name ="method-14">setResizable:</a></h3>
|
|
- (void) <b>setResizable:</b> (BOOL)flag;<br>
|
|
|
|
Set whether the user can resize the table column by dragging the
|
|
border of its header with the mouse. The table column can be
|
|
resized programmatically regardless of this setting.
|
|
|
|
<hr>
|
|
<h3><a name ="method-15">setTableView:</a></h3>
|
|
- (void) <b>setTableView:</b> (NSTableView*)aTableView;<br>
|
|
|
|
Set the table view corresponding to this table column.
|
|
This method is invoked internally by the table view, and you should
|
|
not call it directly; it is exposed because you may want to override
|
|
it in subclasses. To use the table column in a table view, you should
|
|
use NSTableView's addTableColumn: instead.
|
|
|
|
<hr>
|
|
<h3><a name ="method-16">setWidth:</a></h3>
|
|
- (void) <b>setWidth:</b> (float)newWidth;<br>
|
|
|
|
Set the width of the table column. Before being resized, the new
|
|
width is constrained to the table column minimum and maximum width:
|
|
if newWidth is smaller than the table column's min width,
|
|
the table column is simply resized to its min width. If newWidth
|
|
is bigger than the table column's max width, the table column
|
|
is simply resized to its max width. Otherwise, it is resized
|
|
to newWidth. If the width of the table was actually changed,
|
|
the table view (if any) is redisplayed (by calling tile), and
|
|
the NSTableViewColumnDidResizeNotification is posted on behalf
|
|
of the table view.
|
|
|
|
<hr>
|
|
<h3><a name ="method-17">sizeToFit</a></h3>
|
|
- (void) <b>sizeToFit</b>;<br>
|
|
|
|
Change the width of the column to be just enough to display its
|
|
header; change the minimum width and maximum width to allow
|
|
the column to have this width (if the minimum width is bigger
|
|
than the column header width, it is reduced to it; if the maximum
|
|
width is smaller than the column header width, it is increased
|
|
to it).
|
|
|
|
<hr>
|
|
<h3><a name ="method-18">tableView</a></h3>
|
|
- (NSTableView*) <b>tableView</b>;<br>
|
|
|
|
Return the table view the column belongs to, or nil if
|
|
the table column was not added to any table view.
|
|
|
|
<hr>
|
|
<h3><a name ="method-19">width</a></h3>
|
|
- (float) <b>width</b>;<br>
|
|
|
|
Return the width of the table column.
|
|
|
|
<hr>
|
|
</body>
|
|
|
|
</html>
|