mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-23 07:00:46 +00:00
Documented
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@8186 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Nicola Pero
parent
81afdbf4aa
commit
72cdf54589
1 changed files with 118 additions and 7 deletions
|
|
@ -1,131 +1,242 @@
|
|||
<?xml version="1.0"?>
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.5//EN" "http://www.gnustep.org/gsdoc-0_6_5.xml">
|
||||
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
|
||||
<gsdoc base="NSTableColumn" prev="NSTabViewItem.html" next="NSTableHeaderCell.html" up="Gui.html">
|
||||
<head>
|
||||
<title>NSTableColumn</title>
|
||||
<author name="Richard Frith-Macdonald">
|
||||
<email address="rfm@gnu.org"/>
|
||||
<author name="Nicola Pero">
|
||||
<email address="n.pero@mi.flashnet.it"/>
|
||||
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
|
||||
</author>
|
||||
<version>0.1</version>
|
||||
<date>28 February, 2000</date>
|
||||
<version>1.0</version>
|
||||
<date>10 September, 2000</date>
|
||||
</head>
|
||||
<body>
|
||||
<!-- All the following description should better go into NSTableColumn's <desc> -->
|
||||
<!-- but it can't be done because gsdoc does not allow <p> and <section> inside <desc>. -->
|
||||
<chapter>
|
||||
<heading>NSTableColumn</heading>
|
||||
<heading>Description of NSTableColumn</heading>
|
||||
<p>
|
||||
NSTableColumn objects represent columns in NSTableViews.
|
||||
</p>
|
||||
<section>
|
||||
<heading>The Column Identifier</heading>
|
||||
<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>
|
||||
</section>
|
||||
<section>
|
||||
<heading>Information Stored in an NSTableColumn Object</heading>
|
||||
<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>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<heading>NSTableColumn Reference</heading>
|
||||
<class name="NSTableColumn" super="NSObject">
|
||||
<declared>Gui/NSTableColumn.h</declared>
|
||||
<conform>NSObject</conform>
|
||||
<desc>
|
||||
<p>
|
||||
NSTableColumn objects represent columns in NSTableViews.
|
||||
</p>
|
||||
</desc>
|
||||
|
||||
<method type="id">
|
||||
<sel>dataCell</sel>
|
||||
<desc>
|
||||
Return the cell used to display data in the column. The default
|
||||
data cell is an NSTextFieldCell.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="id">
|
||||
<sel>headerCell</sel>
|
||||
<desc>
|
||||
Return the cell used to display the column title. The default
|
||||
header cell is an NSTableHeaderCell.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="id">
|
||||
<sel>initWithIdentifier:</sel>
|
||||
<arg>anObject</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="id">
|
||||
<sel>identifier</sel>
|
||||
<desc>
|
||||
Return the column identifier, an object used to identify the column.
|
||||
This object is usually a string, but might be any kind of object.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="BOOL">
|
||||
<sel>isEditable</sel>
|
||||
<desc>
|
||||
</desc>
|
||||
Return whether data displayed in the column can be edited
|
||||
by the user by double-cliking on them.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="BOOL">
|
||||
<sel>isResizable</sel>
|
||||
<desc>
|
||||
Return whether the column might be resized by the user by dragging
|
||||
the column header border.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="float">
|
||||
<sel>maxWidth</sel>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="float">
|
||||
<sel>minWidth</sel>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setDataCell:</sel>
|
||||
<arg type="NSCell*">aCell</arg>
|
||||
<desc>
|
||||
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:.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setEditable:</sel>
|
||||
<arg type="BOOL">flag</arg>
|
||||
<desc>
|
||||
Set whether data in the column might be edited by the user by
|
||||
double-cliking on them.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setHeaderCell:</sel>
|
||||
<arg type="NSCell*">aCell</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setIdentifier:</sel>
|
||||
<arg type="id">anObject</arg>
|
||||
<desc>
|
||||
Set the identifier used to identify the table. The old identifier
|
||||
is released, and the new one is retained.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMaxWidth:</sel>
|
||||
<arg type="float">maxWidth</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setMinWidth:</sel>
|
||||
<arg type="float">minWidth</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setResizable:</sel>
|
||||
<arg type="BOOL">flag</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setTableView:</sel>
|
||||
<arg type="NSTableView*">aTableView</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>setWidth:</sel>
|
||||
<arg type="float">newWidth</arg>
|
||||
<desc>
|
||||
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.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="void">
|
||||
<sel>sizeToFit</sel>
|
||||
<desc>
|
||||
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).
|
||||
</desc>
|
||||
</method>
|
||||
<method type="NSTableView*">
|
||||
<sel>tableView</sel>
|
||||
<desc>
|
||||
Return the table view the column belongs to, or nil if
|
||||
the table column was not added to any table view.
|
||||
</desc>
|
||||
</method>
|
||||
<method type="float">
|
||||
<sel>width</sel>
|
||||
<desc>
|
||||
Return the width of the table column.
|
||||
</desc>
|
||||
</method>
|
||||
</class>
|
||||
|
|
|
|||
Loading…
Reference in a new issue