CPToolbar Class Reference
[AppKit]

List of all members.

Public Member Functions

(id) - delegate [implementation]
(void) - encodeWithCoder: [implementation]
(CPString- identifier [implementation]
(id) - init [implementation]
(id) - initWithCoder: [implementation]
(id) - initWithIdentifier: [implementation]
(BOOL) - isVisible [implementation]
(CPArray- items [implementation]
(CPArray- itemsSortedByVisibilityPriority [implementation]
(void) - setDelegate: [implementation]
(void) - setDisplayMode: [implementation]
(void) - setVisible: [implementation]
(void) - toolbarItemDidChange: [implementation]
(void) - validateVisibleToolbarItems [implementation]
(CPArray- visibleItems [implementation]

Static Public Member Functions

(void) + initialize [implementation]

Detailed Description

A CPToolbar is displayed at the top of a window with multiple buttons (tools) that offer the user quick access to features.

Delegate Methods

-(CPArray)toolbarDefaultItemIdentifiers:(CPToolbar)toolbar; Called to obtain the toolbar's default item identifiers. Required.

Parameters:
toolbar the toolbar to obtain identifiers for
Returns:
an array of default item identifiers in the order on the toolbar

-(CPArray)toolbarAllowedItemIdentifiers:(CPToolbar)toolbar; Called to obtain the toolbar's default item identifiers. Required.

Parameters:
toolbar the toolbar to obtain identifiers for
Returns:
an array of default item identifiers in the order on the toolbar

- (CPToolbarItem)toolbar:(CPToolbar)toolbar itemForItemIdentifier:(CPString)itemIdentifier willBeInsertedIntoToolbar:(BOOL)flag; Called to obtain a toolbar item. Required.

Parameters:
toolbar the toolbar the item belongs to
itemIdentifier the identifier of the toolbar item
flag YES means the item will be placed in the toolbar. NO means the item will be displayed for some other purpose (non-functional)
Returns:
the toolbar item or nil if no such item belongs in the toolbar

Definition at line 85 of file CPToolbar.j.


Member Function Documentation

- (id) delegate   [implementation]

Returns the toolbar's delegate

Definition at line 180 of file CPToolbar.j.

- (void) encodeWithCoder: (CPCoder aCoder   [implementation]

Definition at line 479 of file CPToolbar.j.

- (CPString) identifier   [implementation]

Returns the toolbar's identifier

Definition at line 172 of file CPToolbar.j.

- (id) init   [implementation]

Definition at line 133 of file CPToolbar.j.

+ (void) initialize   [implementation]

Definition at line 110 of file CPToolbar.j.

- (id) initWithCoder: (CPCoder aCoder   [implementation]

Definition at line 436 of file CPToolbar.j.

- (id) initWithIdentifier: (CPString anIdentifier   [implementation]

Initializes the toolbar with the specified identifier.

Parameters:
anIdentifier the identifier for the toolbar
Returns:
the initialized toolbar

Definition at line 143 of file CPToolbar.j.

- (BOOL) isVisible   [implementation]

Returns YES if the toolbar is currently visible

Definition at line 188 of file CPToolbar.j.

- (CPArray) items   [implementation]

Returns all the items in this toolbar.

Definition at line 311 of file CPToolbar.j.

- (CPArray) itemsSortedByVisibilityPriority   [implementation]

Returns the toolbar items sorted by their visibilityPriority(ies).

Definition at line 327 of file CPToolbar.j.

- (void) setDelegate: (id)  aDelegate   [implementation]

Sets the delegate for the toolbar.

Parameters:
aDelegate the new toolbar delegate

Definition at line 221 of file CPToolbar.j.

- (void) setDisplayMode: (CPToolbarDisplayMode)  aDisplayMode   [implementation]

Sets the toolbar's display mode. NOT YET IMPLEMENTED.

Definition at line 164 of file CPToolbar.j.

- (void) setVisible: (BOOL)  aFlag   [implementation]

Sets whether the toolbar should be visible.

Parameters:
aFlag YES makes the toolbar visible

Definition at line 197 of file CPToolbar.j.

- (void) toolbarItemDidChange: (CPToolbarItem anItem   [implementation]

Notifies the toolbar that an item has been changed. This will cause the toolbar to reload its items.

Parameters:
anItem the item that has been changed

Definition at line 394 of file CPToolbar.j.

- (void) validateVisibleToolbarItems   [implementation]

Definition at line 332 of file CPToolbar.j.

- (CPArray) visibleItems   [implementation]

Returns all the visible items in this toolbar

Definition at line 319 of file CPToolbar.j.


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

Generated on Fri Apr 9 11:04:22 2010 for Cappuccino API by  doxygen 1.6.1