Up
Authors
- Gregory John Casamento (
greg_casamento@yahoo.com
)
-
This class is a subclass of NSTableView which provides the user with a way to display tree structured data in an outline format. It is particularly useful for show hierarchical data such as a class inheritance tree or any other set of relationships.
Copyright: (C) 2001 Free Software Foundation, Inc.
- Declared in:
- AppKit/NSOutlineView.h
Availability: OpenStep
Description forthcoming.
Instance Variables
Method summary
- (BOOL)
autoResizesOutlineColumn;
Availability: OpenStep
Causes the outline column, the column containing the expand/collapse gadget, to resize based on the amount of space needed by widest content.
- (BOOL)
autosaveExpandedItems;
Availability: OpenStep
Causes the outline column, the column containing the expand/collapse gadget, to resize based on the amount of space needed by widest content.
- (void)
collapseItem: (id)item;
Availability: OpenStep
- (void)
collapseItem: (id)item
collapseChildren: (BOOL)collapseChildren;
Availability: OpenStep
Collapses the specified item. If collapseChildren is set to YES
, then all of the expandable children of this item all also collapsed in a recursive fashion (i.e. all children, grandchildren and etc).
- (void)
expandItem: (id)item;
Availability: OpenStep
- (void)
expandItem: (id)item
expandChildren: (BOOL)expandChildren;
Availability: OpenStep
Expands the specified item. If expandChildren is set to YES
, then all of the expandable children of this item all also expanded in a recursive fashion (i.e. all children, grandchildren and etc).
- (BOOL)
indentationMarkerFollowsCell;
Availability: OpenStep
Returns whether or not the indentation marker or "knob" is indented along with the content inside the cell.
- (float)
indentationPerLevel;
Availability: OpenStep
Returns the amount of indentation, in points, for each level of the tree represented by the outline view.
- (BOOL)
isExpandable: (id)item;
Availability: OpenStep
Returns YES
, if the item is able to be expanded, NO
otherwise.
- (BOOL)
isItemExpanded: (id)item;
Availability: OpenStep
Returns YES
if the item is expanded or open, NO
otherwise.
- (id)
itemAtRow: (int)row;
Availability: OpenStep
Returns the item at a given row.
- (int)
levelForItem: (id)item;
Availability: OpenStep
Returns the level for a given item.
- (int)
levelForRow: (int)row;
Availability: OpenStep
Returns the level for the given row.
- (
NSTableColumn*)
outlineTableColumn;
Availability: OpenStep
Returns the outline table column.
- (void)
reloadItem: (id)item;
Availability: OpenStep
- (void)
reloadItem: (id)item
reloadChildren: (BOOL)reloadChildren;
Availability: OpenStep
Causes an item and all of it's children to be reloaded if reloadChildren is set to YES
, if it's set to NO
, then only the item itself is refreshed from the datasource.
- (int)
rowForItem: (id)item;
Availability: OpenStep
Returns the corresponding row in the outline view for the given item. Returns -1 if item is nil
or not found.
- (void)
setAutoresizesOutlineColumn: (BOOL)resize;
Availability: OpenStep
When set to YES
this causes the outline column, the column containing the expand/collapse gadget, to resize based on the amount of space needed by widest content.
- (void)
setAutosaveExpandedItems: (BOOL)flag;
Availability: OpenStep
When set to YES
, the outline view will save the state of all expanded or collapsed items in the view to the users defaults for the application the outline view is running in.
- (void)
setDropItem: (id)item
dropChildIndex: (int)childIndex;
Availability: OpenStep
Description forthcoming.
- (void)
setIndentationMarkerFollowsCell: (BOOL)followsCell;
Availability: OpenStep
If set to YES
, the indentation marker will follow the content at each level. Otherwise, the indentation marker will remain at the left most position of the view regardless of how many levels in the content is indented.
- (void)
setIndentationPerLevel: (float)newIndentLevel;
Availability: OpenStep
Sets the amount, in points, that each level is to be indented by.
- (void)
setOutlineTableColumn: (
NSTableColumn*)outlineTableColumn;
Availability: OpenStep
Sets the outline table column in which to place the indentation marker.
- (BOOL)
shouldCollapseAutoExpandedItemsForDeposited: (BOOL)deposited;
Availability: OpenStep
Returns YES
, by default. Subclasses should override this method if a different behaviour is required.
Instance Variables for NSOutlineView Class
@protected BOOL _autoResizesOutlineColumn;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected BOOL _autosaveExpandedItems;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSMutableArray* _expandedItems;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected BOOL _indentationMarkerFollowsCell;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected float _indentationPerLevel;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSMapTable* _itemDict;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSMutableArray* _items;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSMapTable* _levelOfItems;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSTableColumn* _outlineTableColumn;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
@protected NSMutableArray* _selectedItems;
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
- Declared in:
- AppKit/NSOutlineView.h
Availability: OpenStep
Informal protocol NSOutlineViewDataSource
Method summary
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
acceptDrop: (id
)info item: (id)item childIndex: (int)index;
Availability: OpenStep
Returns whether or not the outline view should accept a drop into the indicated item.
- (id)
outlineView: (
NSOutlineView*)outlineView
child: (int)index
ofItem: (id)item;
Availability: OpenStep
Implementation of this method is required. Returns the child at the specified index for the given item.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
isItemExpandable: (id)item;
Availability: OpenStep
This is a required method. Returns whether or not the outline view item specified is expandable or not.
- (id)
outlineView: (
NSOutlineView*)outlineView
itemForPersistentObject: (id)object;
Availability: OpenStep
Returns the item for the given persistent object.
- (int)
outlineView: (
NSOutlineView*)outlineView
numberOfChildrenOfItem: (id)item;
Availability: OpenStep
Description forthcoming.
- (id)
outlineView: (
NSOutlineView*)outlineView
objectValueForTableColumn: (
NSTableColumn*)tableColumn
byItem: (id)item;
Availability: OpenStep
This is a required method. Returns the object corresponding to the item representing it in the outline view.
- (id)
outlineView: (
NSOutlineView*)outlineView
persistentObjectForItem: (id)item;
Availability: OpenStep
Returns the persistent object for the item specified.
- (void)
outlineView: (
NSOutlineView*)outlineView
setObjectValue: (id)object
forTableColumn: (
NSTableColumn*)tableColumn
byItem: (id)item;
Availability: OpenStep
Sets the object value of the given item in the given table column to the object provided.
- (NSDragOperation)
outlineView: (
NSOutlineView*)outlineView
validateDrop: (id
)info proposedItem: (id)item proposedChildIndex: (int)index;
Availability: OpenStep
Used by the Drag and Drop system. Returns the drap operations which was performed on the given outline view.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
writeItems: (NSArray*)items
toPasteboard: (
NSPasteboard*)pboard;
Availability: OpenStep
Causes the outline view to write the specified items to the pastboard.
- Declared in:
- AppKit/NSOutlineView.h
Availability: OpenStep
Description forthcoming.
Method summary
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
shouldCollapseItem: (id)item;
Availability: OpenStep
Returns whether or not the specified item should be allowed to collapse.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
shouldEditTableColumn: (
NSTableColumn*)tableColumn
item: (id)item;
Availability: OpenStep
Returns whether or not the given table column should be allowed to be edited.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
shouldExpandItem: (id)item;
Availability: OpenStep
Returns whether or not the specified item should be expanded.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
shouldSelectItem: (id)item;
Availability: OpenStep
Returns YES
or NO
depending on if the given item is selectable. If YES
, the item is selected, otherwise the outline view will reject the selection.
- (BOOL)
outlineView: (
NSOutlineView*)outlineView
shouldSelectTableColumn: (
NSTableColumn*)tableColumn;
Availability: OpenStep
Returns YES
or NO
depending on if the given table column is selectable according to the delegate. If NO
is returned the outline view will not allow the selection, if YES
it will allow the selection.
- (void)
outlineView: (
NSOutlineView*)outlineView
willDisplayCell: (id)cell
forTableColumn: (
NSTableColumn*)tableColumn
item: (id)item;
Availability: OpenStep
Called when the given cell is about to be displayed. This method is useful for making last second modifications to what will be shown.
- (void)
outlineView: (
NSOutlineView*)outlineView
willDisplayOutlineCell: (id)cell
forTableColumn: (
NSTableColumn*)tableColumn
item: (id)item;
Availability: OpenStep
Called when the given cell in the outline column is about to be displayed. This method is useful for making last second modifications to what will be shown.
- (void)
outlineViewColumnDidMove: (NSNotification*)aNotification;
Availability: OpenStep
Called after the column has moved.
- (void)
outlineViewColumnDidResize: (NSNotification*)aNotification;
Availability: OpenStep
Called after the view column is resized.
- (void)
outlineViewItemDidCollapse: (NSNotification*)aNotification;
Availability: OpenStep
Called after the item has collapsed.
- (void)
outlineViewItemDidExpand: (NSNotification*)aNotification;
Availability: OpenStep
Called after the item has expanded
- (void)
outlineViewItemWillCollapse: (NSNotification*)aNotification;
Availability: OpenStep
Called before the item has collapsed.
- (void)
outlineViewItemWillExpand: (NSNotification*)aNotification;
Availability: OpenStep
Called before the item is expanded.
- (void)
outlineViewSelectionDidChange: (NSNotification*)aNotification;
Availability: OpenStep
Called when the selection has changed.
- (void)
outlineViewSelectionIsChanging: (NSNotification*)aNotification;
Availability: OpenStep
Called when the selection is about to change.
- (BOOL)
selectionShouldChangeInOutlineView: (
NSOutlineView*)outlineView;
Availability: OpenStep
Called before the selection is modified. This method should return YES
if the selection is allowed and NO
, if not.
Up