MiscSplitView.rtf

This is MiscSplitView.rtf in view mode; [Download] [Up]

MiscSplitView

Inherits From: View : Responder : Object

Declared In: <misckit/MiscSplitView.h>

Class Description

A MiscSplitView object lets several Views share a region within a window. It works exactly like an NXSplitView, except that it can tile its subviews horizontally as well as vertically. To change the orientation of a MiscSplitView, use the setHorizontal: method. The default is vertical, the orientation that NXSplitView uses.

For vertical orientations, the MiscSplitView resizes its subviews so that each subview is the same width as the MiscSplitView, and the total of the subviews' heights plus the total of the divider's heights is equal to the height of the MiscSplitView. The MiscSplitView positions its subviews so that the first subview is at the top of the MiscSplitView, and each successive subview is positioned below. For horizontal orientations, the MiscSplitView resizes its subviews so that each subview is the same height as the MiscSplitView, and the total of the subviews' widths plus the total of the divider's widths is equal to the width of the MiscSplitView. The MiscSplitView positions its subviews so that the first subview is at the left edge of the MiscSplitView, and each successive subview is positioned to the right. The user can change the size of any two subviews by moving a bar between them called the divider, which makes one subview smaller and the other larger.

To add a View to a MiscSplitView, use the addSubview: View method. When the MiscSplitView is displayed, it checks to see if its subviews are properly tiled. If not, it invokes the splitView:resizeSubviews: delegate method, allowing the delegate to specify the heights or widths of specific subviews. If the delegate doesn't implement a splitView:resizeSubviews: method, the MiscSplitView sends adjustSubviews to itself to yield a default tiling behavior.

When a mouse-down event occurs in a MiscSplitView's divider, the MiscSplitView determines the limits of the divider's travel and tracks the mouse to allow the user to drag the divider within these limits. With the following mouse-up, the MiscSplitView resizes the two affected subviews, informs the delegate that the subviews were resized, and displays the affected Views and divider. The MiscSplitView's delegate can constrain the travel of specific dividers by implementing the splitView:getMinY:maxY:ofSubviewAt: method for vertical MiscSplitViews and the splitView:getMinX:maxX:ofSubviewAt: method for horizontal MiscSplitViews.

In addition to implementing the features of the NXSplitView class, MiscSplitView adds the ability to save the view's divider positions in the defaults database, in a manner modeled after Window's frame saving mechanism. To automatically save a MiscSplitView's divider positions in the defaults database, invoke setDividersAutosaveName: with the name that will be used to identify the MiscSplitView in the defaults database. Invoking this method also sets the view's divider positions to the previously saved value, if one exists. To manually save and set the divider positions, use the saveDividersUsingName: and setDividersUsingName: methods.

Instance Variables

id delegate;
struct _msvFlags {
unsigned int horizontal:1;
unsigned int needsRetiling:1;
} msvFlags;

delegate The object that receives notification messages from the MiscSplitView.
msvFlags.horizontal YES if the MiscSplitView has a horizontal orientation.
msvFlags.needsRetiling YES if resizeSubviews: needs to be called before the MiscSplitView is displayed.

Method Types

Initializing a MiscSplitView + initialize
- initFrame:

Freeing a MiscSplitView - free

Assigning a delegate - delegate
- setDelegate:

Assigning orientation - isHorizontal
- setHorizontal:

Accessing the dividers - setDividersFromString:
- saveDividersToString:
- setDividersUsingName:
- saveDividersUsingName:
+ removeDividersUsingName:
- dividersAutosaveName
- setDividersAutosaveName:
+ requireUniqueAutosaveNames:

Drawing the view - dividerSize
- dividerHeight
- dividerWidth
- drawSelf::
- drawDivider:

Managing component Views - constrainDivider:leftFrame:rightFrame:min:max:
- constrainFramesLeft:andRight:besideDivider:
- adjustSubviews
- resizeSubviews:
- setAutoresizeSubviews:
- addSubview:
- addSubview::relativeTo:
- replaceSubview:with:

Handling Events - mouseDown:
- acceptsFirstMouse

Archiving - read:
- write:

Class Methods

initialize
+ initialize

Initializes the MiscSplitView class object. The class object receives an initialize message before it receives any other message. You never send an initialize message directly. Returns self.