CPToolbarItem Class Reference

#import <CPToolbarItem.h>

Inheritance diagram for CPToolbarItem:

List of all members.

Instance Methods
(SEL)	- action
(CPImage)	- alternateImage
(BOOL)	- autovalidates
(id)	- copy
(void)	- encodeWithCoder:
(CPImage)	- image
(id)	- init
(id)	- initWithCoder:
(id)	- initWithItemIdentifier:
(BOOL)	- isEnabled
(CPString)	- itemIdentifier
(CPString)	- label
(CGSize)	- maxSize
(CGSize)	- minSize
(CPString)	- paletteLabel
(void)	- setAction:
(void)	- setAlternateImage:
(void)	- setAutovalidates:
(void)	- setEnabled:
(void)	- setImage:
(void)	- setLabel:
(void)	- setMaxSize:
(void)	- setMinSize:
(void)	- setPaletteLabel:
(void)	- setTag:
(void)	- setTarget:
(void)	- setToolTip:
(void)	- setView:
(void)	- setVisibilityPriority:
(int)	- tag
(id)	- target
(CPToolbar)	- toolbar
(CPString)	- toolTip
(void)	- validate
(CPView)	- view
(int)	- visibilityPriority

---

Detailed Description

A representation of an item in a CPToolbar.

Definition at line 2 of file CPToolbarItem.h.

---

Method Documentation

- (SEL) action

Returns the action that is triggered when the user clicks this item.

Definition at line 236 of file CPToolbarItem.j.

- (CPImage) alternateImage

Returns the alternate image. This image is displayed on the item when the user is clicking it.

Definition at line 333 of file CPToolbarItem.j.

- (BOOL) autovalidates

Definition at line 478 of file CPToolbarItem.j.

- (id) copy

Definition at line 572 of file CPToolbarItem.j.

- (void) encodeWithCoder:

(CPCoder)

aCoder

Definition at line 541 of file CPToolbarItem.j.

- (CPImage) image

Returns the item's image

Definition at line 283 of file CPToolbarItem.j.

- (id) init

Definition at line 71 of file CPToolbarItem.j.

- (id) initWithCoder:

(CPCoder)

aCoder

Definition at line 508 of file CPToolbarItem.j.

- (id) initWithItemIdentifier:

(CPString)

anItemIdentifier

Initializes the toolbar item with a specified identifier.

Parameters:

anItemIdentifier

the item's identifier

Returns:

the initialized toolbar item

Definition at line 82 of file CPToolbarItem.j.

- (BOOL) isEnabled

Returns YES if the item is enabled.

Definition at line 260 of file CPToolbarItem.j.

- (CPString) itemIdentifier

Returns the item's identifier.

Definition at line 107 of file CPToolbarItem.j.

- (CPString) label

Returns the item's label

Definition at line 129 of file CPToolbarItem.j.

- (CGSize) maxSize

Returns the item's maximum size.

Definition at line 397 of file CPToolbarItem.j.

- (CGSize) minSize

Returns the item's minimum size.

Definition at line 374 of file CPToolbarItem.j.

- (CPString) paletteLabel

Returns the palette label.

Definition at line 146 of file CPToolbarItem.j.

- (void) setAction:

(SEL)

anAction

Sets the action that is triggered when the user clicks this item.

Parameters:

anAction

the new action

Definition at line 248 of file CPToolbarItem.j.

- (void) setAlternateImage:

(CPImage)

anImage

Sets the alternate image. This image is displayed on the item when the user is clicking it.

Parameters:

anImage

the new alternate image

Definition at line 322 of file CPToolbarItem.j.

- (void) setAutovalidates:

(BOOL)

shouldAutovalidate

Definition at line 483 of file CPToolbarItem.j.

- (void) setEnabled:

(BOOL)

shouldBeEnabled

Sets whether the item is enabled.

Parameters:

aFlag

YES enables the item

Definition at line 272 of file CPToolbarItem.j.

- (void) setImage:

(CPImage)

anImage

Sets the item's image.

Parameters:

anImage

the new item image

Definition at line 295 of file CPToolbarItem.j.

- (void) setLabel:

(CPString)

aLabel

Sets the item's label.

Parameters:

aLabel

the new label for the item

Definition at line 138 of file CPToolbarItem.j.

- (void) setMaxSize:

(CGSize)

aMaxSize

Sets the item's new maximum size.

Parameters:

aMaxSize

the new maximum size

Definition at line 406 of file CPToolbarItem.j.

- (void) setMinSize:

(CGSize)

aMinSize

Sets the item's minimum size.

Parameters:

aMinSize

the new minimum size

Definition at line 383 of file CPToolbarItem.j.

- (void) setPaletteLabel:

(CPString)

aPaletteLabel

Sets the palette label

Parameters:

aPaletteLabel

the new palette label

Definition at line 155 of file CPToolbarItem.j.

- (void) setTag:

(int)

aTag

Sets the item's tag.

Parameters:

aTag	the new tag for the item

Definition at line 200 of file CPToolbarItem.j.

- (void) setTarget:

(id)

aTarget

Sets the target of the action that is triggered when the user clicks this item. nil will cause the action to be passed on to the first responder.

Parameters:

aTarget

the new target

Definition at line 224 of file CPToolbarItem.j.

- (void) setToolTip:

(CPString)

aToolTip

Sets the item's tooltip. A tooltip pops up next to the cursor when the user hovers over the item with the mouse.

Parameters:

aToolTip

the new item tool tip

Definition at line 177 of file CPToolbarItem.j.

- (void) setView:

(CPView)

aView

Sets the item's view

Parameters:

aView

the item's new view

Definition at line 353 of file CPToolbarItem.j.

- (void) setVisibilityPriority:

(int)

aVisibilityPriority

Sets the item's visibility priority. The value must be one of:

CPToolbarItemVisibilityPriorityStandard
CPToolbarItemVisibilityPriorityLow
CPToolbarItemVisibilityPriorityHigh
CPToolbarItemVisibilityPriorityUser

Parameters:

aVisiblityPriority

the priority

Definition at line 442 of file CPToolbarItem.j.

- (int) tag

Returns the item's tag.

Definition at line 188 of file CPToolbarItem.j.

- (id) target

Returns the item's action target.

Definition at line 211 of file CPToolbarItem.j.

- (CPToolbar) toolbar

Returns the toolbar of which this item is a part.

Definition at line 115 of file CPToolbarItem.j.

- (CPString) toolTip

Returns the item's tooltip. A tooltip pops up next to the cursor when the user hovers over the item with the mouse.

Definition at line 165 of file CPToolbarItem.j.

- (void) validate

Definition at line 447 of file CPToolbarItem.j.

- (CPView) view

Returns the item's view.

Definition at line 344 of file CPToolbarItem.j.

- (int) visibilityPriority

Returns the item's visibility priority. The value will be one of:

CPToolbarItemVisibilityPriorityStandard
CPToolbarItemVisibilityPriorityLow
CPToolbarItemVisibilityPriorityHigh
CPToolbarItemVisibilityPriorityUser

Definition at line 427 of file CPToolbarItem.j.

---

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

• AppKit/CPToolbarItem.h
• AppKit/CPToolbarItem.j