CPPopUpButton Class Reference

#import <CPPopUpButton.h>

Inheritance diagram for CPPopUpButton:

Instance Methods
(void)	- addItem:
(void)	- addItemsWithTitles:
(void)	- addItemWithTitle:
(int)	- indexOfItem:
(int)	- indexOfItemWithRepresentedObject:
(int)	- indexOfItemWithTag:
(int)	- indexOfItemWithTarget:action:
(int)	- indexOfItemWithTitle:
(int)	- indexOfSelectedItem
(id)	- initWithCoder:
(id)	- initWithFrame:
(id)	- initWithFrame:pullsDown:
(void)	- insertItemWithTitle:atIndex:
(CPArray)	- itemArray
(CPMenuItem)	- itemAtIndex:
(CPString)	- itemTitleAtIndex:
(CPArray)	- itemTitles
(CPMenuItem)	- itemWithTitle:
(CPMenuItem)	- lastItem
(void)	- mouseDown:
(int)	- numberOfItems
(id)	- objectValue
(void)	- observeValueForKeyPath:ofObject:change:context:
(CPRectEdge)	- preferredEdge
(BOOL)	- pullsDown
(void)	- removeAllItems
(void)	- removeItemAtIndex:
(void)	- removeItemWithTitle:
(void)	- rightMouseDown:
(CPUInteger)	- selectedIndex
(CPMenuItem)	- selectedItem
(void)	- selectItem:
(void)	- selectItemAtIndex:
(void)	- selectItemWithTag:
(void)	- selectItemWithTitle:
(void)	- setImage:
(void)	- setObjectValue:
(void)	- setPreferredEdge:
(void)	- setPullsDown:
(void)	- setSelectedIndex:
(void)	- setTitle:
(void)	- synchronizeTitleAndSelectedItem
(void)	- takeValueFromKeyPath:ofObjects:
(CPString)	- titleOfSelectedItem
Instance Methods inherited from CPButton
(BOOL)	- allowsMixedState
(CPImage)	- alternateImage
(CPString)	- alternateTitle
(CGRect)	- bezelRectForBounds:
(unsigned)	- bezelStyle
(CGRect)	- contentRectForBounds:
(CPView)	- createEphemeralSubviewNamed:
(void)	- encodeWithCoder:
(CPInteger)	- highlightsBy
(CPImage)	- image
(BOOL)	- imageDimsWhenDisabled
(float)	- imageOffset
(void)	- invalidateTimers
(BOOL)	- isBordered
(CPString)	- keyEquivalent
(unsigned)	- keyEquivalentModifierMask
(void)	- layoutSubviews
(CPInteger)	- nextState
(void)	- onContinousEvent:
(void)	- performClick:
(BOOL)	- performKeyEquivalent:
(CGRect)	- rectForEphemeralSubviewNamed:
(void)	- setAllowsMixedState:
(void)	- setAlternateImage:
(void)	- setAlternateTitle:
(void)	- setBezelStyle:
(void)	- setBordered:
(void)	- setButtonType:
(void)	- setControlSize:
(void)	- setHighlightsBy:
(void)	- setImageDimsWhenDisabled:
(void)	- setImageOffset:
(void)	- setKeyEquivalent:
(void)	- setKeyEquivalentModifierMask:
(void)	- setNextState
(void)	- setPeriodicDelay:interval:
(void)	- setShowsStateBy:
(void)	- setState:
(CPInteger)	- showsStateBy
(void)	- sizeToFit
(BOOL)	- startTrackingAt:
(CPInteger)	- state
(void)	- stopTracking:at:mouseIsUp:
(CPString)	- title
(void)	- viewWillMoveToWindow:
Instance Methods inherited from CPControl
(BOOL)	- acceptsFirstMouse:
(SEL)	- action
(CPTextAlignment)	- alignment
(CPWritingDirection)	- baseWritingDirection
(BOOL)	- continueTracking:at:
(CPControlSize)	- controlSize
(double)	- doubleValue
(float)	- floatValue
(CPFont)	- font
(CPFormatter)	- formatter
(void)	- highlight:
(CPCellImagePosition)	- imagePosition
(CPUInteger)	- imageScaling
(int)	- integerValue
(int)	- intValue
(BOOL)	- isContinuous
(BOOL)	- isEnabled
(BOOL)	- isHighlighted
(CPLineBreakMode)	- lineBreakMode
(unsigned)	- mouseDownFlags
(void)	- mouseEntered:
(void)	- mouseExited:
(BOOL)	- sendAction:to:
(int)	- sendActionOn:
(BOOL)	- sendsActionOnEndEditing
(void)	- setAction:
(void)	- setAlignment:
(void)	- setBaseWritingDirection:
(void)	- setContinuous:
(void)	- setDoubleValue:
(void)	- setEnabled:
(void)	- setFloatValue:
(void)	- setFont:
(void)	- setFormatter:
(void)	- setHighlighted:
(void)	- setImagePosition:
(void)	- setImageScaling:
(void)	- setIntegerValue:
(void)	- setIntValue:
(void)	- setLineBreakMode:
(void)	- setSendsActionOnEndEditing:
(void)	- setStringValue:
(void)	- setTarget:
(void)	- setTextColor:
(void)	- setTextShadowColor:
(void)	- setTextShadowOffset:
(void)	- setVerticalAlignment:
(CPString)	- stringValue
(void)	- takeDoubleValueFrom:
(void)	- takeFloatValueFrom:
(void)	- takeIntegerValueFrom:
(void)	- takeIntValueFrom:
(void)	- takeObjectValueFrom:
(void)	- takeStringValueFrom:
(id)	- target
(CPColor)	- textColor
(void)	- textDidBeginEditing:
(void)	- textDidChange:
(void)	- textDidEndEditing:
(CPColor)	- textShadowColor
(CGSize)	- textShadowOffset
(void)	- trackMouse:
(BOOL)	- tracksMouseOutsideOfFrame
(void)	- unhighlightButtonTimerDidFinish:
(void)	- updateTrackingAreas
(CPTextVerticalAlignment)	- verticalAlignment
Instance Methods inherited from CPView
(void)	- addSubview:
(void)	- addSubview:positioned:relativeTo:
(void)	- addTrackingArea:
(CGRect)	- adjustScroll:
(float)	- alphaValue
(CAAnimation)	- animationForKey:
(CPDictionary)	- animations
(id)	- animator
(BOOL)	- autoresizesSubviews
(unsigned)	- autoresizingMask
(BOOL)	- autoscroll:
(CPColor)	- backgroundColor
(BOOL)	- becomeFirstResponder
(CGRect)	- bounds
(CGPoint)	- boundsOrigin
(CGSize)	- boundsSize
(BOOL)	- canBecomeKeyView
(CGPoint)	- center
(BOOL)	- clipsToBounds
(CGPoint)	- convertPoint:fromView:
(CGPoint)	- convertPoint:toView:
(CGPoint)	- convertPointFromBase:
(CGPoint)	- convertPointToBase:
(CGRect)	- convertRect:fromView:
(CGRect)	- convertRect:toView:
(CGRect)	- convertRectFromBase:
(CGRect)	- convertRectToBase:
(CGSize)	- convertSize:fromView:
(CGSize)	- convertSize:toView:
(CPString)	- debug_description
(void)	- didAddSubview:
(void)	- display
(void)	- displayIfNeeded
(void)	- displayIfNeededInRect:
(void)	- displayRect:
(void)	- displayRectIgnoringOpacity:inContext:
(void)	- dragImage:at:offset:event:pasteboard:source:slideBack:
(void)	- dragView:at:offset:event:pasteboard:source:slideBack:
(void)	- drawRect:
(CPAppearance)	- effectiveAppearance
(CPMenuItem)	- enclosingMenuItem
(CPScrollView)	- enclosingScrollView
(BOOL)	- enterFullScreenMode
(BOOL)	- enterFullScreenMode:withOptions:
(CPView)	- ephemeralSubviewNamed:
(void)	- exitFullScreenMode
(void)	- exitFullScreenModeWithOptions:
(CGRect)	- frame
(CGPoint)	- frameOrigin
(CGRect)	- frameRectOfView:inSuperviewSize:
(CGSize)	- frameSize
(CGRect)	- frameWithNewSuperviewSize:
(BOOL)	- hasCustomDrawRect
(BOOL)	- hasCustomLayoutSubviews
(CPView)	- hitTest:
(BOOL)	- hitTests
(id)	- init
(BOOL)	- inLiveResize
(BOOL)	- isDescendantOf:
(BOOL)	- isFlipped
(BOOL)	- isHidden
(BOOL)	- isHiddenOrHasHiddenAncestor
(BOOL)	- isInFullScreenMode
(BOOL)	- isOpaque
(CALayer)	- layer
(void)	- layout
(CPView)	- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
(void)	- layoutIfNeeded
(void)	- lockFocus
(CPMenu)	- menuForEvent:
(BOOL)	- mouseDownCanMoveWindow
(BOOL)	- needsDisplay
(BOOL)	- needsLayout
(BOOL)	- needsPanelToBecomeKey
(CPView)	- nextKeyView
(CPView)	- nextValidKeyView
(void)	- objectDidChangeTheme
(BOOL)	- postsBoundsChangedNotifications
(BOOL)	- postsFrameChangedNotifications
(CPView)	- previousKeyView
(CPView)	- previousValidKeyView
(void)	- reflectScrolledClipView:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- removeFromSuperview
(void)	- removeTrackingArea:
(void)	- replaceSubview:with:
(BOOL)	- resignFirstResponder
(void)	- resizeSubviewsWithOldSize:
(void)	- resizeWithOldSuperviewSize:
(CGSize)	- scaleSize
(void)	- scaleUnitSquareToSize:
(void)	- scrollClipView:toPoint:
(void)	- scrollPoint:
(void)	- scrollRect:by:
(BOOL)	- scrollRectToVisible:
(void)	- setAlphaValue:
(void)	- setAnimations:
(void)	- setAppearance:
(void)	- setAutoresizesSubviews:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setBounds:
(void)	- setBoundsOrigin:
(void)	- setBoundsSize:
(void)	- setCenter:
(void)	- setClipsToBounds:
(void)	- setDOMClassName:
(void)	- setFrame:
(void)	- setFrameOrigin:
(void)	- setFrameSize:
(void)	- setHidden:
(void)	- setHitTests:
(void)	- setLayer:
(void)	- setNeedsDisplay:
(void)	- setNeedsDisplayInRect:
(void)	- setNeedsLayout
(void)	- setNeedsLayout:
(void)	- setNextKeyView:
(void)	- setPostsBoundsChangedNotifications:
(void)	- setPostsFrameChangedNotifications:
(void)	- setScaleSize:
(void)	- setSubviews:
(void)	- setTag:
(void)	- setThemeClass:
(BOOL)	- setThemeState:
(void)	- setToolTip:
(void)	- setValue:forThemeAttribute:
(void)	- setValue:forThemeAttribute:inState:
(void)	- setWantsLayer:
(CPArray)	- subviews
(CPView)	- superview
(CPInteger)	- tag
(void)	- unlockFocus
(void)	- unregisterDraggedTypes
(BOOL)	- unsetThemeState:
(void)	- viewDidEndLiveResize
(void)	- viewDidHide
(void)	- viewDidLayout
(void)	- viewDidMoveToSuperview
(void)	- viewDidMoveToWindow
(void)	- viewDidUnhide
(void)	- viewWillDraw
(void)	- viewWillLayout
(void)	- viewWillMoveToSuperview:
(void)	- viewWillStartLiveResize
(CPView)	- viewWithTag:
(CGRect)	- visibleRect
(BOOL)	- wantsLayer
(void)	- willRemoveSubview:
(CPWindow)	- window

Class Methods
(CPString)	+ defaultThemeClass
(BOOL)	+ isBindingExclusive:
(CPSet)	+ keyPathsForValuesAffectingSelectedIndex
(CPSet)	+ keyPathsForValuesAffectingSelectedItem
(CPSet)	+ keyPathsForValuesAffectingSelectedTag
Class Methods inherited from CPButton
(id)	+ buttonWithTitle:
(id)	+ buttonWithTitle:theme:
(CPDictionary)	+ themeAttributes
Class Methods inherited from CPControl
(void)	+ initialize
Class Methods inherited from CPView
(Class)	+ animatorClass
(CAAnimation)	+ defaultAnimationForKey:
(CPMenu)	+ defaultMenu
(BOOL)	+ isHighDPIDrawingEnabled
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(void)	+ setHighDPIDrawingEnabled:

Detailed Description

A CPPopUpButton contains a pop-up menu of items that a user can select from.

Definition at line 2 of file CPPopUpButton.h.

Method Documentation

addItem:()

- (void) addItem: (CPMenuItem)  anItem

implementation

Adds a new menu item using a CPMenuItem object.

Definition at line 138 of file CPPopUpButton.j.

addItemsWithTitles:()

- (void) addItemsWithTitles: (CPArray)  titles

implementation

Adds multiple new menu items with the titles specified in the provided array.

Parameters

titles

an array of names for the new items

Definition at line 156 of file CPPopUpButton.j.

addItemWithTitle:()

- (void) addItemWithTitle: (CPString)  aTitle

implementation

Adds a new menu item with the specified title.

Parameters

the	new menu item's title

Definition at line 147 of file CPPopUpButton.j.

defaultThemeClass()

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPButton.

Definition at line 37 of file CPPopUpButton.j.

indexOfItem:()

- (int) indexOfItem: (CPMenuItem)  aMenuItem

implementation

Returns the index of the specified item or CPNotFound if the item is not in the list.

Parameters

aMenuItem

the item to obtain the index for

Definition at line 392 of file CPPopUpButton.j.

indexOfItemWithRepresentedObject:()

- (int) indexOfItemWithRepresentedObject: (id)  anObject

implementation

Returns the index of the item with the specified represented object or CPNotFound if a match does not exist.

Parameters

anObject

the item's represented object

Definition at line 421 of file CPPopUpButton.j.

indexOfItemWithTag:()

- (int) indexOfItemWithTag: (int)  aTag

implementation

Returns the index of the item with the specified tag or CPNotFound if the item is not in the list.

Parameters

aTag	the item's tag

Definition at line 401 of file CPPopUpButton.j.

indexOfItemWithTarget:action:()

- (int) indexOfItemWithTarget: (id)  aTarget action: (SEL)  anAction

implementation

Returns the index of the item with the specified target and action. Returns CPNotFound if the no such item is in the list.

Parameters

aTarget	the item's target
anAction	the item's action

Definition at line 433 of file CPPopUpButton.j.

indexOfItemWithTitle:()

- (int) indexOfItemWithTitle: (CPString)  aTitle

implementation

Returns the index of the item with the specified title or CPNotFound.

Parameters

aTitle

the item's title

Definition at line 410 of file CPPopUpButton.j.

indexOfSelectedItem()

- (int) indexOfSelectedItem

implementation

Returns the index of the selected item. If no item is selected, it returns CPNotFound.

Definition at line 236 of file CPPopUpButton.j.

initWithCoder:()

- (id) initWithCoder: (CPCoder)  aCoder

implementation

Initializes the pop-up button with data from the specified coder.

Parameters

aCoder

the coder from which to read the data

Returns

the initialized pop-up button

Reimplemented from CPButton.

Provided by category CPPopUpButton(CPCoding).

Definition at line 1069 of file CPPopUpButton.j.

initWithFrame:()

- (id) initWithFrame: (CGRect)  aFrame

implementation

Initializes and returns a newly allocated CPButton object with a specified frame rectangle.

Parameters

aFrame

The frame rectangle for the created button object.

Returns

An initialized CPView object or nil if the object couldn't be created.

Reimplemented from CPButton.

Definition at line 90 of file CPPopUpButton.j.

initWithFrame:pullsDown:()

- (id) initWithFrame: (CGRect)  aFrame pullsDown: (BOOL)  shouldPullDown

implementation

Initializes the pop-up button to the specified size.

Parameters

aFrame	the size for the button
shouldPullDown	YES makes this a pull-down menu, NO makes it a pop-up menu.

Returns

the initialized pop-up button

Definition at line 63 of file CPPopUpButton.j.

insertItemWithTitle:atIndex:()

- (void) insertItemWithTitle: (CPString)  aTitle atIndex: (int)  anIndex

implementation

Inserts a new item with the specified title and index location.

Parameters

aTitle	the new item's title
anIndex	the item's index in the menu

Definition at line 170 of file CPPopUpButton.j.

isBindingExclusive:()

+ (BOOL) isBindingExclusive: (CPString)  aBinding

implementation

Provided by category CPPopUpButton(BindingSupport).

Definition at line 793 of file CPPopUpButton.j.

itemArray()

- (CPArray) itemArray

implementation

Returns an array of the items in the menu

Definition at line 330 of file CPPopUpButton.j.

itemAtIndex:()

- (CPMenuItem) itemAtIndex: (CPUInteger)  anIndex

implementation

Returns the item at the specified index or nil if the item does not exist.

Parameters

anIndex

the index of the item to obtain

Definition at line 339 of file CPPopUpButton.j.

itemTitleAtIndex:()

- (CPString) itemTitleAtIndex: (CPUInteger)  anIndex

implementation

Returns the title of the item at the specified index or nil if no item exists.

Parameters

anIndex

the index of the item

Definition at line 348 of file CPPopUpButton.j.

itemTitles()

- (CPArray) itemTitles

implementation

Returns an array of all the menu item titles.

Definition at line 356 of file CPPopUpButton.j.

itemWithTitle:()

- (CPMenuItem) itemWithTitle: (CPString)  aTitle

implementation

Returns the menu item with the specified title.

Parameters

aTitle

the title of the desired menu item

Definition at line 368 of file CPPopUpButton.j.

keyPathsForValuesAffectingSelectedIndex()

+ (CPSet) keyPathsForValuesAffectingSelectedIndex

implementation

Definition at line 42 of file CPPopUpButton.j.

keyPathsForValuesAffectingSelectedItem()

+ (CPSet) keyPathsForValuesAffectingSelectedItem

implementation

Definition at line 52 of file CPPopUpButton.j.

keyPathsForValuesAffectingSelectedTag()

+ (CPSet) keyPathsForValuesAffectingSelectedTag

implementation

Definition at line 47 of file CPPopUpButton.j.

lastItem()

- (CPMenuItem) lastItem

implementation

Returns the last menu item

Definition at line 382 of file CPPopUpButton.j.

mouseDown:()

- (void) mouseDown: (CPEvent)  anEvent

implementation

Reimplemented from CPButton.

Definition at line 660 of file CPPopUpButton.j.

numberOfItems()

- (int) numberOfItems

implementation

Returns a count of the number of items in the button's menu.

Definition at line 322 of file CPPopUpButton.j.

objectValue()

- (id) objectValue

implementation

Returns the receiver's object value.

Reimplemented from CPControl.

Definition at line 294 of file CPPopUpButton.j.

observeValueForKeyPath:ofObject:change:context:()

- (void) observeValueForKeyPath: (CPString)  aKeyPath ofObject: (id)  anObject change: (CPDictionary)  changes context: (id)  aContext

implementation

Definition at line 539 of file CPPopUpButton.j.

preferredEdge()

- (CPRectEdge) preferredEdge

implementation

Returns the button's edge where the pop-up menu will be displayed when there is not enough room to display directly above the button.

Definition at line 444 of file CPPopUpButton.j.

pullsDown()

- (BOOL) pullsDown

implementation

Returns YES if the button is a pull-down menu. NO if the button is a pop-up menu.

Definition at line 128 of file CPPopUpButton.j.

removeAllItems()

- (void) removeAllItems

implementation

Removes all menu items from the pop-up button's menu

Definition at line 185 of file CPPopUpButton.j.

removeItemAtIndex:()

- (void) removeItemAtIndex: (int)  anIndex

implementation

Removes the menu item at the specified index

Parameters

anIndex

the index of the item to remove

Definition at line 205 of file CPPopUpButton.j.

removeItemWithTitle:()

- (void) removeItemWithTitle: (CPString)  aTitle

implementation

Removes a menu item with the specified title from the button.

Parameters

aTitle

the title of the item to remove

Definition at line 195 of file CPPopUpButton.j.

rightMouseDown:()

- (void) rightMouseDown: (CPEvent)  anEvent

implementation

Reimplemented from CPView.

Definition at line 732 of file CPPopUpButton.j.

selectedIndex()

- (CPUInteger) selectedIndex

implementation

Definition at line 265 of file CPPopUpButton.j.

selectedItem()

- (CPMenuItem) selectedItem

implementation

Returns the selected item or nil if no item is selected.

Definition at line 215 of file CPPopUpButton.j.

selectItem:()

- (void) selectItem: (CPMenuItem)  aMenuItem

implementation

Selects the specified menu item.

Parameters

aMenuItem

the item to select

Definition at line 246 of file CPPopUpButton.j.

selectItemAtIndex:()

- (void) selectItemAtIndex: (CPUInteger)  anIndex

implementation

Selects the item at the specified index

Parameters

anIndex

the index of the item to select

Definition at line 255 of file CPPopUpButton.j.

selectItemWithTag:()

- (void) selectItemWithTag: (int)  aTag

implementation

Selects the menu item with the specified tag

Parameters

the	tag of the item to select

Definition at line 303 of file CPPopUpButton.j.

selectItemWithTitle:()

- (void) selectItemWithTitle: (CPString)  aTitle

implementation

Selects the item with the specified title

Parameters

the	title of the item to select

Definition at line 312 of file CPPopUpButton.j.

setImage:()

- (void) setImage: (CPImage)  anImage

implementation

This method has no effect. Because the image is taken from the currently selected item, this method serves no purpose.

Reimplemented from CPButton.

Definition at line 511 of file CPPopUpButton.j.

setObjectValue:()

- (void) setObjectValue: (id)  anIndex

implementation

Selects the item at the specified index

Parameters

anIndex

the index of the item to select

Reimplemented from CPButton.

Definition at line 274 of file CPPopUpButton.j.

setPreferredEdge:()

- (void) setPreferredEdge: (CPRectEdge)  aRectEdge

implementation

Sets the preferred edge of the button to display the pop-up when there is a limited amount of screen space. By default, the pop-up should draw on top of the button.

Definition at line 454 of file CPPopUpButton.j.

setPullsDown:()

- (void) setPullsDown: (BOOL)  shouldPullDown

implementation

Specifies whether the object is a pull-down or a pop-up menu. If the button pulls down the menu items represent actions, not states. So the text in the button will NOT change when the user selects something different.

Parameters

shouldPullDown

YES makes the pop-up button a pull-down menu. NO makes it a pop-up menu.

Definition at line 105 of file CPPopUpButton.j.

setSelectedIndex:()

- (void) setSelectedIndex: (CPUInteger)  anIndex

implementation

Definition at line 260 of file CPPopUpButton.j.

setTitle:()

- (void) setTitle: (CPString)  aTitle

implementation

Sets the pop-up button's title.

Parameters

aTitle

the new title

Reimplemented from CPButton.

Definition at line 464 of file CPPopUpButton.j.

synchronizeTitleAndSelectedItem()

- (void) synchronizeTitleAndSelectedItem

implementation

Makes sure the selected item and the item being displayed are one and the same.

Definition at line 521 of file CPPopUpButton.j.

takeValueFromKeyPath:ofObjects:()

- (void) takeValueFromKeyPath: (CPString)  aKeyPath ofObjects: (CPArray)  objects

implementation

Definition at line 758 of file CPPopUpButton.j.

titleOfSelectedItem()

- (CPString) titleOfSelectedItem

implementation

Returns the title of the selected item or nil if no item is selected.

Definition at line 228 of file CPPopUpButton.j.

---

The documentation for this class was generated from the following files:

• AppKit/CPPopUpButton.h
• AppKit/CPPopUpButton.j