CPToolbar Class Reference
[AppKit]

List of all members.

Public Member Functions

(id) - initWithIdentifier: [implementation]
(void) - setDisplayMode: [implementation]
(CPString- identifier [implementation]
(id) - delegate [implementation]
(BOOL) - isVisible [implementation]
(void) - setVisible: [implementation]
(void) - setDelegate: [implementation]
(CPArray- items [implementation]
(CPArray- visibleItems [implementation]
(CPArray- itemsSortedByVisibilityPriority [implementation]
(id) - initWithCoder: [implementation]
(void) - encodeWithCoder: [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 83 of file CPToolbar.j.


Member Function Documentation

- (id) delegate   [implementation]

Returns the toolbar's delegate

Definition at line 173 of file CPToolbar.j.

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

Definition at line 405 of file CPToolbar.j.

- (CPString) identifier   [implementation]

Returns the toolbar's identifier

Definition at line 165 of file CPToolbar.j.

+ (void) initialize   [implementation]

Definition at line 108 of file CPToolbar.j.

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

Definition at line 375 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 136 of file CPToolbar.j.

- (BOOL) isVisible   [implementation]

Returns YES if the toolbar is currently visible

Definition at line 181 of file CPToolbar.j.

- (CPArray) items   [implementation]

Returns all the items in this toolbar.

Definition at line 293 of file CPToolbar.j.

- (CPArray) itemsSortedByVisibilityPriority   [implementation]

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

Definition at line 309 of file CPToolbar.j.

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

Sets the delegate for the toolbar.

Parameters:
aDelegate the new toolbar delegate

Definition at line 214 of file CPToolbar.j.

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

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

Definition at line 157 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 190 of file CPToolbar.j.

- (CPArray) visibleItems   [implementation]

Returns all the visible items in this toolbar

Definition at line 301 of file CPToolbar.j.


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

Generated on Wed May 20 12:44:01 2009 for Cappuccino by  doxygen 1.5.8