Up

# NSSplitView

### Authors

Robert Vasvari (`vrobi@ddrummer.com`)
Felipe A. Rodriguez (`far@ix.netcom.com`)
Richard Frith-Macdonald (`richard@brainstorm.co.uk`)
Nicola Pero (`nicola.pero@meta-innovation.com`)

> Allows multiple views to share a region in a window

Copyright: (C) 1996, 1998, 1999, 2000, 2001, 2004, 2008 Free Software Foundation, Inc.

### Contents -

1. Software documentation for the NSSplitView class
2. Software documentation for the NSObject(NSSplitViewDelegate) informal protocol
3. Software documentation for the NSSplitView(GNUstepExtra) category

# Software documentation for the NSSplitView class

## NSSplitView : NSView

> Declared in:
>   AppKit/NSSplitView.h

Availability: OpenStep
Description forthcoming.

Instance Variables
Method summary

- -backgroundColor
- -dimpleImage
- -draggedBarWidth
- -setBackgroundColor:
- -setDimpleImage:resetDividerThickness:
- -setDividerColor:
- -setDraggedBarWidth:
- -adjustSubviews
- -autosaveName
- -delegate
- -dividerColor
- -dividerStyle
- -dividerThickness
- -drawDividerInRect:
- -isPaneSplitter
- -isSubviewCollapsed:
- -isVertical
- -maxPossiblePositionOfDividerAtIndex:
- -minPossiblePositionOfDividerAtIndex:
- -setAutosaveName:
- -setDelegate:
- -setDividerStyle:
- -setIsPaneSplitter:
- -setPosition:ofDividerAtIndex:
- -setVertical:

### adjustSubviews

- (void) adjustSubviews;
Availability: OpenStep
Description forthcoming.

### autosaveName

- (NSString*) autosaveName;
Availability: MacOS-X 10.5.0
Description forthcoming.

### delegate

- (id) delegate;
Availability: OpenStep
Description forthcoming.

### dividerColor

- (NSColor*) dividerColor;
Availability: MacOS-X 10.5.0
Description forthcoming.

### dividerStyle

- (NSSplitViewDividerStyle) dividerStyle;
Availability: MacOS-X 10.5.0
Description forthcoming.

### dividerThickness

- (CGFloat) dividerThickness;
Availability: OpenStep
Description forthcoming.

### drawDividerInRect:

- (void) drawDividerInRect: (NSRect)aRect;
Availability: OpenStep
Description forthcoming.

### isPaneSplitter

- (BOOL) isPaneSplitter;
Availability: MacOS-X 10.0.0
Description forthcoming.

### isSubviewCollapsed:

- (BOOL) isSubviewCollapsed: (NSView*)subview;
Availability: MacOS-X 10.0.0
Description forthcoming.

### isVertical

- (BOOL) isVertical;
Availability: OpenStep
Description forthcoming.

### maxPossiblePositionOfDividerAtIndex:

- (CGFloat) maxPossiblePositionOfDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### minPossiblePositionOfDividerAtIndex:

- (CGFloat) minPossiblePositionOfDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setAutosaveName:

- (void) setAutosaveName: (NSString*)autosaveName;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setDelegate:

- (void) setDelegate: (id)anObject;
Availability: OpenStep
Description forthcoming.

### setDividerStyle:

- (void) setDividerStyle: (NSSplitViewDividerStyle)dividerStyle;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setIsPaneSplitter:

- (void) setIsPaneSplitter: (BOOL)flag;
Availability: MacOS-X 10.0.0
Description forthcoming.

### setPosition: ofDividerAtIndex:

- (void) setPosition: (CGFloat)position ofDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setVertical:

- (void) setVertical: (BOOL)flag;
Availability: OpenStep
Description forthcoming.

## Instance Variables for NSSplitView Class

### _autosaveName

@protected NSString* _autosaveName;
Availability: OpenStep
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.

### _backgroundColor

@protected NSColor* _backgroundColor;
Availability: OpenStep
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.

### _delegate

@protected id _delegate;
Availability: OpenStep
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.

### _dimpleImage

@protected NSImage* _dimpleImage;
Availability: OpenStep
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.

### _dividerColor

@protected NSColor* _dividerColor;
Availability: OpenStep
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.

### _dividerWidth

@protected CGFloat _dividerWidth;
Availability: OpenStep
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.

### _draggedBarWidth

@protected CGFloat _draggedBarWidth;
Availability: OpenStep
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.

### _isVertical

@protected BOOL _isVertical;
Availability: OpenStep
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.

### _is_pane_splitter

@protected BOOL _is_pane_splitter;
Availability: OpenStep
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.

### _never_displayed_before

@protected BOOL _never_displayed_before;
Availability: OpenStep
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.

# Software documentation for the NSObject(NSSplitViewDelegate) informal protocol

## NSObject(NSSplitViewDelegate)

> Declared in:
>   AppKit/NSSplitView.h

Availability: OpenStep
Description forthcoming.
Method summary

- -splitView:additionalEffectiveRectOfDividerAtIndex:
- -splitView:canCollapseSubview:
- -splitView:constrainMaxCoordinate:ofSubviewAt:
- -splitView:constrainMinCoordinate:maxCoordinate:ofSubviewAt:
- -splitView:constrainMinCoordinate:ofSubviewAt:
- -splitView:constrainSplitPosition:ofSubviewAt:
- -splitView:effectiveRect:forDrawnRect:ofDividerAtIndex:
- -splitView:resizeSubviewsWithOldSize:
- -splitView:shouldAdjustSizeOfSubview:
- -splitView:shouldCollapseSubview:forDoubleClickOnDividerAtIndex:
- -splitView:shouldHideDividerAtIndex:
- -splitViewDidResizeSubviews:
- -splitViewWillResizeSubviews:

### splitView: additionalEffectiveRectOfDividerAtIndex:

- (NSRect) splitView: (NSSplitView*)splitView additionalEffectiveRectOfDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### splitView: canCollapseSubview:

- (BOOL) splitView: (NSSplitView*)sender canCollapseSubview: (NSView*)subview;
Availability: MacOS-X 10.0.0
Description forthcoming.

### splitView: constrainMaxCoordinate: ofSubviewAt:

- (CGFloat) splitView: (NSSplitView*)sender constrainMaxCoordinate: (CGFloat)proposedMax ofSubviewAt: (NSInteger)offset;
Availability: MacOS-X 10.0.0
Description forthcoming.

### splitView: constrainMinCoordinate: maxCoordinate: ofSubviewAt:

- (void) splitView: (NSSplitView*)sender constrainMinCoordinate: (CGFloat*)min maxCoordinate: (CGFloat*)max ofSubviewAt: (NSInteger)offset;
Availability: OpenStep
Description forthcoming.

### splitView: constrainMinCoordinate: ofSubviewAt:

- (CGFloat) splitView: (NSSplitView*)sender constrainMinCoordinate: (CGFloat)proposedMin ofSubviewAt: (NSInteger)offset;
Availability: MacOS-X 10.0.0
Description forthcoming.

### splitView: constrainSplitPosition: ofSubviewAt:

- (CGFloat) splitView: (NSSplitView*)sender constrainSplitPosition: (CGFloat)proposedPosition ofSubviewAt: (NSInteger)offset;
Availability: OpenStep
Description forthcoming.

### splitView: effectiveRect: forDrawnRect: ofDividerAtIndex:

- (NSRect) splitView: (NSSplitView*)splitView effectiveRect: (NSRect)proposedEffectiveRect forDrawnRect: (NSRect)drawnRect ofDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### splitView: resizeSubviewsWithOldSize:

- (void) splitView: (NSSplitView*)sender resizeSubviewsWithOldSize: (NSSize)oldSize;
Availability: OpenStep
Description forthcoming.

### splitView: shouldAdjustSizeOfSubview:

- (BOOL) splitView: (NSSplitView*)splitView shouldAdjustSizeOfSubview: (NSView*)view;
Availability: MacOS-X 10.6.0
Description forthcoming.

### splitView: shouldCollapseSubview: forDoubleClickOnDividerAtIndex:

- (BOOL) splitView: (NSSplitView*)splitView shouldCollapseSubview: (NSView*)subview forDoubleClickOnDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### splitView: shouldHideDividerAtIndex:

- (BOOL) splitView: (NSSplitView*)splitView shouldHideDividerAtIndex: (NSInteger)dividerIndex;
Availability: MacOS-X 10.5.0
Description forthcoming.

### splitViewDidResizeSubviews:

- (void) splitViewDidResizeSubviews: (NSNotification*)notification;
Availability: OpenStep
Description forthcoming.

### splitViewWillResizeSubviews:

- (void) splitViewWillResizeSubviews: (NSNotification*)notification;
Availability: OpenStep
Description forthcoming.

# Software documentation for the NSSplitView(GNUstepExtra) category

## NSSplitView(GNUstepExtra)

> Declared in:
>   AppKit/NSSplitView.h

Availability: Not in OpenStep/MacOS-X
Description forthcoming.
Method summary

- -backgroundColor
- -dimpleImage
- -draggedBarWidth
- -setBackgroundColor:
- -setDimpleImage:resetDividerThickness:
- -setDividerColor:
- -setDraggedBarWidth:

### backgroundColor

- (NSColor*) backgroundColor;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### dimpleImage

- (NSImage*) dimpleImage;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### draggedBarWidth

- (CGFloat) draggedBarWidth;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### setBackgroundColor:

- (void) setBackgroundColor: (NSColor*)aColor;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### setDimpleImage: resetDividerThickness:

- (void) setDimpleImage: (NSImage*)anImage resetDividerThickness: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### setDividerColor:

- (void) setDividerColor: (NSColor*)aColor;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

### setDraggedBarWidth:

- (void) setDraggedBarWidth: (CGFloat)newWidth;
Availability: Not in OpenStep/MacOS-X
Description forthcoming.

Up