PSMTabBarControl/documentation/PSMTabBarControlDoc.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3     <head>
   4
   5         <TITLE>PSMTabBarControl - Safari-style Tabs (Objective-C)</TITLE>
   6
   7
   8         <LINK REL="stylesheet" TYPE="text/css" HREF="frameset_styles.css">
   9
  10     </head>
  11
  12     <BODY bgcolor="#ffffff">
  13
  14         <h1>PSMTabBarControl</h1><div class="spec_sheet_info_box"><table cellspacing="0" class="specbox">
  15 <tr><td scope="row"><b><span style="white-space: nowrap;">Inherits from</span></b></td><td><div style="margin-bottom:1px"><a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSControl.html#//apple_ref/occ/cl/NSControl" target="_top">NSControl</a> : <a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSView.html#//apple_ref/occ/cl/NSView" target="_top">NSView</a> : <a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSResponder.html#//apple_ref/occ/cl/NSResponder" target="_top">NSResponder</a> : <a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/Foundation/ObjC_classic/Classes/NSObject.html#//apple_ref/occ/cl/NSObject" target="_top">NSObject</a></div></td></tr>
  16 <tr><td scope="row"><b><span style="white-space: nowrap;">Conforms to</span></b></td><td><div style="margin-bottom:1px">
  17 <span class="content_text"><a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/Foundation/ObjC_classic/Protocols/NSCoding.html#//apple_ref/occ/intf/NSCoding" target="_top">NSCoding (NSResponder)</a></span><br>
  18
  19 <span class="content_text"><a href="file:///Developer/ADC%20Reference%20Library/documentation/Cocoa/Reference/Foundation/ObjC_classic/Protocols/NSObjectProtocol.html#//apple_ref/occ/intf/NSObject" target="_top">NSObject (NSObject)</a></span><br>
  20 </div></td></tr>
  21 <tr><td scope="row"><b><span style="white-space: nowrap;">Declared in</span></b></td><td><div style="margin-bottom:1px"><span class="content_text">PSMTabBarControl.h</span><br>
  22 </div></td></tr>
  23 </table></div><br><a name="//apple_ref/doc/uid/20000092-50187" title="Class Description"></a><a name="50187" title="Class Description"></a><h2>Class Description</h2>
  24
  25 <p class="spaceabove">PSMTabBarControl provides a user interface for the management of tabbed views that has an appearance similar to Apple's Safari web browser.<p>
  26 <p>Internally, PSMTabBarControl uses a custom cell class and supporting style objects to implement its user interface.</p>
  27 <p>Currently, this object supports "Aqua" and "Metal" tab styles to present an appearance consistent with the rest of your application.  Numerous configuration options exist to customize behavior, as outlined below.  PSMTabBarControl instances require a few specific connections with other application objects to perform properly at runtime:</p>
  28 <ul>
  29 <li><b>The control's "tabView" outlet must be connected to the desired NSTabView instance in Interface Builder, or set programmatically with the setTabView: method.</b></li>
  30 <li><b>The "delegate" outlet of the NSTabView being controlled must be connected to the instance of PSMTabBarControl, either programmatically or in IB.</b></li>
  31 <li>Optionally, you may connect the control's "partnerView" outlet to a view that will be resized to compensate when PSMTabBarControl changes size due to hide/show behavior.  If no connection is made, PSMTabBarControl will resize the window in response to hide/show messages.</li>
  32 </ul>
  33 <p>A PSMTabBarControl instance should occupy the width of the window, and should be precisely 22 pixels in height.  It should be resizable in width, but not height.  It can be placed at the top or botton of the window (or anywhere in between, if desired).</p>
  34 <p>Outside of configuring it, your application should have little interaction with this class.  The presented tabs will change in conjunction with changes your application makes in the NSTabView being controlled.</p>
  35
  36 <h2>A Usage Pattern</h2>
  37
  38 <p class="spaceabove">PSMTabBarControl becomes even more powerful if your application design matches an expected pattern: the control attempts to bind a number of tab attributes to the NSTabViewItem's identifier object if possible.  These visible attributes include a progress indicator, an icon, and an object counter.  Additionally, the control binds each tab's title to the label of the represented NSTabViewItem.<p>
  39
  40 <p>Taking advantage of these features requires no glue code on your part, but it does require providing a particular object graph.  Here's the basics...</p>
  41
  42 <ul><li>For each tab that is created, your application should have a model object that keeps the state of model attributes: isProcessing (a BOOL), objectCount (an int), and icon (an NSImage).  You can pick and choose any number of these to support, or none, at your option.
  43 <li>Your application should create an NSObjectController to control your model (the model object is the "content" of the NSObjectController instance).
  44 <li>When you create new tabs (via the NSTabView interface), you should set the object controller instance to be the identifier object of the newly created NSTabViewItem object.</ul>
  45
  46 <p>The demo application included with this project illustrates a very quick way to accomplish these goals.  If this pattern is followed, PSMTabBarControl will take care of the rest.</p>
  47
  48
  49 <h2>Methods by Task</h2>
  50 <h3 class="tight">Setting needed connections</h3>
  51 <dl class="termdef">    <dt><code><a href="#addTabButton">&#8211;&#xA0;setTabView:</a></code></dt><dd><p>Specifies the instance of NSTabView to be controlled.</p></dd></dl>
  52
  53 <dl class="termdef">    <dt><code><a href="#tabView">&#8211;&#xA0;tabView</a></code></dt><dd><p>Returns the instance of NSTabView being controlled.</p></dd></dl>
  54
  55 <h3 class="tight">Setting optional connections</h3>
  56 <dl class="termdef">    <dt><code><a href="#setPartnerView">&#8211;&#xA0;setPartnerView:</a></code></dt><dd><p>Specifies a view that will resize to compensate for control size changes in response to hide and show messages.</p></dd></dl>
  57
  58 <dl class="termdef">    <dt><code><a href="#partnerView">&#8211;&#xA0;partnerView</a></code></dt><dd><p>Returns the instance of a view that will resize to compensate for control size changes in response to hide and show messages.</p></dd></dl>
  59
  60 <dl class="termdef">    <dt><code><a href="#setDelegate">&#8211;&#xA0;setDelegate:</a></code></dt><dd><p>Specifies an object that will receive delegate messages as passed through from the NSTabView instance.</p></dd></dl>
  61
  62 <dl class="termdef">    <dt><code><a href="#delegate">&#8211;&#xA0;delegate:</a></code></dt><dd><p>Returns the specified delegate object.</p></dd></dl>
  63
  64 <h3 class="tight">Control configuration</h3>
  65 <dl class="termdef">    <dt><code><a href="#canCloseOnlyTab">&#8211;&#xA0;canCloseOnlyTab</a></code></dt><dd><p>Returns YES if the user is allowed to close a tab when it is the only tab left, NO otherwise.</p></dd></dl>
  66
  67 <dl class="termdef">    <dt><code><a href="#setCanCloseOnlyTab">&#8211;&#xA0;setCanCloseOnlyTab:</a></code></dt><dd><p>Controls whether the receiver will present a close button for a single tab in a tab bar. </p></dd></dl>
  68
  69 <dl class="termdef">    <dt><code><a href="#styleName">&#8211;&#xA0;styleName</a></code></dt><dd><p>Returns the name of the current drawing style. "Aqua", "Metal", and "Unified" are the currently supported options.</p></dd></dl>
  70
  71 <dl class="termdef">    <dt><code><a href="#setStyleNamed">&#8211;&#xA0;setStyleNamed:</a></code></dt><dd><p>Specifies the style in which the tabs and control are drawn.  "Aqua", "Metal", and "Unified" are the currently supported options. </p></dd></dl>
  72
  73 <dl class="termdef">    <dt><code><a href="#hideForSingleTab">&#8211;&#xA0;hideForSingleTab</a></code></dt><dd><p>Returns YES if the control will hide if there is only one tab left, NO otherwise.</p></dd></dl>
  74
  75 <dl class="termdef">    <dt><code><a href="#setHideForSingleTab">&#8211;&#xA0;setHideForSingleTab:</a></code></dt><dd><p>Controls whether the receiver will hide when the user closes all but a single tab in a tab bar. </p></dd></dl>
  76
  77 <dl class="termdef">    <dt><code><a href="#showAddTabButton">&#8211;&#xA0;showAddTabButton</a></code></dt><dd><p>Returns YES if the control will display a small "add tab" button at the rightmost end of the tabs, NO otherwise.</p></dd></dl>
  78
  79 <dl class="termdef">    <dt><code><a href="#setShowAddTabButton">&#8211;&#xA0;setShowAddTabButton:</a></code></dt><dd><p>Controls whether the receiver will will display a small "add tab" button at the rightmost end of the tabs. </p></dd></dl>
  80
  81 <dl class="termdef">    <dt><code><a href="#cellMinWidth">&#8211;&#xA0;cellMinWidth</a></code></dt><dd><p>Returns the minimum width (in pixels) that a tab will be allowed to occupy.</p></dd></dl>
  82
  83 <dl class="termdef">    <dt><code><a href="#setCellMinWidth">&#8211;&#xA0;setCellMinWidth:</a></code></dt><dd><p>Specifies the maximum width (in pixels) that a tab will be allowed to occupy.</p></dd></dl>
  84
  85 <dl class="termdef">    <dt><code><a href="#cellMaxWidth">&#8211;&#xA0;cellMaxWidth</a></code></dt><dd><p>Returns the maximum width (in pixels) that a tab will be allowed to occupy.</p></dd></dl>
  86
  87 <dl class="termdef">    <dt><code><a href="#setCellMaxWidth">&#8211;&#xA0;setCellMaxWidth:</a></code></dt><dd><p>Specifies the maximum width (in pixels) that a tab will be allowed to occupy.</p></dd></dl>
  88
  89 <dl class="termdef">    <dt><code><a href="#cellOptimumWidth">&#8211;&#xA0;cellOptimumWidth</a></code></dt><dd><p>Returns the default width (in pixels) that a tab will be allowed to occupy when tabs are drawn with uniform size.</p></dd></dl>
  90
  91 <dl class="termdef">    <dt><code><a href="#setCellMaxWidth">&#8211;&#xA0;setCellMaxWidth:</a></code></dt><dd><p>Specifies the default width (in pixels) that a tab will be allowed to occupy when tabs are drawn with uniform size.</p></dd></dl>
  92
  93 <dl class="termdef">    <dt><code><a href="#sizeCellsToFit">&#8211;&#xA0;sizeCellsToFit</a></code></dt><dd><p>Returns YES if the control will make the tabs sized to fit the content of the tab, NO otherwise.</p></dd></dl>
  94
  95 <dl class="termdef">    <dt><code><a href="#setSizeCellsToFit">&#8211;&#xA0;setSizeCellsToFit:</a></code></dt><dd><p>Controls whether the receiver will make the tabs sized to fit the content of the tab.</p></dd></dl>
  96
  97 <dl class="termdef">    <dt><code><a href="#allowsDragBetweenWindows">&#8211;&#xA0;allowsDragBetweenWindows</a></code></dt><dd><p>Returns YES if the control allows a user to drag a tab to another instance of this control, NO otherwise.</p></dd></dl>
  98
  99 <dl class="termdef">    <dt><code><a href="#setAllowsDragBetweenWindows">&#8211;&#xA0;setAllowsDragBetweenWindows:</a></code></dt><dd><p>Controls whether the receiver will allow a user to drag a tab to another instance of this control.</p></dd></dl>
 100
 101 <h3 class="tight">Internal UI components</h3>
 102 <dl class="termdef">    <dt><code><a href="#addTabButton">&#8211;&#xA0;addTabButton</a></code></dt><dd><p>Returns an instance of an NSButton subclass that is used to present the "add tab" button.  If "showAddTabButton" is YES, developers must use this method to access the button and specify a target and action for the button.</p></dd></dl>
 103
 104 <dl class="termdef">    <dt><code><a href="#overflowPopUpButton">&#8211;&#xA0;overflowPopUpButton</a></code></dt><dd><p>Returns an instance of an NSPopUpButton subclass that is used to present the overflow menu (which shows when there are more tabs than can fit across the control).</p></dd></dl>
 105
 106 <dl class="termdef">    <dt><code><a href="#representedTabViewItems">&#8211;&#xA0;representedTabViewItems</a></code></dt><dd><p>Returns an array of the NSTabViewItems represented by the tabs in the control.  Useful if you want to archive the order of the tabs between runs of your program.</p></dd></dl>
 107
 108 <h3 class="tight">Visibility</h3>
 109 <dl class="termdef">    <dt><code><a href="#hideTabBar">&#8211;&#xA0;hideTabBar:animate:</a></code></dt><dd><p>If desired, obejcts can tell the tab bar to hide (reduce in size to a single pixel line spanning the window) or show, and optionally whether to animate this effect or not.</p></dd></dl>
 110
 111 <h2>Instance Methods</h2>
 112
 113 <a name="addTabButton"></a><h3 class="tight">addTabButton</h3>
 114 <p class="spaceabove">Returns an instance of an NSButton subclass that is used to present the "add tab" button.  If "showAddTabButton" is YES, developers must use this method to access the button and specify a target and action for the button.</p><p class="spaceabovemethod">- (PSMRolloverButton *)addTabButton;</p>
 115 <h5 class="tight">Discussion</h5><p> If you have configured the control to show the add tab button, you must use this method to access the button and set the target and action for it.  Example:</p> <code>[[tabBar addTabButton] setTarget:self];<br>
 116 [[tabBar addTabButton] setAction:@selector(addNewTab:)];</code> </p>
 117 <h5 class="tight">See Also</h5><ul class="availability">
 118 <li class="availability">  <code><a href="#setShowAddTabButton">&#8211;&#xA0;setShowAddTabButton:</a></code><li><li class="availability">  <code><a href="#showAddTabButton">&#8211;&#xA0;showAddTabButton</a></code><li></ul>
 119
 120 <a name="allowsDragBetweenWindows"></a><h3 class="tight">allowsDragBetweenWindows</h3>
 121 <p class="spaceabove">Returns <code>YES</code> if the control allows a user to drag a tab to another instance of this control, NO otherwise.</p><p class="spaceabovemethod">- (BOOL)allowsDragBetweenWindows</p>
 122 <h5 class="tight">Discussion</h5><p>The default is <code>YES</code>.</p>
 123 <h5 class="tight">See Also</h5><ul class="availability">
 124 <li class="availability">  <code><a href="#setAllowsDragBetweenWindows">&#8211;&#xA0;setAllowsDragBetweenWindows:</a></code><li></ul>
 125
 126 <a name="canCloseOnlyTab"></a><h3 class="tight">canCloseOnlyTab</h3>
 127 <p class="spaceabove">Returns <code>YES</code> if the receiver has been configured to allow users to close a single remaining tab.</p><p class="spaceabovemethod">- (BOOL)canCloseOnlyTab</p>
 128 <h5 class="tight">Discussion</h5><p>The default is <code>NO</code>.</p>
 129 <h5 class="tight">See Also</h5><ul class="availability">
 130 <li class="availability">  <code><a href="#setCanCloseOnlyTab">&#8211;&#xA0;setCanCloseOnlyTab:</a></code><li></ul>
 131
 132 <a name="cellMaxWidth"></a><h3 class="tight">cellMaxWidth</h3>
 133 <p class="spaceabove">Returns the maximum width (in pixels) that a tab will be allowed to occupy.</p><p class="spaceabovemethod">- (int)cellMaxWidth</p>
 134 <h5 class="tight">Discussion</h5><p>The cellMaxWidth value applies to both uniformly sized tabs, and tabs that are sized to fit.  No tab will be drawn wider than the specified value.</p>
 135 <h5 class="tight">See Also</h5><ul class="availability">
 136 <li class="availability">  <code><a href="#setCellMaxWidth">&#8211;&#xA0;setCellMaxWidth:</a></code><li><li class="availability">  <code><a href="#cellMinWidth">&#8211;&#xA0;cellMinWidth</a></code><li class="availability">  <code><a href="#cellOptimumWidth">&#8211;&#xA0;cellOptimumWidth</a></code><li></ul>
 137
 138 <a name="cellMinWidth"></a><h3 class="tight">cellMinWidth</h3>
 139 <p class="spaceabove">Returns the minimum width (in pixels) that a tab will be allowed to occupy.</p><p class="spaceabovemethod">- (int)cellMinWidth</p>
 140 <h5 class="tight">Discussion</h5><p>The cellMinWidth value applies only to uniformly sized tabs.  No tab will be drawn smaller than the specified value.  Size-to-fit tabs ignore this value, and are made just small enough to fit their content.</p>
 141 <h5 class="tight">See Also</h5><ul class="availability">
 142 <li class="availability">  <code><a href="#setCellMinWidth">&#8211;&#xA0;setCellMinWidth:</a></code><li><li class="availability">  <code><a href="#cellMaxWidth">&#8211;&#xA0;cellMaxWidth</a></code><li class="availability">  <code><a href="#cellOptimumWidth">&#8211;&#xA0;cellOptimumWidth</a></code><li></ul>
 143
 144 <a name="cellOptimumWidth"></a><h3 class="tight">cellOptimumWidth</h3>
 145 <p class="spaceabove">Returns the width (in pixels) that a tab will be made to occupy if the tabs are uniformly sized.</p><p class="spaceabovemethod">- (int)cellOptimumWidth</p>
 146 <h5 class="tight">Discussion</h5><p>The cellOptimumWidth value applies only to uniformly sized tabs.  All tabs will be drawn at the specified value.  Size-to-fit tabs ignore this value, and are made just small enough to fit their content.</p>
 147 <h5 class="tight">See Also</h5><ul class="availability">
 148 <li class="availability">  <code><a href="#setCellOptimumWidth">&#8211;&#xA0;setCellOptimumWidth:</a></code><li><li class="availability">  <code><a href="#cellMaxWidth">&#8211;&#xA0;cellMaxWidth</a></code><li class="availability">  <code><a href="#cellMinWidth">&#8211;&#xA0;cellMinWidth</a></code><li></ul>
 149
 150 <a name="delegate"></a><h3 class="tight">delegate</h3>
 151 <p class="spaceabove">Returns the object that will be sent passed-through NSTabView delegate messages.</p><p class="spaceabovemethod">- (id)delegate</p>
 152 <h5 class="tight">See Also</h5><ul class="availability">
 153 <li class="availability">  <code><a href="#setDelegate">&#8211;&#xA0;setDelegate:</a></code><li></ul>
 154
 155 <a name="hideForSingleTab"></a><h3 class="tight">hideForSingleTab</h3>
 156 <p class="spaceabove">Returns <code>YES</code> if the receiver has been configured to hide if there is a single remaining tab.</p><p class="spaceabovemethod">- (BOOL)hideForSingleTab</p>
 157 <h5 class="tight">Discussion</h5><p>The default is <code>NO</code>.</p>
 158 <h5 class="tight">See Also</h5><ul class="availability">
 159 <li class="availability">  <code><a href="#setHideForSingleTab">&#8211;&#xA0;setHideForSingleTab:</a></code><li></ul>
 160
 161 <a name="hideTabBar"></a><h3 class="tight">hideTabBar:animate:</h3>
 162 <p class="spaceabove"><p>If desired, obejcts can tell the tab bar to hide (reduce in size to a single pixel line spanning the window) or show, and optionally whether to animate this effect or not.</p></p><p class="spaceabovemethod">- (void)hideTabBar:(BOOL)hide animate:(BOOL)animate</p>
 163 <h5 class="tight">Discussion</h5><p> If <i>hide</i> is <code>YES</code> the control will shrink to a single pixel line spanning the window; otherwise the control will expand to its normal appearance. If <i>animate</i> is <code>YES</code>, the shrinking and expanding will happen in a visible animation; otherwise the transition will be instant. There is no effect if the control is already in the specified state.</p>
 164
 165 <a name="overflowPopUpButton"></a><h3 class="tight">overflowPopUpButton</h3>
 166 <p class="spaceabove">Returns an instance of an NSPopUpButton subclass that is used to present the overflow menu. </p><p class="spaceabovemethod">- (PSMOverflowPopUpButton *)overflowPopUpButton;</p>
 167 <h5 class="tight">Discussion</h5><p> This method could be used to modify the button or menu if desired.</p>
 168
 169 <a name="partnerView"></a><h3 class="tight">partnerView</h3>
 170 <p class="spaceabove">Returns the object that will be resized to compensate for the changing size of the control during hide/show behavior.</p><p class="spaceabovemethod">- (id)partnerView</p>
 171 <h5 class="tight">Discussion</h5><p> If a partnerView has not been specified, the window will be resized during hide/show.</p>
 172 <h5 class="tight">See Also</h5><ul class="availability">
 173 <li class="availability">  <code><a href="#setPartnerView">&#8211;&#xA0;setPartnerView:</a></code><li></ul>
 174
 175 <a name="representedTabViewItems"></a><h3 class="tight">representedTabViewItems</h3>
 176 <p class="spaceabove">Returns an array of NSTabViewItems, ordered according to the display order of the tabs in the control. </p><p class="spaceabovemethod">- (NSMutableArray *)representedTabViewItems;</p>
 177 <h5 class="tight">Discussion</h5><p> This method could be used archive the order of the tabs between application runs.  When the user reorders tabs via drag and drop, the represented NSTabView does <i>not</i> change order.</p>
 178
 179 <a name="setAllowsDragBetweenWindows"></a><h3 class="tight">setAllowsDragBetweenWindows</h3>
 180 <p class="spaceabove">If set to <code>YES</code>, the receiver is configured to allow users to drag a tab to an instance of PSMTabBarControl in another window.</p><p class="spaceabovemethod">- (void)setAllowsDragBetweenWindows:(BOOL)value</p>
 181 <h5 class="tight">Discussion</h5><p>The default is <code>YES</code>.</p>
 182 <h5 class="tight">See Also</h5><ul class="availability">
 183 <li class="availability">  <code><a href="#allowsDragBetweenWindows">&#8211;&#xA0;allowsDragBetweenWindows:</a></code><li></ul>
 184
 185 <a name="setCanCloseOnlyTab"></a><h3 class="tight">setCanCloseOnlyTab:</h3>
 186 <p class="spaceabove">If set to <code>YES</code>, the receiver is configured to allow users to close a single remaining tab.</p><p class="spaceabovemethod">- (void)setCanCloseOnlyTab:(BOOL)value</p>
 187 <h5 class="tight">Discussion</h5><p>The default is <code>NO</code>.</p>
 188 <h5 class="tight">See Also</h5><ul class="availability">
 189 <li class="availability">  <code><a href="#canCloseOnlyTab">&#8211;&#xA0;canCloseOnlyTab:</a></code><li></ul>
 190
 191 <a name="setCellMaxWidth"></a><h3 class="tight">setCellMaxWidth:</h3>
 192 <p class="spaceabove">Specifies the maximum width (in pixels) that a tab will be allowed to occupy.</p><p class="spaceabovemethod">- (void)setCellMaxWidth:(int)value</p>
 193 <h5 class="tight">Discussion</h5><p> No tab will be drawn any wider than the specified value.</p>
 194 <h5 class="tight">See Also</h5><ul class="availability">
 195 <li class="availability">  <code><a href="#cellMaxWidth">&#8211;&#xA0;cellMaxWidth</a></code><li></ul>
 196
 197 <a name="setCellMinWidth"></a><h3 class="tight">setCellMinWidth:</h3>
 198 <p class="spaceabove">Specifies the minimum width (in pixels) that a tab will be allowed to occupy.</p><p class="spaceabovemethod">- (void)setCellMinWidth:(int)value</p>
 199 <h5 class="tight">Discussion</h5><p> No tab will be drawn any smaller than the specified value.  This value is ignored when drawing in size-to-fit; tabs are made just small enough to fit their content.</p>
 200 <h5 class="tight">See Also</h5><ul class="availability">
 201 <li class="availability">  <code><a href="#cellMinWidth">&#8211;&#xA0;cellMinWidth</a></code><li></ul>
 202
 203 <a name="setCellOptimumWidth"></a><h3 class="tight">setCellOptimumWidth:</h3>
 204 <p class="spaceabove">Specifies the width (in pixels) that a tab will occupy when tabs are uniformly sized.</p><p class="spaceabovemethod">- (void)setCellOptimumWidth:(int)value</p>
 205 <h5 class="tight">Discussion</h5><p> This value is ignored when drawing in size-to-fit; tabs are made just small enough to fit their content.</p>
 206 <h5 class="tight">See Also</h5><ul class="availability">
 207 <li class="availability">  <code><a href="#cellOptimumWidth">&#8211;&#xA0;cellOptimumWidth</a></code><li></ul>
 208
 209 <a name="setDelegate"></a><h3 class="tight">setDelegate:</h3>
 210 <p class="spaceabove">Specifies an object that will receive delegate messages as passed through from the NSTabView instance.</p><p class="spaceabovemethod">- (void)setDelegate:(id)object</p>
 211 <h5 class="tight">See Also</h5><ul class="availability">
 212 <li class="availability">  <code><a href="#delegate">&#8211;&#xA0;delegate:</a></code><li></ul>
 213
 214 <a name="setHideForSingleTab"></a><h3 class="tight">setHideForSingleTab:</h3>
 215 <p class="spaceabove">If set to <code>YES</code>, the receiver is configured to hide when there is a single remaining tab.</p><p class="spaceabovemethod">- (void)setHideForSingleTab:(BOOL)value</p>
 216 <h5 class="tight">Discussion</h5><p>The default is <code>NO</code>.</p>
 217 <h5 class="tight">See Also</h5><ul class="availability">
 218 <li class="availability">  <code><a href="#hideForSingleTab">&#8211;&#xA0;hideForSingleTab</a></code><li></ul>
 219
 220 <a name="setPartnerView"></a><h3 class="tight">setPartnerView:</h3>
 221 <p class="spaceabove">Specifies a view that will resize to compensate for control size changes in response to hide and show messages.</p><p class="spaceabovemethod">- (void)setPartnerView:(id)view</p>
 222 <h5 class="tight">Discussion</h5><p>if <i>nil</i>, the control will resize the window in response to hide/show messages.</p>
 223 <h5 class="tight">See Also</h5><ul class="availability">
 224 <li class="availability">  <code><a href="#partnerView">&#8211;&#xA0;partnerView</a></code><li></ul>
 225
 226 <a name="setStyleNamed"></a><h3 class="tight">setStyleNamed:</h3>
 227 <p class="spaceabove">Specifies the style in which the tabs and control are drawn.  </p><p class="spaceabovemethod">- (void)setStyleNamed:(NSString *)name</p>
 228 <h5 class="tight">Discussion</h5><p>"Aqua" and "Metal" are the currently supported options.</p>
 229 <h5 class="tight">See Also</h5><ul class="availability">
 230 <li class="availability">  <code><a href="#styleName">&#8211;&#xA0;styleName</a></code><li></ul>
 231
 232 <a name="setShowAddTabButton"></a><h3 class="tight">setShowAddTabButton:</h3>
 233 <p class="spaceabove">Controls whether the receiver will will display a small "add tab" button at the rightmost end of the tabs. </p><p class="spaceabovemethod">- (void)setShowAddTabButton:(BOOL)value</p>
 234 <h5 class="tight">Discussion</h5><p>Default is <code>NO</code>.</p>
 235 <h5 class="tight">See Also</h5><ul class="availability">
 236 <li class="availability">  <code><a href="#showAddTabButton">&#8211;&#xA0;showAddTabButton</a></code><li></ul>
 237
 238 <a name="setSizeCellsToFit"></a><h3 class="tight">setSizeCellsToFit:</h3>
 239 <p class="spaceabove">Controls whether the receiver will make the tabs sized to fit the content of the tab. </p><p class="spaceabovemethod">- (void)setSizeCellsToFit:(BOOL)value</p>
 240 <h5 class="tight">Discussion</h5><p>Default is <code>NO</code>.</p>
 241 <h5 class="tight">See Also</h5><ul class="availability">
 242 <li class="availability">  <code><a href="#sizeCellsToFit">&#8211;&#xA0;sizeCellsToFit</a></code><li></ul>
 243
 244 <a name="setTabView"></a><h3 class="tight">setTabView:</h3>
 245 <p class="spaceabove">Specifies the instance of NSTabView to be controlled. </p><p class="spaceabovemethod">- (void)setTabView:(NSTabView *)view</p>
 246 <h5 class="tight">Discussion</h5><p>This class will not function properly without this outlet being set.</p>
 247 <h5 class="tight">See Also</h5><ul class="availability">
 248 <li class="availability">  <code><a href="#tabView">&#8211;&#xA0;tabView</a></code><li></ul>
 249
 250 <a name="sizeCellsToFit"></a><h3 class="tight">sizeCellsToFit</h3>
 251 <p class="spaceabove">Returns YES if the control will make the tabs sized to fit the content of the tab, NO otherwise.</p><p class="spaceabovemethod"- (BOOL)sizeCellsToFit</p>
 252 <h5 class="tight">Discussion</h5><p>The default is <code>NO</code>.</p>
 253 <h5 class="tight">See Also</h5><ul class="availability">
 254 <li class="availability">  <code><a href="#setSizeCellsToFit">&#8211;&#xA0;setSizeCellsToFit:</a></code><li></ul>
 255
 256 <a name="styleName"></a><h3 class="tight">styleName:</h3>
 257 <p class="spaceabove">Returns the name of the current drawing style.  </p><p class="spaceabovemethod">- (NSString *)styleName</p>
 258 <h5 class="tight">Discussion</h5><p>"Aqua" and "Metal" are the currently supported options.</p>
 259 <h5 class="tight">See Also</h5><ul class="availability">
 260 <li class="availability">  <code><a href="#setStyleNamed">&#8211;&#xA0;setStyleNamed:</a></code><li></ul>
 261
 262 <a name="tabView"></a><h3 class="tight">tabView:</h3>
 263 <p class="spaceabove">Returns the instance of NSTabView being controlled. </p><p class="spaceabovemethod">- (NSTabView *)tabView</p>
 264 <h5 class="tight">Discussion</h5><p>This class will not function properly if this object is <i>nil</i>.</p>
 265 <h5 class="tight">See Also</h5><ul class="availability">
 266 <li class="availability">  <code><a href="#setTabView">&#8211;&#xA0;setTabView</a></code><li></ul>
 267
 268 <h2>Delegate Methods</h2>
 269
 270 <p class="spaceabove">You application controller can keep track of activity from the tab view and the user via the following delegate methods.<p>
 271
 272 <a name="shouldCloseTabViewItem"></a><h3 class="tight">tabView:shouldCloseTabViewItem:</h3>
 273 <p class="spaceabove">Sent when a user clicks the close button on a tab.  </p><p class="spaceabovemethod">- (BOOL)tabView:(NSTabView *)tabView shouldCloseTabViewItem:(NSTabViewItem *)tabViewItem</p>
 274 <h5 class="tight">Discussion</h5><p>If you return <code>NO</code>, the tab will not be closed.  Please make sure to alert the user as to why with a sheet or dialog.</p>
 275
 276 <a name="willCloseTabViewItem"></a><h3 class="tight">tabView:willCloseTabViewItem:</h3>
 277 <p class="spaceabove">Sent when tab is about to be closed.  </p><p class="spaceabovemethod">- (void)tabView:(NSTabView *)tabView willCloseTabViewItem:(NSTabViewItem *)tabViewItem</p>
 278 <h5 class="tight">Discussion</h5><p>This presents you with an opportunity to clean up the application objects/events/sessions represented by the tab.</p>
 279
 280 <a name="didCloseTabViewItem"></a><h3 class="tight">tabView:didCloseTabViewItem:</h3>
 281 <p class="spaceabove">Sent after a tab has been closed.  </p><p class="spaceabovemethod">- (void)tabView:(NSTabView *)tabView didCloseTabViewItem:(NSTabViewItem *)tabViewItem</p>
 282 <h5 class="tight">Discussion</h5><p>This presents you with an opportunity to clean up the application objects/events/sessions represented by the tab.  Don't go trying to modify the tabViewItem - it is about to be released, and has already been removed from the tabView!</p>
 283
 284 <h3 class="tight">tabView:didSelectTabViewItem:</h3>
 285 <p class="spaceabove">Informs the delegate that <i>tabView</i> has selected <i>tabViewItem</i>.</p><p class="spaceabovemethod">- (void)tabView:(NSTabView *)<i>tabView</i> didSelectTabViewItem:(NSTabViewItem *)<i>tabViewItem</i></p>
 286
 287 <h3 class="tight">tabView:shouldSelectTabViewItem:</h3>
 288 <p class="spaceabove">Invoked just before <i>tabViewItem</i> in <i>tabView</i> is selected.</p><p class="spaceabovemethod">- (BOOL)tabView:(NSTabView *)<i>tabView</i> shouldSelectTabViewItem:(NSTabViewItem *)<i>tabViewItem</i></p>
 289 <h5 class="tight">Discussion</h5><p> The delegate can return <code>NO</code> to prevent selection of specific tabs.</p>
 290
 291 <h3 class="tight">tabView:willSelectTabViewItem:</h3>
 292 <p class="spaceabove">Informs the delegate that <i>tabView</i> is about to select <i>tabViewItem</i>.</p><p class="spaceabovemethod">- (void)tabView:(NSTabView *)<i>tabView</i> willSelectTabViewItem:(NSTabViewItem *)<i>tabViewItem</i></p>
 293
 294 <h3 class="tight">tabViewDidChangeNumberOfTabViewItems:</h3>
 295 <p class="spaceabove">Informs the delegate that the number of tab view items in <i>tabView</i> has changed.</p><p class="spaceabovemethod">- (void)tabViewDidChangeNumberOfTabViewItems:(NSTabView *)<i>tabView</i></p>
 296
 297
 298
 299
 300     </BODY>
 301 </html>