API 0.9.5
CPToolbar Class Reference

#import <CPToolbar.h>

Inheritance diagram for CPToolbar:

List of all members.

Instance Methods

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

Class Methods

(void) + initialize

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:
toolbarthe 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:
toolbarthe 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:
toolbarthe toolbar the item belongs to
itemIdentifierthe identifier of the toolbar item
flagYES 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 2 of file CPToolbar.h.


Method Documentation

- (id) delegate

Returns the toolbar's delegate

Definition at line 175 of file CPToolbar.j.

- (void) encodeWithCoder: (CPCoder aCoder

Definition at line 485 of file CPToolbar.j.

- (CPString) identifier

Returns the toolbar's identifier

Definition at line 167 of file CPToolbar.j.

- (id) init

Definition at line 128 of file CPToolbar.j.

+ (void) initialize

Definition at line 105 of file CPToolbar.j.

- (id) initWithCoder: (CPCoder aCoder

Definition at line 435 of file CPToolbar.j.

- (id) initWithIdentifier: (CPString anIdentifier

Initializes the toolbar with the specified identifier.

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

Definition at line 138 of file CPToolbar.j.

- (BOOL) isVisible

Returns YES if the toolbar is currently visible

Definition at line 183 of file CPToolbar.j.

- (CPArray) items

Returns all the items in this toolbar.

Definition at line 306 of file CPToolbar.j.

- (CPArray) itemsSortedByVisibilityPriority

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

Definition at line 322 of file CPToolbar.j.

- (void) setDelegate: (id)  aDelegate

Sets the delegate for the toolbar.

Parameters:
aDelegatethe new toolbar delegate

Definition at line 216 of file CPToolbar.j.

- (void) setDisplayMode: (CPToolbarDisplayMode)  aDisplayMode

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

Definition at line 159 of file CPToolbar.j.

- (void) setVisible: (BOOL)  aFlag

Sets whether the toolbar should be visible.

Parameters:
aFlagYES makes the toolbar visible

Definition at line 192 of file CPToolbar.j.

- (void) toolbarItemDidChange: (CPToolbarItem anItem

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

Parameters:
anItemthe item that has been changed

Definition at line 393 of file CPToolbar.j.

- (void) validateVisibleItems

Validates the visible toolbar items by sending a validate message to each visible toolbar item.

Definition at line 331 of file CPToolbar.j.

- (CPArray) visibleItems

Returns all the visible items in this toolbar

Definition at line 314 of file CPToolbar.j.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines