colby/cappuccino
1
0
Fork 0
mirror of https://github.com/cappuccino/cappuccino.git synced 2026-08-25 04:57:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial conversion to Doxygen style comments.

Browse Source
This commit is contained in:
Ross Boucher
2008-10-12 15:57:01 -07:00
parent 5404b0bbfa
commit f228934e54
75 changed files with 1648 additions and 1591 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AppKit/CPAnimation.j
+18 -16
View File
@@ -47,9 +47,11 @@ CPAnimationLinear = 3;
ACTUAL_FRAME_RATE = 0;
/*
/*! @class CPAnimation
Manages an animation. Contains timing and progress information.
@par Delegate Methods
@delegate -(BOOL)animationShouldStart:(CPAnimation)animation;
Called at the beginning of <code>startAnimation</code>.
@param animation the animation that will start
@@ -86,7 +88,7 @@ ACTUAL_FRAME_RATE = 0;
CPTimer _timer;
}
/*
/*!
Initializes the animation with a duration and animation curve.
@param aDuration the length of the animation
@param anAnimationCurve defines the animation's pace
@@ -106,7 +108,7 @@ ACTUAL_FRAME_RATE = 0;
return self;
}
/*
/*!
Sets the animation's pace.
@param anAnimationCurve the animation's pace
@throws CPInvalidArgumentException if an invalid animation curve is specified
@@ -136,7 +138,7 @@ ACTUAL_FRAME_RATE = 0;
_timingFunction = [CAMediaTimingFunction functionWithName:timingFunctionName];
}
/*
/*!
Returns the animation's pace
*/
- (CPAnimationCurve)animationCurve
@@ -144,7 +146,7 @@ ACTUAL_FRAME_RATE = 0;
return _animationCurve;
}
/*
/*!
Sets the animation's length.
@param aDuration the new animation length
@throws CPInvalidArgumentException if <code>aDuration</code> is negative
@@ -157,7 +159,7 @@ ACTUAL_FRAME_RATE = 0;
_duration = aDuration;
}
/*
/*!
Returns the length of the animation.
*/
- (CPTimeInterval)duration
@@ -165,7 +167,7 @@ ACTUAL_FRAME_RATE = 0;
return _duration;
}
/*
/*!
Sets the animation frame rate. This is not a guaranteed frame rate. 0 means to go as fast as possible.
@param frameRate the new desired frame rate
@throws CPInvalidArgumentException if <code>frameRate</code> is negative
@@ -178,7 +180,7 @@ ACTUAL_FRAME_RATE = 0;
_frameRate = frameRate;
}
/*
/*!
Returns the desired frame rate.
*/
- (float)frameRate
@@ -186,7 +188,7 @@ ACTUAL_FRAME_RATE = 0;
return _frameRate;
}
/*
/*!
Returns the animation's delegate
*/
- (id)delegate
@@ -194,7 +196,7 @@ ACTUAL_FRAME_RATE = 0;
return _delegate;
}
/*
/*!
Sets the animation's delegate.
@param aDelegate the new delegate
*/
@@ -203,7 +205,7 @@ ACTUAL_FRAME_RATE = 0;
_delegate = aDelegate;
}
/*
/*!
Starts the animation. The method calls <code>animationShouldStart:</code>
on the delegate (if it implements it) to see if the animation
should begin.
@@ -247,7 +249,7 @@ ACTUAL_FRAME_RATE = 0;
}
/*
/*!
Stops the animation before it has completed.
*/
- (void)stopAnimation
@@ -262,7 +264,7 @@ ACTUAL_FRAME_RATE = 0;
[_delegate animationDidStop:self];
}
/*
/*!
Returns <code>YES</code> if the animation
is running.
*/
@@ -271,7 +273,7 @@ ACTUAL_FRAME_RATE = 0;
return _timer;
}
/*
/*!
Sets the animation's progress.
@param aProgress the animation's progress
*/
@@ -280,7 +282,7 @@ ACTUAL_FRAME_RATE = 0;
_progress = aProgress;
}
/*
/*!
Returns the animation's progress
*/
- (float)currentProgress
@@ -288,7 +290,7 @@ ACTUAL_FRAME_RATE = 0;
return _progress;
}
/*
/*!
Returns the animation's timing progress.
*/
- (float)currentValue
AppKit/CPApplication.j
+29 -28
View File
@@ -37,7 +37,8 @@ CPRunStoppedResponse = -1000;
CPRunAbortedResponse = -1001;
CPRunContinuesResponse = -1002;
/*
/*! @class CPApplication
CPApplication is THE way to start up the Cappucino framework for your application to use.
Every GUI application has exactly one instance of CPApplication (or of a custom subclass of
CPApplication). Your program's main() function can create that instance by calling the
@@ -81,7 +82,7 @@ CPRunContinuesResponse = -1002;
CPArray _args;
}
/*
/*!
Returns the singleton instance of the running application. If it
doesn't exist, it will be created, and then returned.
@return the application singleton
@@ -94,7 +95,7 @@ CPRunContinuesResponse = -1002;
return CPApp;
}
/*
/*!
Initializes the Document based application with basic menu functions.
Functions are <code>New, Open, Undo, Redo, Save, Cut, Copy, Paste</code>.
@return the initialized application
@@ -174,7 +175,7 @@ CPRunContinuesResponse = -1002;
// Configuring Applications
/*
/*!
Sets the delegate for this application. The delegate will receive various notifications
caused by user interactions during the application's run. The delegate can choose to
react to these events.
@@ -217,7 +218,7 @@ CPRunContinuesResponse = -1002;
object:self];
}
/*
/*!
Returns the application's delegate. The app can only have one delegate at a time.
*/
- (id)delegate
@@ -225,7 +226,7 @@ CPRunContinuesResponse = -1002;
return _delegate;
}
/*
/*!
This method is called by <code>run</code> before the event loop begins.
When it successfully completes, it posts the notification
<objj>CPApplicationDidFinishLaunchingNotification</objj>. If you override
@@ -268,7 +269,7 @@ CPRunContinuesResponse = -1002;
[[CPRunLoop currentRunLoop] performSelectors];
}
/*
/*!
Calls <code>finishLaunching</code> method which results in starting
the main event loop.
*/
@@ -278,7 +279,7 @@ CPRunContinuesResponse = -1002;
}
// Managing the Event Loop
/*
/*!
Starts a modal event loop for <code>aWindow</code>
@param aWindow the window to start the event loop for
*/
@@ -287,7 +288,7 @@ CPRunContinuesResponse = -1002;
[self runModalSession:[self beginModalSessionForWindow:aWindow]];
}
/*
/*!
Stops the event loop started by <code>runModalForWindow:</code> and
sets the code that <code>runModalForWindow:</code> will return.
@param aCode the return code for the modal event
@@ -321,7 +322,7 @@ CPRunContinuesResponse = -1002;
}
}
/*
/*!
Stops the modal event loop
*/
- (void)stopModal
@@ -329,7 +330,7 @@ CPRunContinuesResponse = -1002;
[self stopModalWithCode:CPRunStoppedResponse]
}
/*
/*!
Aborts the event loop started by <code>runModalForWindow:</code>
*/
- (void)abortModal
@@ -337,7 +338,7 @@ CPRunContinuesResponse = -1002;
[self stopModalWithCode:CPRunAbortedResponse];
}
/*
/*!
Sets up a modal session with <code>theWindow</code>.
@param aWindow the window to set up the modal session for
*/
@@ -346,7 +347,7 @@ CPRunContinuesResponse = -1002;
return _CPModalSessionMake(aWindow, 0);
}
/*
/*!
Runs a modal session
@param CPModalSession the session to run
*/
@@ -365,7 +366,7 @@ CPRunContinuesResponse = -1002;
[CPApp setCallback:_CPRunModalLoop forNextEventMatchingMask:CPAnyEventMask untilDate:nil inMode:0 dequeue:NO];
}
/*
/*!
Returns the window for the current modal session. If there is no
modal session, it returns <code>nil</code>.
*/
@@ -386,7 +387,7 @@ CPRunContinuesResponse = -1002;
return NO;
}
/*
/*!
Dispatches events to other objects.
@param anEvent the event to dispatch
*/
@@ -418,7 +419,7 @@ CPRunContinuesResponse = -1002;
[super doCommandBySelector:aSelector];
}
/*
/*!
Returns the key window.
*/
- (CPWindow)keyWindow
@@ -426,7 +427,7 @@ CPRunContinuesResponse = -1002;
return _keyWindow;
}
/*
/*!
Returns the main window.
*/
- (CPWindow)mainWindow
@@ -434,7 +435,7 @@ CPRunContinuesResponse = -1002;
return _mainWindow;
}
/*
/*!
Returns the <objj>CPWindow</objj> object corresponding to <code>aWindowNumber</code>.
*/
- (CPWindow)windowWithWindowNumber:(int)aWindowNumber
@@ -442,7 +443,7 @@ CPRunContinuesResponse = -1002;
return _windows[aWindowNumber];
}
/*
/*!
Returns an array of the application's <objj>CPWindow</objj>s
*/
- (CPArray)windows
@@ -451,7 +452,7 @@ CPRunContinuesResponse = -1002;
}
// Accessing the Main Menu
/*
/*!
Returns the application's main menu
*/
- (CPMenu)mainMenu
@@ -459,7 +460,7 @@ CPRunContinuesResponse = -1002;
return _mainMenu;
}
/*
/*!
Sets the main menu for the application
@param aMenu the menu to set for the application
*/
@@ -469,7 +470,7 @@ CPRunContinuesResponse = -1002;
}
// Posting Actions
/*
/*!
Tries to perform the action with an argument. Performs
the action on itself (if it responds to it), then
tries to perform the action on the delegate.
@@ -496,7 +497,7 @@ CPRunContinuesResponse = -1002;
return NO;
}
/*
/*!
Sends an action to a target.
@param anAction the action to send
@param aTarget the target for the action
@@ -515,7 +516,7 @@ CPRunContinuesResponse = -1002;
return YES;
}
/*
/*!
Finds a target for the specified action. If the
action is <code>nil</code>, returns <code>nil</code>.
If the target is not <code>nil</code>, <code>aTarget</code> is
@@ -537,7 +538,7 @@ CPRunContinuesResponse = -1002;
return [self targetForAction:anAction];
}
/*
/*!
Finds an action-target for a specified window.
It finds a matching target in the following order:
<ol>
@@ -591,7 +592,7 @@ CPRunContinuesResponse = -1002;
return nil;
}
/*
/*!
Looks for a target that can handle the specified action.
Checks for a target in the following order:
<ol>
@@ -646,7 +647,7 @@ CPRunContinuesResponse = -1002;
// Managing Sheets
/*
/*!
Displays a window as a sheet.
@param aSheet the window to display as a sheet
@param aWindow the window that will hold the sheet as a child
@@ -698,7 +699,7 @@ var _CPRunModalLoop = function(anEvent)
[CPApp _removeRunModalLoop];
}
/*
/*!
Starts the GUI and Cappuccino frameworks. This function should be
called from the <code>main()</code> function of your program.
@class CPApplication
AppKit/CPButton.j
+39 -38
View File
@@ -219,7 +219,8 @@ var _CPButtonClassName = nil,
_CPButtonBezelStyleIdentifiers = {},
_CPButtonBezelStyleHighlightedIdentifier = @"Highlighted";
/*
/*! @class CPButton
<objj>CPButton</objj> is a subclass of <objj>CPControl</objj> that
intercepts mouse-down events and sends an action message to a
target object when it's clicked or pressed.
@@ -249,7 +250,7 @@ var _CPButtonClassName = nil,
_CPImageAndTitleView _imageAndTitleView;
}
/*
/*!
Initializes the <objj>CPButton</objj> class.
@ignore
*/
@@ -303,7 +304,7 @@ var _CPButtonClassName = nil,
}
// Configuring Buttons
/*
/*!
Sets how the button highlights and shows its state.
@param aButtonType Defines the behavior of the button.
*/
@@ -338,7 +339,7 @@ var _CPButtonClassName = nil,
return self;
}
/*
/*!
Sets the position of the button's image to <code>anImagePosition</code>.
@param anImagePosition the position for the button's image
*/
@@ -352,7 +353,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Returns the buton's image position
*/
- (CPCellImagePosition)imagePosition
@@ -360,7 +361,7 @@ var _CPButtonClassName = nil,
return _imagePosition;
}
/*
/*!
Sets the button's images scaling method
@param anImageScaling the image scaling method
*/
@@ -374,7 +375,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Returns the button's image scaling method
*/
- (CPImageScaling)imageScaling
@@ -382,7 +383,7 @@ var _CPButtonClassName = nil,
return _imageScaling;
}
/*
/*!
Sets the color of the button's text
@param aColor the color to use for drawing the button text
*/
@@ -393,7 +394,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Sets the font that will be used to draw the button text
@param aFont the font used to draw the button text
*/
@@ -405,7 +406,7 @@ var _CPButtonClassName = nil,
}
// Setting the state
/*
/*!
Returns <code>YES</code> if the button has a 'mixed' state in addition to on and off.
*/
- (BOOL)allowsMixedState
@@ -413,7 +414,7 @@ var _CPButtonClassName = nil,
return _allowsMixedState;
}
/*
/*!
Sets whether the button can have a 'mixed' state.
@param aFlag specifies whether a 'mixed' state is allowed or not
*/
@@ -422,7 +423,7 @@ var _CPButtonClassName = nil,
_allowsMixedState = aFlag;
}
/*
/*!
Sets the button to its next state.
*/
- (void)setNextState
@@ -433,7 +434,7 @@ var _CPButtonClassName = nil,
_state = (_state >= CPOnState && _allowsMixedState) ? CPMixedState : CPOffState;
}
/*
/*!
Sets the button's state to <code>aState</code>.
@param aState Possible states are any of the <objj>CPButton</objj> globals:
<code>CPOffState, CPOnState, CPMixedState</code>
@@ -443,7 +444,7 @@ var _CPButtonClassName = nil,
_state = aState;
}
/*
/*!
Returns the button's current state
*/
- (int)state
@@ -451,7 +452,7 @@ var _CPButtonClassName = nil,
return _state;
}
/*
/*!
Sets the alignment of the text on the button.
@param anAlignment an alignment object
*/
@@ -462,7 +463,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Sets the image that will be drawn on the button.
@param anImage the image that will be drawn
*/
@@ -476,7 +477,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Returns the image that will be drawn on the button
*/
- (CPImage)image
@@ -484,7 +485,7 @@ var _CPButtonClassName = nil,
return _image;
}
/*
/*!
Sets the button's image which is used in its alternate state.
@param anImage the image to be used while the button is in an alternate state
*/
@@ -493,7 +494,7 @@ var _CPButtonClassName = nil,
_alternateImage = anImage;
}
/*
/*!
Returns the image used when the button is in an alternate state.
*/
- (CPImage)alternateImage
@@ -501,7 +502,7 @@ var _CPButtonClassName = nil,
return _alternateImage;
}
/*
/*!
Sets the button's title.
@param aTitle the new title for the button
*/
@@ -515,7 +516,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:_isHighlighted];
}
/*
/*!
Returns the button's title string
*/
- (CPString)title
@@ -523,7 +524,7 @@ var _CPButtonClassName = nil,
return _title;
}
/*
/*!
Lays out the button.
*/
- (void)tile
@@ -547,7 +548,7 @@ var _CPButtonClassName = nil,
[_imageAndTitleView setFrameSize:size];
}
/*
/*!
Compacts the button's frame to fit its contents.
*/
- (void)sizeToFit
@@ -568,7 +569,7 @@ var _CPButtonClassName = nil,
[self setFrameSize:CGSizeMake(CGRectGetWidth(frame), height)];
}
/*
/*!
Sets the frame size for the button.
@param the new frame size
*/
@@ -579,7 +580,7 @@ var _CPButtonClassName = nil,
[self tile];
}
/*
/*!
Highlights the receiver based on <code>aFlag</code>.
@param If <code>YES</code> the button will highlight, <code>NO</code> the button will unhighlight.
*/
@@ -589,7 +590,7 @@ var _CPButtonClassName = nil,
[self drawContentsWithHighlight:aFlag];
}
/*
/*!
Sets button's tag.
@param aTag the button's new tag
*/
@@ -598,7 +599,7 @@ var _CPButtonClassName = nil,
_tag = aTag;
}
/*
/*!
Returns the button's tag.
*/
- (int)tag
@@ -606,7 +607,7 @@ var _CPButtonClassName = nil,
return _tag;
}
/*
/*!
Called when the user clicks on this button.
@param anEvent the event with information about the click
*/
@@ -617,7 +618,7 @@ var _CPButtonClassName = nil,
[self highlight:_isHighlighted];
}
/*
/*!
Called when the user drags on the button.
@param anEvent the event with information about the drag
*/
@@ -628,7 +629,7 @@ var _CPButtonClassName = nil,
[self highlight:_isHighlighted];
}
/*
/*!
Called when the user releases the mouse button
@param anEvent the event with information about the mouse release
*/
@@ -641,7 +642,7 @@ var _CPButtonClassName = nil,
[super mouseUp:anEvent];
}
/*
/*!
Sets the button's control size.
@param aControlSize the button's new control size
*/
@@ -656,7 +657,7 @@ var _CPButtonClassName = nil,
[self _updateTextAttributes];
}
/*
/*!
Returns the button's control size.
*/
- (CPControlSize)controlSize
@@ -664,7 +665,7 @@ var _CPButtonClassName = nil,
return _controlSize;
}
/*
/*!
Sets whether the button has a bezeled border.
@param If <code>YES</code>, the the button will have a bezeled border.
*/
@@ -681,7 +682,7 @@ var _CPButtonClassName = nil,
[self tile];
}
/*
/*!
Returns <code>YES</code> if the border is bezeled.
*/
- (BOOL)isBordered
@@ -689,7 +690,7 @@ var _CPButtonClassName = nil,
return _isBordered;
}
/*
/*!
Sets the button's bezel style.
@param aBezelStye one of the predefined bezel styles
*/
@@ -723,7 +724,7 @@ var _CPButtonClassName = nil,
[self tile];
}
/*
/*!
Returns the current bezel style
*/
- (int)bezelStyle
@@ -826,7 +827,7 @@ var CPButtonImageKey = @"CPButtonImageKey",
@implementation CPButton (CPCoding)
/*
/*!
Initializes the button by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPButton</objj>.
*/
@@ -853,7 +854,7 @@ var CPButtonImageKey = @"CPButtonImageKey",
return self;
}
/*
/*!
Archives this button into the provided coder.
@param aCoder the coder to which the button's instance data will be written.
*/
AppKit/CPClipView.j
+8 -7
View File
@@ -24,7 +24,8 @@ import "CPView.j"
#include "CoreGraphics/CGGeometry.h"
/*
/*! @class CPClipView
<objj>CPClipView</objj> allows you to define a clip rect and display only that portion of its containing view.
It is used to hold the document view in a <objj>CPScrollView</objj>.
*/
@@ -33,7 +34,7 @@ import "CPView.j"
CPView _documentView;
}
/*
/*!
Sets the document view to be <code>aView</code>.
@param aView the new document view. It's frame origin will be changed to <code>(0,0)</code> after calling this method.
*/
@@ -85,7 +86,7 @@ import "CPView.j"
}
}
/*
/*!
Returns the document view.
*/
- (id)documentView
@@ -93,7 +94,7 @@ import "CPView.j"
return _documentView;
}
/*
/*!
Returns a new point that may be adjusted from <code>aPoint</code>
to make sure it lies within the document view.
@param aPoint
@@ -122,7 +123,7 @@ import "CPView.j"
[superview reflectScrolledClipView:self];
}
/*
/*!
Scrolls the clip view to the specified point. The method
sets its bounds origin to <code>aPoint</code>.
*/
@@ -131,7 +132,7 @@ import "CPView.j"
[self setBoundsOrigin:[self constrainScrollPoint:aPoint]];
}
/*
/*!
Handles a <objj>CPViewBoundsDidChangeNotification</objj>.
@param aNotification the notification event
*/
@@ -140,7 +141,7 @@ import "CPView.j"
[self viewFrameChanged:aNotification];
}
/*
/*!
Handles a <objj>CPViewFrameDidChangeNotification</objj>.
@param aNotification the notification event
*/
AppKit/CPCollectionView.j
+42 -37
View File
@@ -28,8 +28,13 @@ import <Foundation/CPKeyedUnarchiver.j>
import <AppKit/CPView.j>
/*
This class presents an array of content as a grid of views.
/*! @class CPCollectionView
This class displays an array as a grid of objects, where each object is represented by a view.
The view is controlled by creating a CPCollectionViewItem and specifying its view, then
setting that item as the collection view prototype.
@par Delegate Methods
@delegate -(void)collectionViewDidChangeSelection:(CPCollectionView)collectionView;
Called when the selection in the collection view has changed.
@@ -110,7 +115,7 @@ import <AppKit/CPView.j>
return self;
}
/*
/*!
Sets the item prototype to <code>anItem</code>
@param anItem the new item prototype
*/
@@ -122,7 +127,7 @@ import <AppKit/CPView.j>
[self reloadContent];
}
/*
/*!
Returns the current item prototype
*/
- (CPCollectionViewItem)itemPrototype
@@ -130,7 +135,7 @@ import <AppKit/CPView.j>
return _itemPrototype;
}
/*
/*!
Returns a collection view item for <code>anObject</code>.
@param anObject the object to be represented.
*/
@@ -150,7 +155,7 @@ import <AppKit/CPView.j>
}
// Working with the Responder Chain
/*
/*!
Returns <code>YES</code> by default.
*/
- (BOOL)acceptsFirstResponder
@@ -158,7 +163,7 @@ import <AppKit/CPView.j>
return YES;
}
/*
/*!
Returns whether the receiver is currently the first responder.
*/
- (BOOL)isFirstResponder
@@ -167,7 +172,7 @@ import <AppKit/CPView.j>
}
// Setting the Content
/*
/*!
Sets the content of the collection view to the content in <code>anArray</code>.
This array can be of any type, and each element will be passed to the <code>setRepresentedObject:</code> method.
It's the responsibility of your custom collection view item to interpret the object.
@@ -183,7 +188,7 @@ import <AppKit/CPView.j>
[self reloadContent];
}
/*
/*!
Returns the collection view content array
*/
- (CPArray)content
@@ -191,7 +196,7 @@ import <AppKit/CPView.j>
return _content;
}
/*
/*!
Returns the collection view items.
*/
- (CPArray)items
@@ -200,7 +205,7 @@ import <AppKit/CPView.j>
}
// Setting the Selection Mode
/*
/*!
Sets whether the user is allowed to select items
@param isSelectable <code>YES</code> allows the user to select items.
*/
@@ -220,7 +225,7 @@ import <AppKit/CPView.j>
}
}
/*
/*!
Returns <code>YES</code> if the collection view is
selected, and <code>NO</code> otherwise.
*/
@@ -229,7 +234,7 @@ import <AppKit/CPView.j>
return _isSelected;
}
/*
/*!
Sets whether the user can select multiple items.
@param shouldAllowMultipleSelection <code>YES</code> allows the user to select multiple items
*/
@@ -238,7 +243,7 @@ import <AppKit/CPView.j>
_allowsMultipleSelection = shouldAllowMultipleSelection;
}
/*
/*!
Returns <code>YES</code> if the user can select multiple items, <code>NO</code> otherwise.
*/
- (BOOL)allowsMultipleSelection
@@ -246,7 +251,7 @@ import <AppKit/CPView.j>
return _allowsMultipleSelection;
}
/*
/*!
Sets the selected items based on the provided indices.
@param anIndexSet the set of items to be selected
*/
@@ -271,7 +276,7 @@ import <AppKit/CPView.j>
[_delegate collectionViewDidChangeSelection:self]
}
/*
/*!
Returns a set of the selected indices.
*/
- (CPIndexSet)selectionIndexes
@@ -382,7 +387,7 @@ import <AppKit/CPView.j>
}
// Laying Out the Collection View
/*
/*!
Sets the maximum number of rows.
@param aMaxNumberOfRows the new maximum number of rows
*/
@@ -396,7 +401,7 @@ import <AppKit/CPView.j>
[self tile];
}
/*
/*!
Returns the maximum number of rows.
*/
- (unsigned)maxNumberOfRows
@@ -404,7 +409,7 @@ import <AppKit/CPView.j>
return _maxNumberOfRows;
}
/*
/*!
Sets the maximum number of columns.
@param aMaxNumberOfColumns the new maximum number of columns
*/
@@ -418,7 +423,7 @@ import <AppKit/CPView.j>
[self tile];
}
/*
/*!
Returns the maximum number of columns
*/
- (unsigned)maxNumberOfColumns
@@ -426,7 +431,7 @@ import <AppKit/CPView.j>
return _maxNumberOfColumns;
}
/*
/*!
Sets the minimum size for an item
@param aSize the new minimum item size
*/
@@ -440,7 +445,7 @@ import <AppKit/CPView.j>
[self tile];
}
/*
/*!
Returns the current minimum item size
*/
- (CGSize)minItemSize
@@ -448,7 +453,7 @@ import <AppKit/CPView.j>
return _minItemSize;
}
/*
/*!
Sets the maximum item size.
@param aSize the new maximum item size
*/
@@ -462,7 +467,7 @@ import <AppKit/CPView.j>
[self tile];
}
/*
/*!
Returns the current maximum item size.
*/
- (CGSize)maxItemSize
@@ -519,7 +524,7 @@ import <AppKit/CPView.j>
slideBack:YES];
}
/*
/*!
Places the selected items on the specified pasteboard. The items are requested from the collection's delegate.
@param aPasteboard the pasteboard to put the items on
@param aType the format the pasteboard data
@@ -541,7 +546,7 @@ import <AppKit/CPView.j>
[self tile];
}
/*
/*!
Sets the collection view's delegate
@param aDelegate the new delegate
*/
@@ -550,7 +555,7 @@ import <AppKit/CPView.j>
_delegate = aDelegate;
}
/*
/*!
Returns the collection view's delegate
*/
- (id)delegate
@@ -560,7 +565,7 @@ import <AppKit/CPView.j>
@end
/*
/*!
Represents an object inside a <objj>CPCollectionView</objj>.
*/
@implementation CPCollectionViewItem : CPObject
@@ -573,7 +578,7 @@ import <AppKit/CPView.j>
}
// Setting the Represented Object
/*
/*!
Sets the object to be represented by this item.
@param anObject the object to be represented
*/
@@ -588,7 +593,7 @@ import <AppKit/CPView.j>
[_view setRepresentedObject:anObject];
}
/*
/*!
Returns the object represented by this view item
*/
- (id)representedObject
@@ -597,7 +602,7 @@ import <AppKit/CPView.j>
}
// Modifying the View
/*
/*!
Sets the view that is used represent this object.
@param aView the view used to represent this object
*/
@@ -606,7 +611,7 @@ import <AppKit/CPView.j>
_view = aView;
}
/*
/*!
Returns the view that represents this object.
*/
- (CPView)view
@@ -615,7 +620,7 @@ import <AppKit/CPView.j>
}
// Modifying the Selection
/*
/*!
Sets whether this view item should be selected.
@param shouldBeSelected <code>YES</code> makes the item selected. <code>NO</code> deselects it.
*/
@@ -630,7 +635,7 @@ import <AppKit/CPView.j>
[_view setSelected:_isSelected];
}
/*
/*!
Returns <code>YES</code> if the item is currently selected. <code>NO</code> if the item is not selected.
*/
- (BOOL)isSelected
@@ -639,7 +644,7 @@ import <AppKit/CPView.j>
}
// Parent Collection View
/*
/*!
Returns the collection view of which this item is a part.
*/
- (CPCollectionView)collectionView
@@ -667,7 +672,7 @@ var CPCollectionViewItemViewKey = @"CPCollectionViewItemViewKey";
@implementation CPCollectionViewItem (CPCoding)
/*
/*!
Initializes the view item by unarchiving data from a coder.
@param aCoder the coder from which the data will be unarchived
@return the initialized collection view item
@@ -682,7 +687,7 @@ var CPCollectionViewItemViewKey = @"CPCollectionViewItemViewKey";
return self;
}
/*
/*!
Archives the colletion view item to the provided coder.
@param aCoder the coder to which the view item should be archived
*/
AppKit/CPColor.j
+31 -30
View File
@@ -36,7 +36,8 @@ var _hueComponent = 0,
_saturationComponent = 1,
_brightnessComponent = 2;
/*
/*! @code CPColor
<code>CPColor</code> can be used to represent color
in an RGB or HSB model with an optional transparency value.</p>
@@ -56,7 +57,7 @@ var _hueComponent = 0,
CPString _cssString;
}
/*
/*!
Creates a color in the RGB color space, with an alpha value.
Each component should be between the range of 0.0 to 1.0. For
the alpha component, a value of 1.0 is opaque, and 0.0 means
@@ -74,7 +75,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[red, green, blue, alpha]];
}
/*
/*!
Creates a new color object with <code>white</code> for the RGB components.
For the alpha component, a value of 1.0 is opaque, and 0.0 means completely transparent.
@@ -88,7 +89,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[white, white, white, alpha]];
}
/*
/*!
Creates a new color in HSB space.
@param hue the hue value
@@ -119,7 +120,7 @@ var _hueComponent = 0,
}
}
/*
/*!
Creates an RGB color from a hexadecimal string. For example,
the a string of "FFFFFF" would return a white CPColor.
"FF0000" would return a pure red, "00FF00" would return a
@@ -134,7 +135,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA: hexToRGB(hex)];
}
/*
/*!
Returns a black color object. (RGBA=[0.0, 0.0, 0.0, 1.0])
*/
+ (CPColor)blackColor
@@ -142,7 +143,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[0.0, 0.0, 0.0, 1.0]];
}
/*
/*!
Returns a blue color object. (RGBA=[0.0, 0.0, 1.0, 1.0])
*/
+ (CPColor)blueColor
@@ -150,7 +151,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[0.0, 0.0, 1.0, 1.0]];
}
/*
/*!
Returns a dark gray color object. (RGBA=[0.33 ,0.33, 0.33, 1.0])
*/
+ (CPColor)darkGrayColor
@@ -158,7 +159,7 @@ var _hueComponent = 0,
return [CPColor colorWithCalibratedWhite:1.0 / 3.0 alpha:1.0];
}
/*
/*!
Returns a gray color object. (RGBA=[0.5, 0.5, 0.5, 1.0])
*/
+ (CPColor)grayColor
@@ -166,7 +167,7 @@ var _hueComponent = 0,
return [CPColor colorWithCalibratedWhite:0.5 alpha: 1.0];
}
/*
/*!
Returns a green color object. (RGBA=[0.0, 1.0, 0.0, 1.0])
*/
+ (CPColor)greenColor
@@ -174,7 +175,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[0.0, 1.0, 0.0, 1.0]];
}
/*
/*!
Returns a light gray color object (RGBA=[0.66, 0.66, 0.66, 1.0])
*/
+ (CPColor)lightGrayColor
@@ -182,7 +183,7 @@ var _hueComponent = 0,
return [CPColor colorWithCalibratedWhite:2.0 / 3.0 alpha:1.0];
}
/*
/*!
Returns a red color object (RGBA=[1.0, 0.0, 0.0, 1.0])
*/
+ (CPColor)redColor
@@ -190,7 +191,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[1.0, 0.0, 0.0, 1.0]];
}
/*
/*!
Returns a white color object (RGBA=[1.0, 1.0, 1.0, 1.0])
*/
+ (CPColor)whiteColor
@@ -198,7 +199,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[1.0, 1.0, 1.0, 1.0]];
}
/*
/*!
Returns a yellow color object (RGBA=[1.0, 1.0, 0.0, 1.0])
*/
+ (CPColor)yellowColor
@@ -206,7 +207,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[1.0, 1.0, 0.0, 1.0]];
}
/*
/*!
Returns a shadow looking color (RGBA=[0.0, 0.0, 0.0, 0.33])
*/
+ (CPColor)shadowColor
@@ -214,7 +215,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithRGBA:[0.0, 0.0, 0.0, 1.0 / 3.0]];
}
/*
/*!
Creates a color using a tile pattern with <code>anImage</code>
@param the image to tile
@return a tiled image color object
@@ -224,7 +225,7 @@ var _hueComponent = 0,
return [[CPColor alloc] _initWithPatternImage:anImage];
}
/*
/*!
Creates a <objj>CPColor</objj> from a valid CSS RGB string. Example, "rgb(32,64,129)".
@param aString a CSS color string
@@ -328,7 +329,7 @@ var _hueComponent = 0,
return self;
}
/*
/*!
Returns the image being used as the pattern for the tile in this color.
*/
- (CPImage)patternImage
@@ -336,7 +337,7 @@ var _hueComponent = 0,
return _patternImage;
}
/*
/*!
Returns the alpha component of this color.
*/
- (float)alphaComponent
@@ -344,7 +345,7 @@ var _hueComponent = 0,
return _components[3];
}
/*
/*!
Returns the blue component of this color.
*/
- (float)blueComponent
@@ -352,7 +353,7 @@ var _hueComponent = 0,
return _components[2];
}
/*
/*!
Returns the green component of this color.
*/
- (float)greenComponent
@@ -360,7 +361,7 @@ var _hueComponent = 0,
return _components[1];
}
/*
/*!
Return the red component of this color.
*/
- (float)redComponent
@@ -368,7 +369,7 @@ var _hueComponent = 0,
return _components[0];
}
/*
/*!
Returns the RGBA components of this color in an array.
The index values are ordered as:
<pre>
@@ -384,7 +385,7 @@ var _hueComponent = 0,
return _components;
}
/*
/*!
Returns a new color with the same RGB as the receiver but a new alpha component.
@param anAlphaComponent the alpha component for the new color
@@ -400,7 +401,7 @@ var _hueComponent = 0,
return [[[self class] alloc] _initWithRGBA:components];
}
/*
/*!
Returns an array with the HSB values for this color.
The index values are ordered as:
<pre>
@@ -451,7 +452,7 @@ var _hueComponent = 0,
];
}
/*
/*!
Returns the CSS representation of this color. The color will
be in one of the following forms:
<pre>
@@ -465,7 +466,7 @@ url("data:image/png;base64,BASE64ENCODEDDATA") // if there is a pattern image
return _cssString;
}
/*
/*!
Returns a 6 character long hex string of this color.
*/
- (CPString)hexString
@@ -480,7 +481,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey",
@implementation CPColor (CPCoding)
/*
/*!
Initializes this color from the data archived in a coder.
@param aCoder the coder from which the color will be loaded
*/
@@ -492,7 +493,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey",
return [self _initWithRGBA:[aCoder decodeObjectForKey:CPColorComponentsKey]];
}
/*
/*!
Archives this color into a coder.
@param aCoder the coder into which the color will be archived.
*/
@@ -508,7 +509,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey",
var hexCharacters = "0123456789ABCDEF";
/*
/*!
Used for the <objj>CPColor</objj> <code>colorWithHexString:</code> implementation
@ignore
@class CPColor
AppKit/CPColorPanel.j
+13 -12
View File
@@ -59,7 +59,8 @@ CPSliderColorPickerMode = 3;
CPColorPickerViewWidth = 265,
CPColorPickerViewHeight = 370;
/*
/*! @class CPColorPanel
<objj>CPColorPanel</objj> provides a reusable panel that can be used
displayed on screen to prompt the user for a color selection. To
obtain the panel, call the <code>sharedColorPanel</code> method.
@@ -88,7 +89,7 @@ CPColorPickerViewHeight = 370;
int _mode;
}
/*
/*!
Returns (and if necessary, creates) the shared color panel.
*/
+ (CPColorPanel)sharedColorPanel
@@ -99,7 +100,7 @@ CPColorPickerViewHeight = 370;
return SharedColorPanel;
}
/*
/*!
Sets the mode for the shared color panel.
@param mode the mode to which the color panel will be set
*/
@@ -133,7 +134,7 @@ CPColorPickerViewHeight = 370;
return self;
}
/*
/*!
Sets the color of the panel, and updates the picker. Also posts a <code>CPColorPanelDidChangeNotification</code>.
*/
- (void)setColor:(CPColor)aColor
@@ -151,7 +152,7 @@ CPColorPickerViewHeight = 370;
object:self];
}
/*
/*!
Sets the selected color of the panel and optionally updates the picker.
@param bool whether or not to update the picker
@ignore
@@ -165,7 +166,7 @@ CPColorPickerViewHeight = 370;
}
/*
/*!
Returns the panel's currently selected color.
*/
- (CPColor)color
@@ -173,7 +174,7 @@ CPColorPickerViewHeight = 370;
return _color;
}
/*
/*!
Sets the target for the color panel. Messages are sent
to the target when colors are selected in the panel.
*/
@@ -182,7 +183,7 @@ CPColorPickerViewHeight = 370;
_target = aTarget;
}
/*
/*!
Returns the current target. The target receives messages
when colors are selected in the panel.
*/
@@ -191,7 +192,7 @@ CPColorPickerViewHeight = 370;
return _target;
}
/*
/*!
Sets the action that gets sent to the target.
This action is sent whenever a color is selected in the panel.
@param anAction the action that will be sent
@@ -201,7 +202,7 @@ CPColorPickerViewHeight = 370;
_action = anAction;
}
/*
/*!
Returns the current target action.
*/
- (selector)action
@@ -209,7 +210,7 @@ CPColorPickerViewHeight = 370;
return _action;
}
/*
/*!
Sets the mode (look) of the color panel.
@param mode the mode in which to display the color panel
*/
@@ -238,7 +239,7 @@ CPColorPickerViewHeight = 370;
[[self contentView] addSubview: _currentView];
}
/*
/*!
Returns the color panel's current display mode.
*/
- (CPColorPanelMode)mode
AppKit/CPColorPicker.j
+6 -5
View File
@@ -25,7 +25,8 @@ import <AppKit/CPView.j>
import <AppKit/CPImage.j>
import <AppKit/CPImageView.j>
/*
/*! @class CPColorPicker
<objj>CPColorPicker</objj> is an abstract superclass for all color picker subclasses. If you want a particular color picker, use <objj>CPColorPanel</objj>'s <code>setPickerMode:</code> method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker.
*/
@implementation CPColorPicker : CPObject
@@ -34,7 +35,7 @@ import <AppKit/CPImageView.j>
int _mask;
}
/*
/*!
Initializes the color picker.
@param aMask a unique unsigned int identifying your color picker
@param aPanel the color panel that owns this picker
@@ -49,7 +50,7 @@ import <AppKit/CPImageView.j>
return self;
}
/*
/*!
Returns the color panel that owns this picker
*/
- (CPColorPanel)colorPanel
@@ -67,7 +68,7 @@ import <AppKit/CPImageView.j>
return nil;
}
/*
/*!
Sets the color picker's mode.
@param mode the color panel mode
*/
@@ -76,7 +77,7 @@ import <AppKit/CPImageView.j>
return;
}
/*
/*!
Sets the picker's color.
@param aColor the new color for the picker
*/
AppKit/CPColorWell.j
+9 -8
View File
@@ -29,7 +29,8 @@ import "CPColorPanel.j"
var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiveNotification";
/*
/*! @class CPColorWell
<objj>CPColorWell</objj> is a <objj>CPControl</objj> for selecting and displaying a single color value. An example of a <objj>CPColorWell</objj> object (or simply color well) is found in <objj>CPColorPanel</objj>, which uses a color well to display the current color selection.</p>
<p>An application can have one or more active <objj>CPColorWell</objj>s. You can activate multiple <objj>CPColorWell</objj>s by invoking the <code>activate:</code> method with <code>NO</code> as its argument. When a mouse-down event occurs on an <objj>CPColorWell</objj>'s border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also.
@@ -75,7 +76,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
// Managing Color From Color Wells
/*
/*!
Returns the color well's current color.
*/
- (CPColor)color
@@ -83,7 +84,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
return _color;
}
/*
/*!
Sets the color well's current color.
*/
- (void)setColor:(CPColor)aColor
@@ -96,7 +97,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
[self drawWellInside:CGRectInset([self bounds], 3.0, 3.0)];
}
/*
/*!
Changes the color of the well to that of <code>aSender</code>.
@param aSender the object from which to retrieve the color
*/
@@ -106,7 +107,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
}
// Activating and Deactivating Color Wells
/*
/*!
Activates the color well, displays the color panel, and makes the panel's current color the same as its own.
If exclusive is <code>YES</code>, deactivates any other <objj>CPColorWell</objj>s. <code>NO</code>, keeps them active.
@param shouldBeExclusive whether other color wells should be deactivated.
@@ -132,7 +133,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
object:[CPColorPanel sharedColorPanel]];
}
/*
/*!
Deactivates the color well.
*/
- (void)deactivate
@@ -148,7 +149,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
object:[CPColorPanel sharedColorPanel]];
}
/*
/*!
Returns <code>YES</code> if the color well is active.
*/
- (BOOL)isActive
@@ -162,7 +163,7 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
{
}
/*
/*!
Draws the colored area inside the color well without borders.
@param aRect the location at which to draw
*/
AppKit/CPControl.j
+27 -26
View File
@@ -75,7 +75,8 @@ CPControlDisabledBackgroundColor = @"CPControlDisabledBackgroundColor";
var CPControlBlackColor = [CPColor blackColor];
/*
/*! @class CPControl
<objj>CPControl</objj> is an abstract superclass used to implement user interface elements. As a subclass of <objj>CPView</objj> and <objj>CPResponder</objj> it has the ability to handle screen drawing and handling user input.
*/
@implementation CPControl : CPView
@@ -118,7 +119,7 @@ var CPControlBlackColor = [CPColor blackColor];
return self;
}
/*
/*!
Sets whether the receiver responds to mouse events.
@param isEnabled whether the receiver will respond to mouse events
*/
@@ -127,7 +128,7 @@ var CPControlBlackColor = [CPColor blackColor];
[self setAlphaValue:(_isEnabled = isEnabled) ? 1.0 : 0.3];
}
/*
/*!
Returns <code>YES</code> if the receiver responds to mouse events.
*/
- (BOOL)isEnabled
@@ -136,7 +137,7 @@ var CPControlBlackColor = [CPColor blackColor];
}
/*
/*!
Sets the color of the receiver's text.
*/
- (void)setTextColor:(CPColor)aColor
@@ -151,7 +152,7 @@ var CPControlBlackColor = [CPColor blackColor];
#endif
}
/*
/*!
Returns the color of the receiver's text
*/
- (CPColor)textColor
@@ -159,7 +160,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _textColor;
}
/*
/*!
Returns the receiver's alignment
*/
- (CPTextAlignment)alignment
@@ -167,7 +168,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _alignment;
}
/*
/*!
Sets the receiver's alignment
@param anAlignment the receiver's alignment
*/
@@ -176,7 +177,7 @@ var CPControlBlackColor = [CPColor blackColor];
_alignment = anAlignment;
}
/*
/*!
Sets the receiver's font
@param aFont the font for the receiver
*/
@@ -192,7 +193,7 @@ var CPControlBlackColor = [CPColor blackColor];
#endif
}
/*
/*!
Returns the receiver's font
*/
- (CPFont)font
@@ -200,7 +201,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _font;
}
/*
/*!
Sets the shadow for the receiver's text.
@param aTextShadow the text shadow
*/
@@ -209,7 +210,7 @@ var CPControlBlackColor = [CPColor blackColor];
_DOMElement.style.textShadow = [_textShadow = aTextShadow cssString];
}
/*
/*!
Returns the receiver's text shadow
*/
- (CPShadow)textShadow
@@ -217,7 +218,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _textShadow;
}
/*
/*!
Returns the receiver's target action
*/
- (SEL)action
@@ -225,7 +226,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _action;
}
/*
/*!
Sets the receiver's target action
@param anAction Sets the action message that gets sent to the target.
*/
@@ -234,7 +235,7 @@ var CPControlBlackColor = [CPColor blackColor];
_action = anAction;
}
/*
/*!
Returns the receiver's target. The target receives action messages from the receiver.
*/
- (id)target
@@ -242,7 +243,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _target;
}
/*
/*!
Sets the receiver's target. The target receives action messages from the receiver.
@param aTarget the object that will receive the message specified by action
*/
@@ -259,7 +260,7 @@ var CPControlBlackColor = [CPColor blackColor];
[super mouseUp:anEvent];
}
/*
/*!
Causes <code>anAction</code> to be sent to <code>anObject</code>.
@param anAction the action to send
@param anObject the object to which the action will be sent
@@ -269,7 +270,7 @@ var CPControlBlackColor = [CPColor blackColor];
[CPApp sendAction:anAction to:anObject from:self];
}
/*
/*!
Returns the receiver's float value
*/
- (float)floatValue
@@ -277,7 +278,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _value ? parseFloat(_value, 10) : 0.0;
}
/*
/*!
Sets the receiver's float value
*/
- (void)setFloatValue:(float)aValue
@@ -285,7 +286,7 @@ var CPControlBlackColor = [CPColor blackColor];
[self setObjectValue:aValue];
}
/*
/*!
Returns the receiver's object value
*/
- (id)objectValue
@@ -293,7 +294,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _value;
}
/*
/*!
Set's the receiver's object value
*/
- (void)setObjectValue:(id)anObject
@@ -301,7 +302,7 @@ var CPControlBlackColor = [CPColor blackColor];
_value = anObject;
}
/*
/*!
Returns the receiver's double value
*/
- (id)doubleValue
@@ -309,7 +310,7 @@ var CPControlBlackColor = [CPColor blackColor];
return [self floatValue];
}
/*
/*!
Set's the receiver's double value
*/
- (void)setDoubleValue:(id)anObject
@@ -317,7 +318,7 @@ var CPControlBlackColor = [CPColor blackColor];
[self setObjectValue:anObject];
}
/*
/*!
Returns the receiver's int value
*/
- (id)intValue
@@ -325,7 +326,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _value ? parseInt(_value, 10) : 0;
}
/*
/*!
Set's the receiver's int value
*/
- (void)setIntValue:(id)anObject
@@ -333,7 +334,7 @@ var CPControlBlackColor = [CPColor blackColor];
[self setObjectValue:anObject];
}
/*
/*!
Returns the receiver's int value
*/
- (id)stringValue
@@ -341,7 +342,7 @@ var CPControlBlackColor = [CPColor blackColor];
return _value ? ""+_value : "";
}
/*
/*!
Set's the receiver's int value
*/
- (void)setStringValue:(id)anObject
AppKit/CPCookie.j
+6 -6
View File
@@ -24,7 +24,7 @@ import <Foundation/CPObject.j>
import <Foundation/CPString.j>
/*
/*! @class CPCookie
<objj>CPCookie</objj> is the Cappuccino interface to a web browser cookie. You can set the name
*/
@implementation CPCookie : CPObject
@@ -35,7 +35,7 @@ import <Foundation/CPString.j>
CPString _expires;
}
/*
/*!
Initializes a cookie with a given name <code>aName</code>.
@param the name for the cookie
*/
@@ -49,7 +49,7 @@ import <Foundation/CPString.j>
return self;
}
/*
/*!
Returns the cookie's data value
*/
- (CPString)value
@@ -57,7 +57,7 @@ import <Foundation/CPString.j>
return _cookieValue;
}
/*
/*!
Returns the cookie's name
*/
- (CPString)name
@@ -65,7 +65,7 @@ import <Foundation/CPString.j>
return _cookieName;
}
/*
/*!
Returns the cookie's expiration date
*/
- (CPString)expires
@@ -73,7 +73,7 @@ import <Foundation/CPString.j>
return _expires;
}
/*
/*!
Sets a value, expiration date, and domain for the cookie
@param value the cookie's value
@param date the cookie's expiration date
AppKit/CPDocument.j
+29 -28
View File
@@ -79,7 +79,8 @@ CPDocumentDidFailToSaveNotification = @"CPDocumentDidFailToSaveNotification";
var CPDocumentUntitledCount = 0;
/*
/*! @class CPDocument
<objj>CPDocument</objj> is used to represent a document/file in a Cappuccino application.
In a document-based application, generally multiple documents are open simutaneously
(multiple text documents, slide presentations, spreadsheets, etc.), and multiple
@@ -101,7 +102,7 @@ var CPDocumentUntitledCount = 0;
CPURLRequest _writeRequest;
}
/*
/*!
Initializes an empty document.
@return the initialized document
*/
@@ -122,7 +123,7 @@ var CPDocumentUntitledCount = 0;
return self;
}
/*
/*!
Initializes the document with a specific data type.
@param aType the type of document to initialize
@param anError not used
@@ -138,7 +139,7 @@ var CPDocumentUntitledCount = 0;
return self;
}
/*
/*!
Initializes a document of a specific type located at a URL. Notifies
the provided delegate after initialization.
@param anAbsoluteURL the url of the document content
@@ -164,7 +165,7 @@ var CPDocumentUntitledCount = 0;
return self;
}
/*
/*!
Initializes the document from a URL.
@param anAbsoluteURL the document location
@param absoluteContentsURL the location of the document's contents
@@ -189,7 +190,7 @@ var CPDocumentUntitledCount = 0;
return self;
}
/*
/*!
Returns the receiver's data in a specified type. The default implementation just
throws an exception.
@param aType the format of the data
@@ -203,7 +204,7 @@ var CPDocumentUntitledCount = 0;
reason:"dataOfType:error: must be overridden by the document subclass."];
}
/*
/*!
Sets the content of the document by reading the provided
data. The default implementation just throws an exception.
@param aData the document's data
@@ -219,7 +220,7 @@ var CPDocumentUntitledCount = 0;
}
// Creating and managing window controllers
/*
/*!
Creates the window controller for this document.
*/
- (void)makeWindowControllers
@@ -229,7 +230,7 @@ var CPDocumentUntitledCount = 0;
[self addWindowController:controller];
}
/*
/*!
Returns the document's window controllers
*/
- (CPArray)windowControllers
@@ -237,7 +238,7 @@ var CPDocumentUntitledCount = 0;
return _windowControllers;
}
/*
/*!
Add a controller to the document's list of controllers. This should
be called after making a new window controller.
@param aWindowController the controller to add
@@ -254,7 +255,7 @@ var CPDocumentUntitledCount = 0;
}
// Managing Document Windows
/*
/*!
Shows all the document's windows.
*/
- (void)showWindows
@@ -262,7 +263,7 @@ var CPDocumentUntitledCount = 0;
[_windowControllers makeObjectsPerformSelector:@selector(showWindow:) withObject:self];
}
/*
/*!
Returns the name of the document as displayed in the title bar.
*/
- (CPString)displayName
@@ -279,7 +280,7 @@ var CPDocumentUntitledCount = 0;
return @"Untitled " + _untitledDocumentIndex;
}
/*
/*!
Returns the document's Cib name
*/
- (CPString)windowCibName
@@ -287,7 +288,7 @@ var CPDocumentUntitledCount = 0;
return nil;
}
/*
/*!
Called after <code>aWindowController<code> loads the document's Nib file.
@param aWindowController the controller that loaded the Nib file
*/
@@ -295,7 +296,7 @@ var CPDocumentUntitledCount = 0;
{
}
/*
/*!
Called before <code>aWindowController</code> will load the document's Nib file.
@param aWindowController the controller that will load the Nib file
*/
@@ -304,7 +305,7 @@ var CPDocumentUntitledCount = 0;
}
// Reading from and Writing to URLs
/*
/*!
Set the document's data from a URL. Notifies the provided delegate afterwards.
@param anAbsoluteURL the URL to the document's content
@param aType the document type
@@ -322,7 +323,7 @@ var CPDocumentUntitledCount = 0;
_readConnection.session = _CPReadSessionMake(aType, aDelegate, aDidReadSelector, aContextInfo);
}
/*
/*!
Returns the path to the document's file.
*/
- (CPURL)fileURL
@@ -330,7 +331,7 @@ var CPDocumentUntitledCount = 0;
return _fileURL;
}
/*
/*!
Sets the path to the document's file.
@param aFileURL the path to the document's file
*/
@@ -344,7 +345,7 @@ var CPDocumentUntitledCount = 0;
[_windowControllers makeObjectsPerformSelector:@selector(synchronizeWindowTitleWithDocumentName)];
}
/*
/*!
Saves the document to the specified URL. Notifies the provided delegate
with the provided selector and context info afterwards.
@param anAbsoluteURL the url to write the document data to
@@ -493,7 +494,7 @@ var CPDocumentUntitledCount = 0;
}
// Managing Document Status
/*
/*!
Returns <code>YES</code> if there are any unsaved changes.
*/
- (BOOL)isDocumentEdited
@@ -501,7 +502,7 @@ var CPDocumentUntitledCount = 0;
return _changeCount != 0;
}
/*
/*!
Updates the number of unsaved changes to the document.
@param aChangeType a new document change to apply
*/
@@ -521,7 +522,7 @@ var CPDocumentUntitledCount = 0;
}
// Managing File Types
/*
/*!
Sets the document's file type
@param aType the document's type
*/
@@ -530,7 +531,7 @@ var CPDocumentUntitledCount = 0;
_fileType = aType;
}
/*
/*!
Returns the document's file type
*/
- (CPString)fileType
@@ -539,7 +540,7 @@ var CPDocumentUntitledCount = 0;
}
// Working with Undo Manager
/*
/*!
Returns <code>YES</code> if the document has a
<objj>CPUndoManager</objj>.
*/
@@ -548,7 +549,7 @@ var CPDocumentUntitledCount = 0;
return _hasUndoManager;
}
/*
/*!
Sets whether the document should have a <objj>CPUndoManager</objj>.
@param aFlag <code>YES</code> makes the document have an undo manager
*/
@@ -632,7 +633,7 @@ var CPDocumentUntitledCount = 0;
}
}
/*
/*!
Returns the document's undo manager. If the document
should have one, but the manager is <code>nil</code>, it
will be created and then returned.
@@ -656,7 +657,7 @@ var CPDocumentUntitledCount = 0;
}
// Handling User Actions
/*
/*!
Saves the document. If the document does not
have a file path to save to (<code>fileURL</code>)
then <code>saveDocumentAs:</code> will be called.
@@ -676,7 +677,7 @@ var CPDocumentUntitledCount = 0;
[self saveDocumentAs:self];
}
/*
/*!
Saves the document to a user specified path.
@param aSender the object requesting the operation
*/
AppKit/CPDocumentController.j
+14 -14
View File
@@ -27,7 +27,7 @@ import "CPDocument.j"
var CPSharedDocumentController = nil;
/*
/*! @class CPDocumentController
This class is responsible for managing an application's open documents.
*/
@implementation CPDocumentController : CPObject
@@ -36,7 +36,7 @@ var CPSharedDocumentController = nil;
CPArray _documentTypes;
}
/*
/*!
Returns the singleton instance of the application's document controller. If it has not
been created yet, it will be created then returned.
@return a <objj>CPDocumentController</objj>
@@ -70,7 +70,7 @@ var CPSharedDocumentController = nil;
// Creating and Opening Documents
/*
/*!
Returns the document matching the specified URL. This
method searches documents already open. It does not
open the document at the URL if it is not already open.
@@ -93,7 +93,7 @@ var CPSharedDocumentController = nil;
return nil;
}
/*
/*!
Creates a new document of the specified type.
@param aType the type of the new document
@param shouldDisplay whether to display the document on screen
@@ -114,7 +114,7 @@ var CPSharedDocumentController = nil;
return theDocument;
}
/*
/*!
Creates a document of the specified type.
@param aType the document type
@param anError not used
@@ -125,7 +125,7 @@ var CPSharedDocumentController = nil;
return [[[self documentClassForType:aType] alloc] initWithType:aType error:anError];
}
/*
/*!
Opens the document at the specified URL.
@param anAbsoluteURL the path to the document's file
@param shouldDisplay whether to display the document on screen
@@ -148,7 +148,7 @@ var CPSharedDocumentController = nil;
return result;
}
/*
/*!
Loads a document for a specified URL with it's content
retrieved from another URL.
@param anAbsoluteURL the document URL
@@ -161,7 +161,7 @@ var CPSharedDocumentController = nil;
return [self makeDocumentForURL:anAbsoluteURL withContentsOfURL:absoluteContentsURL ofType:[[_documentTypes objectAtIndex:0] objectForKey:@"CPBundleTypeName"] delegate:self didReadSelector:@selector(document:didRead:contextInfo:) contextInfo:nil];
}
/*
/*!
Creates a document from the contents at the specified URL.
Notifies the provided delegate with the provided selector afterwards.
@param anAbsoluteURL the location of the document data
@@ -175,7 +175,7 @@ var CPSharedDocumentController = nil;
return [[[self documentClassForType:aType] alloc] initWithContentsOfURL:anAbsoluteURL ofType:aType delegate:aDelegate didReadSelector:aSelector contextInfo:aContextInfo];
}
/*
/*!
Creates a document from the contents of a URL, and sets
the document's URL location as another URL.
@param anAbsoluteURL the document's location
@@ -207,7 +207,7 @@ var CPSharedDocumentController = nil;
[aDocument showWindows];
}
/*
/*!
Opens a new document in the application.
@param aSender the requesting object
*/
@@ -218,7 +218,7 @@ var CPSharedDocumentController = nil;
// Managing Documents
/*
/*!
Returns the array of all documents being managed. This is
the same as all open documents in the application.
*/
@@ -227,7 +227,7 @@ var CPSharedDocumentController = nil;
return _documents;
}
/*
/*!
Adds <code>aDocument</code> under the control of the receiver.
@param aDocument the document to add
*/
@@ -236,7 +236,7 @@ var CPSharedDocumentController = nil;
[_documents addObject:aDocument];
}
/*
/*!
Removes <code>aDocument</code> from the control of the receiver.
@param aDocument the document to remove
*/
@@ -292,7 +292,7 @@ var CPSharedDocumentController = nil;
return nil;
}
/*
/*!
Returns the <objj>CPDocument</objj> subclass associated with <code>aType</code>.
@param aType the type of document
@return a Cappuccino Class object, or <code>nil</code> if no match was found
AppKit/CPDragServer.j
+2 -2
View File
@@ -195,7 +195,7 @@ var CPDragServerUpdateDragging = function(anEvent)
return self;
}
/*
/*!
Initiates a drag session.
@param aView the view being dragged
@param aWindow the window where the drag source is
@@ -250,7 +250,7 @@ var CPDragServerUpdateDragging = function(anEvent)
CPDragServerStartDragging(anEvent);
}
/*
/*!
Initiates a drag session.
@param anImage the image to be dragged
@param aWindow the source window of the drag session
AppKit/CPEvent.j
+21 -21
View File
@@ -178,7 +178,7 @@ CPDOMEventScrollWheel = "mousewheel";
var _CPEventPeriodicEventPeriod = 0,
_CPEventPeriodicEventTimer = nil;
/*
/*! @class CPEvent
<objj>CPEvent</objj> encapsulates the details of a Cappuccino keyboard or mouse event.
*/
@implementation CPEvent : CPObject
@@ -203,7 +203,7 @@ var _CPEventPeriodicEventPeriod = 0,
float _deltaZ;
}
/*
/*!
Creates a new keyboard event.
@param anEventType the event type. Must be one of <objj>CPKeyDown</objj>, <objj>CPKeyUp</objj> or <objj>CPFlagsChanged</objj>
@param aPoint the location of the cursor in the window specified by <code>aWindowNumber</code>
@@ -228,7 +228,7 @@ var _CPEventPeriodicEventPeriod = 0,
characters:characters charactersIgnoringModifiers:unmodCharacters isARepeat:repeatKey keyCode:code];
}
/*
/*!
Creates a new mouse event
@param anEventType the event type
@param aPoint the location of the cursor in the window specified by <code>aWindowNumber</code>
@@ -250,7 +250,7 @@ var _CPEventPeriodicEventPeriod = 0,
timestamp:aTimestamp windowNumber:aWindowNumber context:aGraphicsContext eventNumber:anEventNumber clickCount:aClickCount pressure:aPressure];
}
/*
/*!
Creates a new custom event
@param anEventType the event type. Must be one of <objj>CPAppKitDefined</objj>, <objj>CPSystemDefined</objj>, <objj>CPApplicationDefined</objj> or <objj>CPPeriodic</objj>
@param aLocation the location of the cursor in the window specified by <code>aWindowNumber</code>
@@ -341,7 +341,7 @@ var _CPEventPeriodicEventPeriod = 0,
return self;
}
/*
/*!
Returns the location of the mouse (for mouse events).
If this is not a mouse event, it returns <code>nil</code>.
If <code>window</code> returns <code>nil</code>, then
@@ -354,7 +354,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _location;
}
/*
/*!
Returns event information as a bit mask
*/
- (unsigned)modifierFlags
@@ -362,7 +362,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _modifierFlags;
}
/*
/*!
Returns the time the event occurred
*/
- (CPTimeInterval)timestamp
@@ -370,7 +370,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _timestamp;
}
/*
/*!
Returns the type of event.
*/
- (CPEventType)type
@@ -378,7 +378,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _type;
}
/*
/*!
Returns the event's associated window
*/
- (CPWindow)window
@@ -386,7 +386,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _window;
}
/*
/*!
The number of the window associated with the event.
*/
- (int)windowNumber
@@ -395,7 +395,7 @@ var _CPEventPeriodicEventPeriod = 0,
}
// Mouse Event Information
/*
/*!
Returns the button number for the mouse that generated the event.
*/
- (int)buttonNumber
@@ -403,7 +403,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _buttonNumber;
}
/*
/*!
Returns the number of clicks that caused this event. (mouse only)
*/
- (int)clickCount
@@ -411,7 +411,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _clickCount;
}
/*
/*!
Returns the characters associated with this event (keyboard only)
@throws CPInternalInconsistencyException if this method is called on a non-key event
*/
@@ -420,7 +420,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _characters;
}
/*
/*!
Returns the character ignoring any modifiers (except shift).
@throws CPInternalInconsistencyException if this method is called on a non-key event
*/
@@ -429,7 +429,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _charactersIgnoringModifiers;
}
/*
/*!
Returns <code>YES</code> if the keyboard event was caused by the key being held down.
@throws CPInternalInconsistencyException if this method is called on a non-key event
*/
@@ -438,7 +438,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _isARepeat;
}
/*
/*!
Returns the key's key code.
@throws CPInternalInconsistencyException if this method is called on a non-key event
*/
@@ -461,7 +461,7 @@ var _CPEventPeriodicEventPeriod = 0,
}
// Getting Scroll Wheel Event Infomration
/*
/*!
Returns the change in the x-axis for a mouse event.
*/
- (float)deltaX
@@ -469,7 +469,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _deltaX;
}
/*
/*!
Returns the change in the y-axis for a mouse event.
*/
- (float)deltaY
@@ -477,7 +477,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _deltaY;
}
/*
/*!
Returns the change in the x-axis for a mouse event.
*/
- (float)deltaZ
@@ -485,7 +485,7 @@ var _CPEventPeriodicEventPeriod = 0,
return _deltaZ;
}
/*
/*!
Generates periodic events every <code>aPeriod</code> seconds.
@param aDelay the number of seconds before the first event
@param aPeriod the length of time in seconds between successive events
@@ -498,7 +498,7 @@ var _CPEventPeriodicEventPeriod = 0,
_CPEventPeriodicEventTimer = window.setTimeout(function() { _CPEventPeriodicEventTimer = window.setInterval(_CPEventFirePeriodEvent, aPeriod * 1000.0); }, aDelay * 1000.0);
}
/*
/*!
Stops the periodic events from being generated
*/
+ (void)stopPeriodicEvents
AppKit/CPFont.j
+12 -11
View File
@@ -25,7 +25,8 @@ var _CPFonts = {};
#define _CPCachedFont(aName, aSize, isBold) _CPFonts[(isBold ? @"bold " : @"") + ROUND(aSize) + @"px '" + aName + @"'"]
/*
/*! @class CPFont
The <objj>CPFont</objj> class allows control of the fonts used for displaying text anywhere on the screen. The primary method for getting a particular font is through one of the class methods that take a name and/or size as arguments, and return the appropriate <objj>CPFont</objj>.
*/
@implementation CPFont : CPObject
@@ -37,7 +38,7 @@ var _CPFonts = {};
CPString _cssString;
}
/*
/*!
Returns a font with the specified name and size.
@param aName the name of the font
@param aSize the size of the font (in points)
@@ -48,7 +49,7 @@ var _CPFonts = {};
return _CPCachedFont(aName, aSize, NO) || [[CPFont alloc] _initWithName:aName size:aSize bold:NO];
}
/*
/*!
Returns a bold font with the specified name and size.
@param aName the name of the font
@param aSize the size of the font (in points)
@@ -59,7 +60,7 @@ var _CPFonts = {};
return _CPCachedFont(aName, aSize, YES) || [[CPFont alloc] _initWithName:aName size:aSize bold:YES];
}
/*
/*!
Returns the system font scaled to the specified size
@param aSize the size of the font (in points)
@return the requested system font
@@ -69,7 +70,7 @@ var _CPFonts = {};
return _CPCachedFont(_CPFontSystemFontFace, aSize, NO) || [[CPFont alloc] _initWithName:_CPFontSystemFontFace size:aSize bold:NO];
}
/*
/*!
Returns the bold system font scaled to the specified size
@param aSize the size of the font (in points)
@return the requested bold system font
@@ -79,7 +80,7 @@ var _CPFonts = {};
return _CPCachedFont(_CPFontSystemFontFace, aSize, YES) || [[CPFont alloc] _initWithName:_CPFontSystemFontFace size:aSize bold:YES];
}
/** FIXME Font Descriptor
/* FIXME Font Descriptor
@ignore
*/
- (id)_initWithName:(CPString)aName size:(float)aSize bold:(BOOL)isBold
@@ -100,7 +101,7 @@ var _CPFonts = {};
return self;
}
/*
/*!
Returns the font size (in points)
*/
- (float)size
@@ -108,7 +109,7 @@ var _CPFonts = {};
return _size;
}
/*
/*!
Returns the font as a CSS string
*/
- (CPString)cssString
@@ -116,7 +117,7 @@ var _CPFonts = {};
return _cssString;
}
/*
/*!
Returns the font's family name
*/
- (CPString)familyName
@@ -132,7 +133,7 @@ var CPFontNameKey = @"CPFontNameKey",
@implementation CPFont (CPCoding)
/*
/*!
Initializes the font from a coder.
@param aCoder the coder from which to read the font data
@return the initialized font
@@ -144,7 +145,7 @@ var CPFontNameKey = @"CPFontNameKey",
bold:[aCoder decodeBoolForKey:CPFontIsBoldKey]];
}
/*
/*!
Writes the font information out to a coder.
@param aCoder the coder to which the data will be written
*/
AppKit/CPFontManager.j
+4 -4
View File
@@ -34,7 +34,7 @@ var CPSharedFontManager = nil,
}
// Getting the Shared Font Manager
/*
/*!
Returns the application's font manager. If the font
manager does not exist yet, it will be created.
*/
@@ -47,7 +47,7 @@ var CPSharedFontManager = nil,
}
// Changing the Default Font Conversion Classes
/*
/*!
Sets the class that will be used to create the applcation's
font manager.
*/
@@ -56,7 +56,7 @@ var CPSharedFontManager = nil,
CPFontManagerFactory = aClass;
}
/*
/*!
Returns an array of the available fonts
*/
- (CPArray)availableFonts
@@ -84,7 +84,7 @@ var CPSharedFontManager = nil,
return _availableFonts;
}
/*
/*!
Returns the available fonts matching the provided name.
@param aFontName the name of the font
*/
AppKit/CPGeometry.j
+38 -38
View File
@@ -32,7 +32,7 @@ CPMakePoint = CGPointMake;
CPMakeSize = CGSizeMake;
CPMakeRect = CGRectMake;
/**
/*!
Creates a copy of a specified point and returns the copy
@group CGPoint
@param the point to be copied
@@ -43,7 +43,7 @@ function CPPointCreateCopy(aPoint)
return { x: aPoint.x, y: aPoint.y };
}
/**
/*!
Makes a CGPoint object out of two numbers provided as arguments
@group CGPoint
@param x the x-coordinate of the CGPoint
@@ -55,7 +55,7 @@ function CPPointMake(x, y)
return { x: x, y: y };
}
/*
/*!
Makes a CGRect with an origin and size equal to <code>aRect</code> less the <code>dX/dY</code> insets specified.
@param dX the size of the inset in the x-axis
@param dY the size of the inset in the y-axis
@@ -68,7 +68,7 @@ function CPRectInset(aRect, dX, dY)
aRect.size.width - 2 * dX, aRect.size.height - 2*dY);
}
/*
/*!
@group CGRect
@ignore
@return void
@@ -80,7 +80,7 @@ function CPRectIntegral(aRect)
alert("CPRectIntegral unimplemented");
}
/*
/*!
Returns the intersection of the two provided rectangles as a new rectangle
@group CGRect
@param lhsRect the first rectangle used for calculation
@@ -100,7 +100,7 @@ function CPRectIntersection(lhsRect, rhsRect)
return CPRectIsEmpty(intersection) ? CPRectMakeZero() : intersection;
}
/*
/*!
Creates a copy of the provided rectangle
@group CGRect
@param aRect the CGRect that will be copied
@@ -111,7 +111,7 @@ function CPRectCreateCopy(aRect)
return { origin: CPPointCreateCopy(aRect.origin), size: CPSizeCreateCopy(aRect.size) };
}
/*
/*!
Returns a CGRect made of the specified arguments
@group CGRect
@param x the x-coordinate of the rectangle's origin
@@ -125,7 +125,7 @@ function CPRectMake(x, y, width, height)
return { origin: CPPointMake(x, y), size: CPSizeMake(width, height) };
}
/*
/*!
Creates a new rectangle with its origin offset by <code>dX</code> and <code>dY</code>.
@group CGRect
@param aRect the rectangle to copy the origin and size from
@@ -138,7 +138,7 @@ function CPRectOffset(aRect, dX, dY)
return CPRectMake(aRect.origin.x + dX, aRect.origin.y + dY, aRect.size.width, aRect.size.height);
}
/*
/*!
@group CGRect
@param aRect a CGRect
@return CGRect
@@ -164,7 +164,7 @@ function CPRectStandardize(aRect)
return standardized;
}
/*
/*!
Returns the smallest rectangle that can contain the two argument <code>CGRect</code>s.
@group CGRect
@param lhsRect the first CGRect to use for the union calculation
@@ -181,7 +181,7 @@ function CPRectUnion(lhsRect, rhsRect)
return CPRectMake(minX, minY, maxX - minX, maxY - minY);
}
/*
/*!
Creates and returns a copy of the provided CGSize
@group CGSize
@param aSize the CGSize to copy
@@ -192,7 +192,7 @@ function CPSizeCreateCopy(aSize)
return { width: aSize.width, height: aSize.height };
}
/*
/*!
Creates and returns a new CGSize object from the provided dimensions.
@group CGSize
@param width the width for the new CGSize
@@ -204,7 +204,7 @@ function CPSizeMake(width, height)
return { width: width, height: height };
}
/*
/*!
Returns <code>YES</code> if the <objj>CGRect</objj>, <code>aRect</code>, contains
the <objj>CGPoint</objj>, <code>aPoint</code>.
@param aRect the rectangle to test with
@@ -220,7 +220,7 @@ function CPRectContainsPoint(aRect, aPoint)
aPoint.y < CPRectGetMaxY(aRect);
}
/*
/*!
Returns a <code>BOOL</code> indicating whether <objj>CGRect</objj> <code>possibleOuter</code>
contains <objj>CGRect</objj> <code>possibleInner</code>.
@group CGRect
@@ -233,7 +233,7 @@ function CPRectContainsRect(lhsRect, rhsRect)
return CPRectEqualToRect(CPUnionRect(lhsRect, rhsRect), rhsRect);
}
/*
/*!
Tests whether the two <objj>CGPoint</objj>s are equal to each other by comparing their
<code>x</code> and <code>y</code> members.
@group @CGPoint
@@ -246,7 +246,7 @@ function CPPointEqualToPoint(lhsPoint, rhsPoint)
return lhsPoint.x == rhsPoint.x && lhsPoint.y == rhsPoint.y;
}
/*
/*!
Test whether the two <objj>CGRect</objj>s have the same origin and size
@group CGRect
@param lhsRect the first <objj>CGRect</objj> to compare
@@ -259,7 +259,7 @@ function CPRectEqualToRect(lhsRect, rhsRect)
CPSizeEqualToSize(lhsRect.size, rhsRect.size);
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -269,7 +269,7 @@ function CPRectGetHeight(aRect)
return aRect.size.height;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -279,7 +279,7 @@ function CPRectGetMaxX(aRect)
return aRect.origin.x + aRect.size.width;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -289,7 +289,7 @@ function CPRectGetMaxY(aRect)
return aRect.origin.y + aRect.size.height;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return float
@@ -299,7 +299,7 @@ function CPRectGetMidX(aRect)
return aRect.origin.x + (aRect.size.width) / 2.0;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return float
@@ -309,7 +309,7 @@ function CPRectGetMidY(aRect)
return aRect.origin.y + (aRect.size.height) / 2.0;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -319,7 +319,7 @@ function CPRectGetMinX(aRect)
return aRect.origin.x;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -329,7 +329,7 @@ function CPRectGetMinY(aRect)
return aRect.origin.y;
}
/*
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@return int
@@ -339,7 +339,7 @@ function CPRectGetWidth(aRect)
return aRect.size.width;
}
/*
/*!
Returns <code>YES</code> if the two rectangles intersect
@group CGRect
@param lhsRect the first <objj>CGRect</objj>
@@ -351,7 +351,7 @@ function CPRectIntersectsRect(lhsRect, rhsRect)
return !CPRectIsEmpty(CPRectIntersection(lhsRect, rhsRect));
}
/*
/*!
Returns <code>YES</code> if the <objj>CGRect</objj> has no area.
The test is performed by checking if the width and height are both zero.
@group CGRect
@@ -363,7 +363,7 @@ function CPRectIsEmpty(aRect)
return aRect.size.width <= 0.0 || aRect.size.height <= 0.0;
}
/*
/*!
Returns <code>YES</code> if the <objj>CGRect</objj> has no area.
The test is performed by checking if the width and height are both zero.
@group CGRect
@@ -374,7 +374,7 @@ function CPRectIsNull(aRect)
return aRect.size.width <= 0.0 || aRect.size.height <= 0.0;
}
/*
/*!
Returns <code>YES</code> if the two <objj>CGSize</objj>s are identical.
@group CGSize
@param lhsSize the first <objj>CGSize</objj> to compare
@@ -386,7 +386,7 @@ function CPSizeEqualToSize(lhsSize, rhsSize)
return lhsSize.width == rhsSize.width && lhsSize.height == rhsSize.height;
}
/*
/*!
Returns a human readable string of the provided <objj>CGPoint</objj>.
@group CGPoint
@param aPoint the point to represent
@@ -397,7 +397,7 @@ function CPStringFromPoint(aPoint)
return "{" + aPoint.x + ", " + aPoint.y + "}";
}
/*
/*!
Returns a human readable string of the provided <objj>CGSize</objj>.
@group CGSize
@param aSize the size to represent
@@ -408,7 +408,7 @@ function CPStringFromSize(aSize)
return "{" + aSize.width + ", " + aSize.height + "}";
}
/*
/*!
Returns a human readable string of the provided <objj>CGRect</objj>.
@group CGRect
@param aRect the rectangle to represent
@@ -419,7 +419,7 @@ function CPStringFromRect(aRect)
return "{" + CPStringFromPoint(aRect.origin) + ", " + CPStringFromSize(aRect.size) + "}";
}
/*
/*!
Returns a <objj>CGPoint</objj> from a string with a comma separated pair of integers.
@group CGPoint
@param aString a string containing two comma separated integers
@@ -432,7 +432,7 @@ function CPPointFromString(aString)
return { x:parseInt(aString.substr(1, comma - 1)), y:parseInt(aString.substring(comma + 1, aString.length)) };
}
/*
/*!
Returns a <objj>CGSize</objj> from a string containing a pair of comma separated integers.
@group CGSize
@param aString a string containing two comma separated integers
@@ -445,7 +445,7 @@ function CPSizeFromString(aString)
return { width:parseInt(aString.substr(1, comma - 1)), height:parseInt(aString.substring(comma + 1, aString.length)) };
}
/*
/*!
Returns a <objj>CGRect</objj> created from a string.
@group CGRect
@param aString a string in the form generated by <code>CPStringFromRect</code>
@@ -458,7 +458,7 @@ function CPRectFromString(aString)
return { origin:CPPointFromString(aString.substr(1, comma - 1)), size:CPSizeFromString(aString.substring(comma + 2, aString.length)) };
}
/*
/*!
@group CGPoint
@param anEvent
@return CGPoint
@@ -468,7 +468,7 @@ function CPPointFromEvent(anEvent)
return CPPointMake(anEvent.clientX, anEvent.clientY, 0);
}
/*
/*!
Returns a zero sized <objj>CGSize</objj>.
@group CGSize
@return CGSize a size object with zeros for <code>width</code> and <code>height</code>
@@ -478,7 +478,7 @@ function CPSizeMakeZero()
return CPSizeMake(0, 0);
}
/*
/*!
Returns a rectangle at origin <code>(0,0)</code> and size of <code>(0,0)</code>.
@group CGRect
@return CGRect a zeroed out CGRect
@@ -488,7 +488,7 @@ function CPRectMakeZero()
return CPRectMake(0, 0, 0, 0);
}
/*
/*!
Returns a point located at <code>(0, 0)</code>.
@group CGPoint
@return CGPoint a point located at <code>(0, 0)</code>
AppKit/CPGraphicsContext.j
+6 -6
View File
@@ -22,7 +22,7 @@
var CPGraphicsContextCurrent = nil;
/*
/*!
Provides an interface for drawing to the screen.
*/
@implementation CPGraphicsContext : CPObject
@@ -30,7 +30,7 @@ var CPGraphicsContextCurrent = nil;
CPContext _graphicsPort;
}
/*
/*!
Returns the current graphics context.
*/
+ (CPGraphicsContext)currentContext
@@ -38,7 +38,7 @@ var CPGraphicsContextCurrent = nil;
return CPGraphicsContextCurrent;
}
/*
/*!
Sets the current graphics context
*/
+ (void)setCurrentContext:(CPGraphicsContext)aGraphicsContext
@@ -46,7 +46,7 @@ var CPGraphicsContextCurrent = nil;
CPGraphicsContextCurrent = aGraphicsContext;
}
/*
/*!
Creates a graphics context with a provided port.
@param aContext the context to initialize with
@param aFlag whether the context should be flipped
@@ -57,7 +57,7 @@ var CPGraphicsContextCurrent = nil;
return [[self alloc] initWithGraphicsPort:aContext];
}
/*
/*!
Initializes the context with a graphics port.
@param aGraphicsPort the graphics port to initialize with
@return the initialized context
@@ -72,7 +72,7 @@ var CPGraphicsContextCurrent = nil;
return self;
}
/*
/*!
Returns the graphics context's port.
*/
- (CGContext)graphicsPort
AppKit/CPImage.j
+16 -13
View File
@@ -47,10 +47,13 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
@end
/*
/*! @class CPImage
<objj>CPImage</objj> is used to represent images in the Cappuccino framework. It supports loading
all image types supported by the browser.
@par Delegate Methods
@delegate -(void)imageDidLoad:(CPImage)image;
Called when the specified image has finished loading.
@param image the image that loaded
@@ -74,7 +77,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
Image _image;
}
/*
/*!
Initializes the image, by associating it with a filename. The image
denoted in <code>aFilename</code> is not actually loaded. It will
be loaded once needed.
@@ -96,7 +99,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return self;
}
/*
/*!
Initializes the image. Loads the specified image into memory.
@param aFilename the image to load
@param aSize the size of the image
@@ -112,7 +115,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return self;
}
/*
/*!
Initializes the receiver with the contents of the specified
image file. The method loads the data into memory.
@param aFilename the file name of the image
@@ -128,7 +131,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return self;
}
/*
/*!
Returns the path of the file associated with this image.
*/
- (CPString)filename
@@ -136,7 +139,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return _filename;
}
/*
/*!
Sets the size of the image.
@param the size of the image
*/
@@ -145,7 +148,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
_size = CGSizeMakeCopy(aSize);
}
/*
/*!
Returns the size of the image
*/
- (CGSize)size
@@ -153,7 +156,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return _size;
}
/*
/*!
Sets the receiver's delegate.
@param the delegate
*/
@@ -162,7 +165,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
_delegate = aDelegate;
}
/*
/*!
Returns the receiver's delegate
*/
- (id)delegate
@@ -170,7 +173,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return _delegate;
}
/*
/*!
Returns <code>YES</code> if the image data has already been loaded.
*/
- (BOOL)loadStatus
@@ -178,7 +181,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return _loadStatus;
}
/*
/*!
Loads the image data from the file into memory. You
should not call this method directly. Instead use
one of the initializers.
@@ -259,7 +262,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
@implementation CPImage (CPCoding)
/*
/*!
Initializes the image with data from a coder.
@param aCoder the coder from which to read the image data
@return the initialized image
@@ -269,7 +272,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
return [self initWithContentsOfFile:[aCoder decodeObjectForKey:@"CPFilename"] size:[aCoder decodeSizeForKey:@"CPSize"]];
}
/*
/*!
Writes the image data from memory into the coder.
@param aCoder the coder to which the data will be written
*/
AppKit/CPImageView.j
+13 -12
View File
@@ -58,7 +58,8 @@ var LEFT_SHADOW_INSET = 3.0,
VERTICAL_SHADOW_INSET = TOP_SHADOW_INSET + BOTTOM_SHADOW_INSET,
HORIZONTAL_SHADOW_INSET = LEFT_SHADOW_INSET + RIGHT_SHADOW_INSET;
/*
/*! @class CPImageView
This class is a control that displays an image.
*/
@implementation CPImageView : CPControl
@@ -95,7 +96,7 @@ var LEFT_SHADOW_INSET = 3.0,
return self;
}
/*
/*!
Returns the view's image.
*/
- (CPImage)image
@@ -103,7 +104,7 @@ var LEFT_SHADOW_INSET = 3.0,
return _image;
}
/*
/*!
Sets the image for the view.
@param anImage the view's image
*/
@@ -144,7 +145,7 @@ var LEFT_SHADOW_INSET = 3.0,
[self tile];
}
/*
/*!
Returns <code>YES</code> if the image view draws with
a drop shadow. The default is <code>NO</code>.
*/
@@ -153,7 +154,7 @@ var LEFT_SHADOW_INSET = 3.0,
return _hasShadow;
}
/*
/*!
Sets whether the image view should draw with a drop shadow.
@param shouldHaveShadow whether the image view should have a shadow
*/
@@ -182,7 +183,7 @@ var LEFT_SHADOW_INSET = 3.0,
[self hideOrDisplayContents];
}
/*
/*!
Sets the type of image scaling that should be used to
render the image.
@param anImageScaling the type of scaling to use
@@ -202,7 +203,7 @@ var LEFT_SHADOW_INSET = 3.0,
[self tile];
}
/*
/*!
Returns the image scaling method used to
render this image.
*/
@@ -218,7 +219,7 @@ var LEFT_SHADOW_INSET = 3.0,
[self tile];
}
/*
/*!
Toggles the display of the image view.
*/
- (void)hideOrDisplayContents
@@ -235,7 +236,7 @@ var LEFT_SHADOW_INSET = 3.0,
}
}
/*
/*!
Returns the view's image rectangle
*/
- (CGRect)imageRect
@@ -243,7 +244,7 @@ var LEFT_SHADOW_INSET = 3.0,
return _imageRect;
}
/*
/*!
Add a description
*/
- (void)tile
@@ -328,7 +329,7 @@ var CPImageViewImageKey = @"CPImageViewImageKey",
@implementation CPImageView (CPCoding)
/*
/*!
Initializes the image view with the provided coder.
@param aCoder the coder from which data will be read.
@return the initialized image view
@@ -358,7 +359,7 @@ var CPImageViewImageKey = @"CPImageViewImageKey",
return self;
}
/*
/*!
Writes the image view out to the coder.
@param aCoder the coder to which the image
view will be written
AppKit/CPMenu.j
+42 -41
View File
@@ -48,7 +48,8 @@ var _CPMenuBarVisible = NO,
_CPMenuBarIconImageAlphaValue = 1.0,
_CPMenuBarSharedWindow = nil;
/*
/*! @class CPMenu
Menus provide the user with a list of actions and/or submenus. Submenus themselves are full fledged menus and so a heirarchical structure appears.
*/
@implementation CPMenu : CPObject
@@ -140,7 +141,7 @@ var _CPMenuBarVisible = NO,
}
// Creating a CPMenu Object
/*
/*!
Initializes the menu with a specified title.
@param aTile the menu title
@return the initialized menu
@@ -162,7 +163,7 @@ var _CPMenuBarVisible = NO,
}
// Setting Up Menu Commands
/*
/*!
Inserts a menu item at the specified index.
@param aMenuItem the item to insert
@param anIndex the index in the menu to insert the item.
@@ -187,7 +188,7 @@ var _CPMenuBarVisible = NO,
}
/*
/*!
Creates and inserts a new menu item with the specified attributes.
@param aTitle the title of the menu item
@param anAction the action initiated when the user selects the item
@@ -204,7 +205,7 @@ var _CPMenuBarVisible = NO,
return item;
}
/*
/*!
Adds a menu item at the end of the menu.
@param aMenuItem the menu item to add
*/
@@ -213,7 +214,7 @@ var _CPMenuBarVisible = NO,
[self insertItem:aMenuItem atIndex:[_items count]];
}
/*
/*!
Creates and adds a menu item with the specified attributes
at the end of the menu.
@param aTitle the title of the new menu item
@@ -226,7 +227,7 @@ var _CPMenuBarVisible = NO,
return [self insertItemWithTitle:aTitle action:anAction keyEquivalent:aKeyEquivalent atIndex:[_items count]];
}
/*
/*!
Removes the specified item from the menu
@param aMenuItem the item to remove
*/
@@ -235,7 +236,7 @@ var _CPMenuBarVisible = NO,
[self removeItemAtIndex:[_items indexOfObjectIdenticalTo:aMenuItem]];
}
/*
/*!
Removes the item at the specified index from the menu
@param anIndex the index of the item to remove
*/
@@ -253,7 +254,7 @@ var _CPMenuBarVisible = NO,
userInfo:[CPDictionary dictionaryWithObject:anIndex forKey:@"CPMenuItemIndex"]];
}
/*
/*!
Called when a menu item has visually changed.
@param aMenuItem the item that changed
*/
@@ -269,7 +270,7 @@ var _CPMenuBarVisible = NO,
}
// Finding Menu Items
/*
/*!
Returns the menu item with the specified tag
@param the tag of the desired menu item
@return the menu item or <code>nil</code> if a match was not found
@@ -284,7 +285,7 @@ var _CPMenuBarVisible = NO,
return _items[index];
}
/*
/*!
Returns the menu item with the specified title.
@param aTitle the title of the menu item
@return the menu item or <code>nil</code> if a match was not found
@@ -299,7 +300,7 @@ var _CPMenuBarVisible = NO,
return _items[index];
}
/*
/*!
Returns the menu item at the specified index
@param anIndex the index of the requested item
*/
@@ -308,7 +309,7 @@ var _CPMenuBarVisible = NO,
return [_items objectAtIndex:anIndex];
}
/*
/*!
Returns the number of menu items in the menu
*/
- (unsigned)numberOfItems
@@ -316,7 +317,7 @@ var _CPMenuBarVisible = NO,
return [_items count];
}
/*
/*!
Returns the array of menu items backing this menu
*/
- (CPArray)itemArray
@@ -325,7 +326,7 @@ var _CPMenuBarVisible = NO,
}
// Finding Indices of Menu Items
/*
/*!
Returns the index of the specified menu item
@param aMenuItem the item to find the index for
@return the item index or <objj>CPNotFound</objj>
@@ -338,7 +339,7 @@ var _CPMenuBarVisible = NO,
return [_items indexOfObjectIdenticalTo:aMenuItem];
}
/*
/*!
Returns the index of the item with the specified title.
@param aTitle the desired title to match
@return the index of the item or <objj>CPNotFound</objj>
@@ -355,7 +356,7 @@ var _CPMenuBarVisible = NO,
return CPNotFound;
}
/*
/*!
Returns the index of the item with the specified tag
@param aTag the desired tag to match
@return the index of the item or <objj>CPNotFound</objj>
@@ -372,7 +373,7 @@ var _CPMenuBarVisible = NO,
return CPNotFound;
}
/*
/*!
Returns the index of the item with the specified target and action.
@param aTarget the target of the desired menu item
@param anAction the action of the desired menu item
@@ -394,7 +395,7 @@ var _CPMenuBarVisible = NO,
return CPNotFound;
}
/*
/*!
Returns the index of the menu item with the specified represented object.
@param anObject the represented object of the desired item
@return the index of the item or <objj>CPNotFound</objj>
@@ -411,7 +412,7 @@ var _CPMenuBarVisible = NO,
return CPNotFound;
}
/*
/*!
Returns the index of the item with the specified submenu.
@param the submenu of the desired menu item
@return the index of the item or <objj>CPNotFound</objj>
@@ -429,7 +430,7 @@ var _CPMenuBarVisible = NO,
}
// Managing Submenus
/*
/*!
Sets a submenu for a menu item
@param aMenu the submenu
@param aMenuItem the menu item to set the submenu on
@@ -442,7 +443,7 @@ var _CPMenuBarVisible = NO,
[aMenuItem setSubmenu:aMenu];
}
/*
/*!
The action method of menu items that open submenus.
The default implementation does nothing, but it may
be subclassed to provide different behavior.
@@ -453,7 +454,7 @@ var _CPMenuBarVisible = NO,
}
/*
/*!
Returns the attaced menu, or <code>nil</code> if there isn't one.
*/
- (CPMenu)attachedMenu
@@ -461,7 +462,7 @@ var _CPMenuBarVisible = NO,
return _attachedMenu;
}
/*
/*!
Returns <code>YES</code> if the menu is attached to another menu.
*/
- (BOOL)isAttached
@@ -469,7 +470,7 @@ var _CPMenuBarVisible = NO,
return _isAttached;
}
/*
/*!
Not yet implemented
*/
- (CGPoint)locationOfSubmenu:(CPMenu)aMenu
@@ -477,7 +478,7 @@ var _CPMenuBarVisible = NO,
// FIXME: IMPLEMENT.
}
/*
/*!
Returns the super menu or <code>nil</code> if there is none.
*/
- (CPMenu)supermenu
@@ -485,7 +486,7 @@ var _CPMenuBarVisible = NO,
return _supermenu;
}
/*
/*!
Sets the super menu.
@param aMenu the new super menu
*/
@@ -494,7 +495,7 @@ var _CPMenuBarVisible = NO,
_supermenu = aMenu;
}
/*
/*!
If there are two instances of this menu visible, return <code>NO</code>.
Otherwise, return <code>YES</code> if we are a detached menu and visible.
*/
@@ -504,7 +505,7 @@ var _CPMenuBarVisible = NO,
}
// Enabling and Disabling Menu Items
/*
/*!
Sets whether the menu automatically enables menu items.
@param aFlag <code>YES</code> sets the menu to automatically enable items.
*/
@@ -513,7 +514,7 @@ var _CPMenuBarVisible = NO,
_autoenablesItems = aFlag;
}
/*
/*!
Returns <code>YES</code> if the menu auto enables items.
*/
- (BOOL)autoenablesItems
@@ -521,7 +522,7 @@ var _CPMenuBarVisible = NO,
return _autoenablesItems;
}
/*
/*!
Not implemented.
*/
- (void)update
@@ -530,7 +531,7 @@ var _CPMenuBarVisible = NO,
}
// Managing the Title
/*
/*!
Sets the menu title.
@param the new title
*/
@@ -539,7 +540,7 @@ var _CPMenuBarVisible = NO,
_title = aTitle;
}
/*
/*!
Returns the menu title
*/
- (CPString)title
@@ -607,7 +608,7 @@ var _CPMenuBarVisible = NO,
}
// Managing Display of State Column
/*
/*!
Sets whether to show the state column
@param shouldShowStateColumn <code>YES</code> shows the state column
*/
@@ -616,7 +617,7 @@ var _CPMenuBarVisible = NO,
_showsStateColumn = shouldShowStateColumn;
}
/*
/*!
Returns <code>YES</code> if the menu shows the state column
*/
- (BOOL)showsStateColumn
@@ -625,7 +626,7 @@ var _CPMenuBarVisible = NO,
}
// Handling Highlighting
/*
/*!
Returns the currently highlighted menu item.
@return the highlighted menu item or <code>nil</code> if no item is currently highlighted
*/
@@ -647,7 +648,7 @@ var _CPMenuBarVisible = NO,
}
// Handling Tracking
/*
/*!
Cancels tracking.
*/
- (void)cancelTracking
@@ -661,7 +662,7 @@ var _CPMenuBarVisible = NO,
_menuWindow = aMenuWindow;
}
/*
/*!
Initiates the action of the menu item that
has a keyboard shortcut equivalent to <code>anEvent</code>
@param anEvent the keyboard event
@@ -703,7 +704,7 @@ var _CPMenuBarVisible = NO,
}
// Simulating Mouse Clicks
/*
/*!
Sends the action of the menu item at the specified index.
@param anIndex the index of the item
*/
@@ -747,7 +748,7 @@ var CPMenuTitleKey = @"CPMenuTitleKey",
@implementation CPMenu (CPCoding)
/*
/*!
Initializes the menu with data from the specified coder.
@param aCoder the coder from which to read the data
@return the initialized menu
@@ -765,7 +766,7 @@ var CPMenuTitleKey = @"CPMenuTitleKey",
return self;
}
/*
/*!
Encodes the data of the menu into a coder
@param aCoder the coder to which the data will be written
*/
AppKit/CPMenuItem.j
+58 -57
View File
@@ -28,7 +28,8 @@ import <AppKit/CPImage.j>
import <AppKit/CPMenu.j>
import <AppKit/CPView.j>
/*
/*! @class CPMenuItem
A <objj>CPMenuItem</objj> is added to a <objj>CPMenu</objj>.
It has an action and a target for that action to be sent to
whenever the item is 'activated'.
@@ -73,7 +74,7 @@ import <AppKit/CPView.j>
_CPMenuItemView _menuItemView;
}
/*
/*!
Initializes the menu item with a title, action, and keyboard equivalent.
@param aTitle the menu item's title
@param anAction the action that gets triggered when the item is selected
@@ -103,7 +104,7 @@ import <AppKit/CPView.j>
}
// Enabling a Menu Item
/*
/*!
Sets whether the menu item is enabled or not
@param isEnabled <code>YES</code> enables the item. <code>NO</code> disables it.
*/
@@ -119,7 +120,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns <code>YES</code> if the item is enabled.
*/
- (BOOL)isEnabled
@@ -128,7 +129,7 @@ import <AppKit/CPView.j>
}
// Managing Hidden Status
/*
/*!
Sets whether the item should be hidden. A hidden item can not be triggered by keyboard shortcuts.
@param isHidden <code>YES</code> hides the item. <code>NO</code> reveals it.
*/
@@ -137,7 +138,7 @@ import <AppKit/CPView.j>
_isHidden = isHidden;
}
/*
/*!
Returns <code>YES</code> if the item is hidden.
*/
- (BOOL)isHidden
@@ -145,7 +146,7 @@ import <AppKit/CPView.j>
return _isHidden;
}
/*
/*!
Returns <code>YES</code> if the item is hidden or if one of it's supermenus is hidden.
*/
- (BOOL)isHiddenOrHasHiddenAncestor
@@ -160,7 +161,7 @@ import <AppKit/CPView.j>
}
// Managing Target and Action
/*
/*!
Sets the menu item's action target.
@param aTarget the target for the action
*/
@@ -169,7 +170,7 @@ import <AppKit/CPView.j>
_target = aTarget;
}
/*
/*!
Returns the item's action target
*/
- (id)target
@@ -177,7 +178,7 @@ import <AppKit/CPView.j>
return _target;
}
/*
/*!
Sets the action that gets sent to the item's target when triggered.
@param anAction the action to send
*/
@@ -186,7 +187,7 @@ import <AppKit/CPView.j>
_action = anAction;
}
/*
/*!
Returns the item's action.
*/
- (SEL)action
@@ -195,7 +196,7 @@ import <AppKit/CPView.j>
}
// Managing the Title
/*
/*!
Sets the item's title.
@param aTitle the item's new title
*/
@@ -213,7 +214,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the menu item's title.
*/
- (CPString)title
@@ -221,7 +222,7 @@ import <AppKit/CPView.j>
return _title;
}
/*
/*!
Sets the font for the text of this menu item
@param aFont the font for the menu item
*/
@@ -237,7 +238,7 @@ import <AppKit/CPView.j>
[_menuItemView setDirty];
}
/*
/*!
Returns the menu item's font
*/
- (CPFont)font
@@ -256,7 +257,7 @@ import <AppKit/CPView.j>
*/
// Managing the Tag
/*
/*!
Sets the menu item's tag
@param aTag the tag for the item
*/
@@ -265,7 +266,7 @@ import <AppKit/CPView.j>
_tag = aTag;
}
/*
/*!
Returns the item's tag
*/
- (int)tag
@@ -273,7 +274,7 @@ import <AppKit/CPView.j>
return _tag;
}
/*
/*!
Sets the state of the menu item. Possible states are:
<pre>
<objj>CPMixedState</objj>
@@ -293,7 +294,7 @@ import <AppKit/CPView.j>
[_menuItemView setDirty];
}
/*
/*!
Returns the menu item's current state. Possible states are:
<pre>
<objj>CPMixedState</objj>
@@ -307,7 +308,7 @@ import <AppKit/CPView.j>
}
// Managing the Image
/*
/*!
Sets the menu item's image
@param anImage the menu item's image
*/
@@ -323,7 +324,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the menu item's image
*/
- (CPImage)image
@@ -331,7 +332,7 @@ import <AppKit/CPView.j>
return _image;
}
/*
/*!
Sets the menu item's alternate image
@param anImage the menu item's alternate image
*/
@@ -340,7 +341,7 @@ import <AppKit/CPView.j>
_alternateImage = anImage;
}
/*
/*!
Returns the menu item's alternate image
*/
- (CPImage)alternateImage
@@ -348,7 +349,7 @@ import <AppKit/CPView.j>
return _alternateImage;
}
/*
/*!
Sets the image that is shown when the
menu item is in the 'on' state.
@param anImage the image to show
@@ -362,7 +363,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the image shown when the menu item is in the 'on' state.
*/
- (CPImage)onStateImage
@@ -370,7 +371,7 @@ import <AppKit/CPView.j>
return _onStateImage;
}
/*
/*!
Sets the image that is shown when the menu item is in the 'off' state.
@param anImage the image to show
*/
@@ -383,7 +384,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the image shown when the menu item is in the 'off' state.
*/
- (CPImage)offStateImage
@@ -391,7 +392,7 @@ import <AppKit/CPView.j>
return _offStateImage;
}
/*
/*!
Sets the image that is shown when the menu item is in the 'mixed' state.
@param anImage the image to show
*/
@@ -404,7 +405,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the image shown when the menu item is
in the 'mixed' state.
*/
@@ -414,7 +415,7 @@ import <AppKit/CPView.j>
}
// Managing Subemenus
/*
/*!
Sets the submenu for this item
@param aMenu the submenu
*/
@@ -437,7 +438,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the submenu of the item. <code>nil</code> if there is no submenu.
*/
- (CPMenu)submenu
@@ -445,7 +446,7 @@ import <AppKit/CPView.j>
return _submenu;
}
/*
/*!
Returns <code>YES</code> if the menu item has a submenu.
*/
- (BOOL)hasSubmenu
@@ -455,7 +456,7 @@ import <AppKit/CPView.j>
// Getting a Separator Item
/*
/*!
Returns a new menu item separator.
*/
+ (CPMenuItem)separatorItem
@@ -463,7 +464,7 @@ import <AppKit/CPView.j>
return [[_CPMenuItemSeparator alloc] init];
}
/*
/*!
Returns <code>YES</code> if the menu item is a separator.
*/
- (BOOL)isSeparatorItem
@@ -472,7 +473,7 @@ import <AppKit/CPView.j>
}
// Managing the Owning Menu
/*
/*!
Set the container menu of this item.
@param aMenu the item's container menu
*/
@@ -481,7 +482,7 @@ import <AppKit/CPView.j>
_menu = aMenu;
}
/*
/*!
Returns the container menu of this item
*/
- (CPMenu)menu
@@ -491,7 +492,7 @@ import <AppKit/CPView.j>
//
/*
/*!
Sets the keyboard shortcut for this menu item
@param aString the keyboard shortcut
*/
@@ -500,7 +501,7 @@ import <AppKit/CPView.j>
_keyEquivalent = aString;
}
/*
/*!
Returns the keyboard shortcut for this menu item
*/
- (CPString)keyEquivalent
@@ -508,7 +509,7 @@ import <AppKit/CPView.j>
return _keyEquivalent;
}
/*
/*!
Sets the modifier mask used for the item's keyboard shortcut.
Can be a combination of:
<pre>
@@ -523,7 +524,7 @@ import <AppKit/CPView.j>
_keyEquivalentModifierMask = aMask;
}
/*
/*!
Returns the item's keyboard shortcut modifier mask.
Can be a combination of:
<pre>
@@ -539,7 +540,7 @@ import <AppKit/CPView.j>
}
// Managing Mnemonics
/*
/*!
Sets the index of the mnemonic character in the title. The character
will be underlined and is used as a shortcut for navigation.
@param aLocation the index of the character in the title
@@ -549,7 +550,7 @@ import <AppKit/CPView.j>
_mnemonicLocation = aLocation;
}
/*
/*!
Returns the index of the mnemonic character in the title.
*/
- (unsigned)mnemonicLocation
@@ -557,7 +558,7 @@ import <AppKit/CPView.j>
return _mnemonicLocation;
}
/*
/*!
Sets the title of the menu item and the mnemonic character. The mnemonic chracter should be preceded by an '&'.
@param aTitle the title string with a denoted mnemonic
*/
@@ -574,7 +575,7 @@ import <AppKit/CPView.j>
}
}
/*
/*!
Returns the menu items mnemonic character
*/
- (CPString)mnemonic
@@ -584,7 +585,7 @@ import <AppKit/CPView.j>
// Managing Alternates
/*
/*!
Sets whether this item is an alternate for the previous menu item.
@param isAlternate <code>YES</code> denotes that this menu item is an alternate
*/
@@ -593,7 +594,7 @@ import <AppKit/CPView.j>
_isAlternate = isAlternate;
}
/*
/*!
Returns <code>YES</code> if the menu item is an alternate for the previous item.
*/
- (BOOL)isAlternate
@@ -603,7 +604,7 @@ import <AppKit/CPView.j>
// Managing Indentation Levels
/*
/*!
Sets the indentation level of the menu item. Must be a value between 0 and 15 (inclusive).
@param aLevel the item's new indentation level
@throws CPInvalidArgumentException if aLevel is less than 0
@@ -616,7 +617,7 @@ import <AppKit/CPView.j>
_indentationLevel = MIN(15, aLevel);
}
/*
/*!
Returns the menu item's indentation level. This is a value between 0 and 15 (inclusive).
*/
- (unsigned)indentationLevel
@@ -625,7 +626,7 @@ import <AppKit/CPView.j>
}
// Managing Tool Tips
/*
/*!
Sets the tooltip for the menu item.
@param aToolTip the tool tip for the item
*/
@@ -634,7 +635,7 @@ import <AppKit/CPView.j>
_toolTip = aToolTip;
}
/*
/*!
Returns the item's tooltip
*/
- (CPString)toolTip
@@ -644,7 +645,7 @@ import <AppKit/CPView.j>
// Representing an Object
/*
/*!
Sets the menu item's represented object. This is a kind of tag for the developer. Not a UI feature.
@param anObject the represented object
*/
@@ -653,7 +654,7 @@ import <AppKit/CPView.j>
_representedObject = anObject;
}
/*
/*!
Returns the item's represented object.
*/
- (id)representedObject
@@ -663,7 +664,7 @@ import <AppKit/CPView.j>
// Managing the View
/*
/*!
Sets the view for the menu item
@param aView the menu's item's view
*/
@@ -679,7 +680,7 @@ import <AppKit/CPView.j>
[_menu itemChanged:self];
}
/*
/*!
Returns the menu item's view
*/
- (CPView)view
@@ -689,7 +690,7 @@ import <AppKit/CPView.j>
// Getting Highlighted Status
/*
/*!
Returns <code>YES</code> if the menu item is highlighted.
*/
- (BOOL)isHighlighted
@@ -745,7 +746,7 @@ var CPMenuItemTitleKey = @"CPMenuItemTitleKey",
CPMenuItemRepresentedObjectKey = @"CPMenuItemRepresentedObjectKey";
@implementation CPMenuItem (CPCoding)
/*
/*!
Initializes the menu item from a coder.
@param aCoder the coder from which to initialize
@return the initialized menu item
@@ -796,7 +797,7 @@ var CPMenuItemTitleKey = @"CPMenuItemTitleKey",
return self;
}
/*
/*!
Writes the menu item out to a coder.
@param aCoder the coder to write the menu item out to
*/
AppKit/CPOutlineView.j
+2 -2
View File
@@ -22,7 +22,7 @@
import "CPTableView.j"
/*
/*!
@ignore
This class is a subclass of <objj>CPTableView</objj> which provides the user with a way to display
tree structured data in an outline format. It is particularly useful for displaying hierarchical data
@@ -48,7 +48,7 @@ import "CPTableView.j"
return self;
}
/*
/*!
@ignore
Sets the outline's data source. The data source must implement the following methods:
<pre>
AppKit/CPPanel.j
+7 -6
View File
@@ -26,7 +26,8 @@ import "CPWindow.j"
CPOKButton = 1;
CPCancelButton = 0;
/*
/*! @class CPPanel
The <objj>CPPanel</objj> class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.</p>
<p>Panels behave differently from standard windows in only a small number of ways, but the ways are important to the user interface:</p>
@@ -49,7 +50,7 @@ CPCancelButton = 0;
BOOL _worksWhenModal;
}
/*
/*!
Returns <code>YES</code> if the receiver is a floating panel (like a palette).
*/
- (BOOL)isFloatingPanel
@@ -57,7 +58,7 @@ CPCancelButton = 0;
return [self level] == CPFloatingWindowLevel;
}
/*
/*!
Sets the receiver to be a floating panel. <code>YES</code>
makes the window a floating panel. <code>NO</code> makes it a normal window.
@param isFloatingPanel specifies whether to make it floating
@@ -67,7 +68,7 @@ CPCancelButton = 0;
[self setLevel:isFloatingPanel ? CPFloatingWindowLevel : CPNormalWindowLevel];
}
/*
/*!
Returns <code>YES</code> if the window only becomes key
if needed. <code>NO</code> means it behaves just like other windows.
*/
@@ -76,7 +77,7 @@ CPCancelButton = 0;
return _becomesKeyOnlyIfNeeded;
}
/*
/*!
Sets whether the the window becomes key only if needed.
@param shouldBecomeKeyOnlyIfNeeded <code>YES</code> makes the window become key only if needed
*/
@@ -90,7 +91,7 @@ CPCancelButton = 0;
return _worksWhenModal;
}
/*
/*!
Sets whether this window can receive input while another window is running modally.
@param shouldWorkWhenModal whether to receive input while another window is modal
*/
AppKit/CPPasteboard.j
+15 -14
View File
@@ -42,7 +42,8 @@ CPImagePboardType = @"CPImagePboardType";
var CPPasteboards = nil;
/*
/*! @class CPPasteboard
<objj>CPPasteBoard</objj> is the object responsible for cut/copy/paste and drag&drop operations.
*/
@implementation CPPasteboard : CPObject
@@ -68,7 +69,7 @@ var CPPasteboards = nil;
CPPasteboards = [CPDictionary dictionary];
}
/*
/*!
Returns a new instance of a pasteboard
*/
+ (id)generalPasteboard
@@ -76,7 +77,7 @@ var CPPasteboards = nil;
return [CPPasteboard pasteboardWithName:CPGeneralPboard];
}
/*
/*!
Returns a pasteboard with the specified name. If the pasteboard doesn't exist, it will be created.
@param aName the name of the pasteboard
@return the requested pasteboard
@@ -113,7 +114,7 @@ var CPPasteboards = nil;
return self;
}
/*
/*!
Adds supported data types to the pasteboard
@param types the data types
@param anOwner the object that contains the data types
@@ -140,7 +141,7 @@ var CPPasteboards = nil;
return ++_changeCount;
}
/*
/*!
Sets the data types that this pasteboard will contain.
@param type the data types it will support
@param anOwner the object that contains the the data
@@ -161,7 +162,7 @@ var CPPasteboards = nil;
return ++_changeCount;
}
/*
/*!
Sets the pasteboard data for the specified type
@param aData the data
@param aType the data type being set
@@ -174,7 +175,7 @@ var CPPasteboards = nil;
return YES;
}
/*
/*!
Writes the specified property list as data for the specified type
@param aPropertyList the property list to write
@param aType the data type
@@ -185,7 +186,7 @@ var CPPasteboards = nil;
return [self setData:[CPPropertyListSerialization dataFromPropertyList:aPropertyList format:CPPropertyListXMLFormat_v1_0 errorDescription:nil] forType:aType];
}
/*
/*!
Sets the specified string as data for the specified type
@param aString the string to write
@param aType the data type
@@ -197,7 +198,7 @@ var CPPasteboards = nil;
}
// Determining Types
/*
/*!
Checks the pasteboard's types for a match with the types listen in the specified array. The array should
be ordered by the requestor's most preferred data type first.
@param anArray an array of requested types ordered by preference
@@ -208,7 +209,7 @@ var CPPasteboards = nil;
return [_types firstObjectCommonWithArray:anArray];
}
/*
/*!
Returns the pasteboards supported types
*/
- (CPArray)types
@@ -217,7 +218,7 @@ var CPPasteboards = nil;
}
// Reading data
/*
/*!
Returns the number of changes that have occurred to this pasteboard
*/
- (unsigned)changeCount
@@ -225,7 +226,7 @@ var CPPasteboards = nil;
return _changeCount;
}
/*
/*!
Returns the pasteboard data for the specified data type
@param aType the requested data type
@return the requested data or <code>nil</code> if the data doesn't exist
@@ -251,7 +252,7 @@ var CPPasteboards = nil;
return nil;
}
/*
/*!
Returns the property list for the specified data type
@param aType the requested data type
@return the property list or <code>nil</code> if the list was not found
@@ -266,7 +267,7 @@ var CPPasteboards = nil;
return nil;
}
/*
/*!
Returns the string for the specified data type
@param aType the requested data type
@return the string or <code>nil</code> if the string was not found
AppKit/CPPopUpButton.j
+44 -43
View File
@@ -30,7 +30,8 @@ var VISIBLE_MARGIN = 7.0;
var CPPopUpButtonArrowsImage = nil;
/*
/*! @class CPPopUpButton
A <objj>CPPopUpButton</objj> contains a pop-up menu of items that a user can select from.
*/
@implementation CPPopUpButton : CPButton
@@ -44,7 +45,7 @@ var CPPopUpButtonArrowsImage = nil;
CPMenu _menu;
}
/*
/*!
Initializes the pop-up button to the specified size.
@param aFrame the size for the button
@param shouldPullDown <code>YES</code> makes this a pull-down menu, <code>NO</code> makes it a pop-up menu.
@@ -105,7 +106,7 @@ var CPPopUpButtonArrowsImage = nil;
// Setting the Type of Menu
/*
/*!
Specifies whether the object is a pull-down or a pop-up menu.
@param shouldPullDown <code>YES</code> makes the pop-up button
a pull-down menu. <code>NO</code> makes it a pop-up menu.
@@ -127,7 +128,7 @@ var CPPopUpButtonArrowsImage = nil;
[self synchronizeTitleAndSelectedItem];
}
/*
/*!
Returns <code>YES</code> if the button is a pull-down menu. <code>NO</code> if the button is a pop-up menu.
*/
- (BOOL)pullsDown
@@ -136,7 +137,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Inserting and Deleting Items
/*
/*!
Adds a new menu item with the specified title.
@param the new menu item's tite
*/
@@ -145,7 +146,7 @@ var CPPopUpButtonArrowsImage = nil;
[_menu addItemWithTitle:aTitle action:NULL keyEquivalent:NULL];
}
/*
/*!
Adds multiple new menu items with the titles specified in the provided array.
@param titles an arry of names for the new items
*/
@@ -158,7 +159,7 @@ var CPPopUpButtonArrowsImage = nil;
[self addItemWithTitle:titles[index]];
}
/*
/*!
Inserts a new item with the specified title and index location.
@param aTitle the new itme's title
@param anIndex the item's index in the menu
@@ -175,7 +176,7 @@ var CPPopUpButtonArrowsImage = nil;
[_menu insertItemWithTitle:aTitle action:NULL keyEquivalent:NULL atIndex:anIndex];
}
/*
/*!
Removes all menu items from the pop-up button's menu
*/
- (void)removeAllItems
@@ -186,7 +187,7 @@ var CPPopUpButtonArrowsImage = nil;
[_menu removeItemAtIndex:0];
}
/*
/*!
Removes a menu item with the specified title from the button.
@param aTitle the title of the item to remove
*/
@@ -196,7 +197,7 @@ var CPPopUpButtonArrowsImage = nil;
[self synchronizeTitleAndSelectedItem];
}
/*
/*!
Removes the menu item at the specified index
@param anIndex the index of the item to remove
*/
@@ -207,7 +208,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Getting the User's Selection
/*
/*!
Returns the selected item or <code>nil</code> if no item is selected.
*/
- (CPMenuItem)selectedItem
@@ -218,7 +219,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu itemAtIndex:_selectedIndex];
}
/*
/*!
Returns the title of the selected item or <code>nil</code> if no item is selected.
*/
- (CPString)titleOfSelectedItem
@@ -226,7 +227,7 @@ var CPPopUpButtonArrowsImage = nil;
return [[self selectedItem] title];
}
/*
/*!
Returns the index of the selected item. If no item is selected, it returns <objj>CPNotFound</objj>.
*/
- (int)indexOfSelectedItem
@@ -235,7 +236,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// For us, CPNumber is toll-free bridged to Number, so just return the selected index.
/*
/*!
Returns the selected item's index. If no item is selected, it returns <objj>CPNotFound</objj>.
*/
- (id)objectValue
@@ -244,7 +245,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Setting the Current Selection
/*
/*!
Selects the specified menu item.
@param aMenuItem the item to select
*/
@@ -253,7 +254,7 @@ var CPPopUpButtonArrowsImage = nil;
[self selectItemAtIndex:[self indexOfItem:aMenuItem]];
}
/*
/*!
Selects the item at the specified index
@param anIndex the index of the item to select
*/
@@ -273,7 +274,7 @@ var CPPopUpButtonArrowsImage = nil;
[self synchronizeTitleAndSelectedItem];
}
/*
/*!
Selects the menu item with the specified tag
@param the tag of the item to select
*/
@@ -282,7 +283,7 @@ var CPPopUpButtonArrowsImage = nil;
[self selectItemAtIndex:[self indexOfItemWithTag:aTag]];
}
/*
/*!
Selects the item with the specified title
@param the title of the item to select
*/
@@ -291,7 +292,7 @@ var CPPopUpButtonArrowsImage = nil;
[self selectItemAtIndex:[self indexOfItemWithTitle:aTitle]];
}
/*
/*!
Sets the object for the selected item. If no item is selected, then this method has no effect.
@param the object set for the selected item
*/
@@ -301,7 +302,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Getting Menu Items
/*
/*!
Returns the button's menu of items.
*/
- (CPMenu)menu
@@ -309,7 +310,7 @@ var CPPopUpButtonArrowsImage = nil;
return _menu;
}
/*
/*!
Sets the menu for the button
*/
- (void)setMenu:(CPMenu)aMenu
@@ -366,7 +367,7 @@ var CPPopUpButtonArrowsImage = nil;
[self synchronizeTitleAndSelectedItem];
}
/*
/*!
Returns a count of the number of items in the button's menu.
*/
- (int)numberOfItems
@@ -374,7 +375,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu numberOfItems];
}
/*
/*!
Returns an array of the items in the menu
*/
- (CPArray)itemArray
@@ -382,7 +383,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu itemArray];
}
/*
/*!
Returns the item at the specified index or <code>nil</code> if the item does not exist.
@param anIndex the index of the item to obtain
*/
@@ -391,7 +392,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu itemAtIndex:anIndex];
}
/*
/*!
Returns the title of the item at the specified index or <code>nil</code> if no item exists.
@param anIndex the index of the item
*/
@@ -400,7 +401,7 @@ var CPPopUpButtonArrowsImage = nil;
return [[_menu itemAtIndex:anIndex] title];
}
/*
/*!
Returns an array of all the menu item titles.
*/
- (CPArray)itemTitles
@@ -415,7 +416,7 @@ var CPPopUpButtonArrowsImage = nil;
items.push([items[index] title]);
}
/*
/*!
Returns the menu item with the specified title.
@param aTitle the title of the desired menu item
*/
@@ -424,7 +425,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu itemAtIndex:[_menu indexOfItemWithTitle:aTitle]];
}
/*
/*!
Returns the last menu item
*/
- (CPMenuItem)lastItem
@@ -433,7 +434,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Getting the Indices of Menu Items
/*
/*!
Returns the index of the specified item or <objj>CPNotFound</objj> if the item is not in the list.
@param aMenuItem the item to obtain the index for
*/
@@ -442,7 +443,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu indexOfItem:aMenuItem];
}
/*
/*!
Returns the index of the item with the specified tag or <objj>CPNotFound</objj> if the item is not in the list.
@param aTag the item's tag
*/
@@ -451,7 +452,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu indexOfItemWithTag:aMenuItem];
}
/*
/*!
Returns the index of the item with the specified title or <objj>CPNotFound</objj>.
@param aTitle the item's titel
*/
@@ -460,7 +461,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu indexOfItemWithTitle:aTitle];
}
/*
/*!
Returns the index of the item with the specified
represented object or <objj>CPNotFound</objj>
if a match does not exist.
@@ -471,7 +472,7 @@ var CPPopUpButtonArrowsImage = nil;
return [_menu indexOfItemWithRepresentedObejct:anObject];
}
/*
/*!
Returns the index of the item with the specified target
and action. Returns <objj>CPNotFound</objj> if the no
such item is in the list.
@@ -484,7 +485,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Setting the Cell Edge to Pop out in Restricted Situations
/*
/*!
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.
@@ -494,7 +495,7 @@ var CPPopUpButtonArrowsImage = nil;
return _preferredEdge;
}
/*
/*!
Sets the preffered 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.
@@ -505,7 +506,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Setting the Title
/*
/*!
Sets the pop-up button's title.
@param aTitle the new title
*/
@@ -535,7 +536,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Setting the Image
/*
/*!
This method has no effect. Because the image is taken
from the currently selected item, this method serves
no purpose.
@@ -546,7 +547,7 @@ var CPPopUpButtonArrowsImage = nil;
}
// Setting the State
/*
/*!
Makes sure the selected item and the item
being displayed are one and the same.
*/
@@ -569,7 +570,7 @@ var CPPopUpButtonArrowsImage = nil;
}
//
/*
/*!
Called when the menu has a new item added to it.
@param aNotification information about the event
*/
@@ -597,7 +598,7 @@ var CPPopUpButtonArrowsImage = nil;
}
}
/*
/*!
Called when a menu item has changed.
@param aNotification information about the event
*/
@@ -614,7 +615,7 @@ var CPPopUpButtonArrowsImage = nil;
[self synchronizeTitleAndSelectedItem];
}
/*
/*!
Called when an item was removed from the menu.
@param aNotification information about the event
*/
@@ -706,7 +707,7 @@ var CPPopUpButtonMenuKey = @"CPPopUpButtonMenuKey",
CPPopUpButtonPullsDownKey = @"CPPopUpButtonPullsDownKey";
@implementation CPPopUpButton (CPCoding)
/*
/*!
Initializes the pop-up button with data from the
specified coder.
@param aCoder the coder from which to read
@@ -727,7 +728,7 @@ var CPPopUpButtonMenuKey = @"CPPopUpButtonMenuKey",
return self;
}
/*
/*!
Encodes the data of the pop-up button into a coder
@param aCoder the coder to which the data
will be written
AppKit/CPProgressIndicator.j
+20 -19
View File
@@ -48,7 +48,8 @@ var CPProgressIndicatorSpinningStyleColors = nil,
CPProgressIndicatorStyleIdentifiers = nil,
CPProgressIndicatorStyleSizes = nil;
/*
/*! @class CPProgressIndicator
This class is used in a Cappuccino GUI to display the progress of a
function or task. If the duration of the task is unknown, there is
also an indeterminate mode for the indicator.
@@ -178,7 +179,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
{
}
/*
/*!
Starts the animation of the progress indicator in indeterminate mode.
@param the requesting object
*/
@@ -189,7 +190,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self _hideOrDisplay];
}
/*
/*!
Stops the animation of the progress indicator in indeterminate mode.
@param the requesting object
*/
@@ -200,7 +201,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self _hideOrDisplay];
}
/*
/*!
Always returns <code>NO</code>. Cappuccino does not have multiple threads.
*/
- (BOOL)usesThreadedAnimation
@@ -209,7 +210,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
}
// Advancing the Progress Bar
/*
/*!
Increases the progress of the bar by the specified value.
@param aValue the amount to increase the progress value
*/
@@ -218,7 +219,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self setDoubleValue:_doubleValue + aValue];
}
/*
/*!
Sets the progress value of the indicator.
*/
- (void)setDoubleValue:(double)aValue
@@ -228,7 +229,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self drawBar];
}
/*
/*!
Returns the value of the progress indicator.
*/
- (double)doubleValue
@@ -236,7 +237,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
return _doubleValue;
}
/*
/*!
Sets the minimum value of the progress indicator. The default is 0.0.
@param aValue the new minimum value
*/
@@ -245,7 +246,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
_minValue = aValue;
}
/*
/*!
Returns the minimum value of the progress indicator.
*/
- (double)minValue
@@ -253,7 +254,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
return _minValue;
}
/*
/*!
Sets the maximum value of the progress indicator. The default is 100.0.
@param aValue the new maximum value.
*/
@@ -262,7 +263,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
_maxValue = aValue;
}
/*
/*!
Returns the maximum value of the progress indicator.
*/
- (double)maxValue
@@ -271,7 +272,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
}
// Setting the Appearance
/*
/*!
Sets the progress indicator's size.
@param aControlSize the new size
*/
@@ -285,7 +286,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self updateBackgroundColor];
}
/*
/*!
Returns the progress indicator's size
*/
- (CPControlSize)controlSize
@@ -323,7 +324,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
return YES;
}
/*
/*!
Specifies whether this progress indicator should be indeterminate or display progress based on it's max and min.
@param isDeterminate <code>YES</code> makes the indicator indeterminate
*/
@@ -337,7 +338,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self updateBackgroundColor];
}
/*
/*!
Returns <code>YES</code> if the progress bar is indeterminate.
*/
- (BOOL)isIndeterminate
@@ -345,7 +346,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
return _isIndeterminate;
}
/*
/*!
Sets the progress indicator's style
@param aStyle the style to set it to
*/
@@ -359,7 +360,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self updateBackgroundColor];
}
/*
/*!
Resizes the indicator based on it's style.
*/
- (void)sizeToFit
@@ -372,7 +373,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
_CPControlIdentifierForControlSize(_controlSize)][0].height)];
}
/*
/*!
Sets whether the indicator should be displayed when it isn't animating. By default this is <code>YES</code> if the style
is <objj>CPProgressIndicatorBarStyle</objj>, and <code>NO</code> if it's <objj>CPProgressIndicatorSpinningStyle</objj>.
@param isDisplayedWhenStopped <code>YES</code> means the indicator will be displayed when it's not animating.
@@ -389,7 +390,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
[self _hideOrDisplay];
}
/*
/*!
Returns <code>YES</code> if the progress bar is displayed when not animating.
*/
- (BOOL)isDisplayedWhenStopped
AppKit/CPResponder.j
+28 -23
View File
@@ -28,6 +28,11 @@ CPDownArrowKeyCode = 63233;
CPLeftArrowKeyCode = 63234;
CPRightArrowKeyCode = 63235;
/*!
@class CPResponder
Subclasses of CPResonder can be part of the responder chain.
*/
@implementation CPResponder : CPObject
{
CPMenu _menu;
@@ -35,7 +40,7 @@ CPRightArrowKeyCode = 63235;
}
// Changing the first responder
/*
/*!
Returns <code>YES</code> if the receiver is able to become the first responder. <code>NO</code> otherwise.
*/
- (BOOL)acceptsFirstResponder
@@ -43,7 +48,7 @@ CPRightArrowKeyCode = 63235;
return NO;
}
/*
/*!
Notifies the receiver that it will become the first responder. The receiver can reject first
responder if it returns <code>NO</code>. The default implementation always returns <code>YES</code>.
@return <code>YES</code> if the receiver accepts first responder status.
@@ -53,7 +58,7 @@ CPRightArrowKeyCode = 63235;
return YES;
}
/*
/*!
Notifies the receiver that it has been asked to give up first responder status.
@return <code>YES</code> if the receiver is willing to give up first responder status.
*/
@@ -63,7 +68,7 @@ CPRightArrowKeyCode = 63235;
}
// Setting the next responder
/*
/*!
Sets the receiver's next responder.
@param aResponder the responder after the receiver
*/
@@ -72,7 +77,7 @@ CPRightArrowKeyCode = 63235;
_nextResponder = aResponder;
}
/*
/*!
Returns the responder after the receiver.
*/
- (CPResponder)nextResponder
@@ -80,7 +85,7 @@ CPRightArrowKeyCode = 63235;
return _nextResponder;
}
/*
/*!
Called to interpret a series of key events.
@param events an array of key <objj>CPEvent</objj>s
*/
@@ -111,7 +116,7 @@ CPRightArrowKeyCode = 63235;
}
}
/*
/*!
Notifies the receiver that the user has clicked the mouse down in its area.
@param anEvent contains information about the click
*/
@@ -120,7 +125,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the user has initiated a drag
over it. A drag is a mouse movement while the left button is down.
@param anEvent contains information about the drag
@@ -130,7 +135,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the user has released the left mouse button.
@param anEvent contains information about the release
*/
@@ -139,7 +144,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the user has moved the mouse (with no buttons down).
@param anEvent contains information about the movement
*/
@@ -153,7 +158,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the mouse exited the receiver's area.
@param anEvent contains information about the exit
*/
@@ -162,7 +167,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the mouse scroll wheel has moved.
@param anEvent information about the scroll
*/
@@ -171,7 +176,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the user has pressed a key.
@param anEvent information about the key press
*/
@@ -180,7 +185,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder performSelector:_cmd withObject:anEvent];
}
/*
/*!
Notifies the receiver that the user has released a key.
@param anEvent information about the key press
*/
@@ -201,7 +206,7 @@ CPRightArrowKeyCode = 63235;
}
// Action Methods
/*
/*!
Deletes one character backward, or the selection if anything is selected.
@param aSender the object requesting this
*/
@@ -209,7 +214,7 @@ CPRightArrowKeyCode = 63235;
{
}
/*
/*!
Insert a line break at the caret position or selection.
@param aSender the object requesting this
*/
@@ -217,7 +222,7 @@ CPRightArrowKeyCode = 63235;
{
}
/*
/*!
Inserts some text at the caret position or selection.
@param aString the string to insert
*/
@@ -226,7 +231,7 @@ CPRightArrowKeyCode = 63235;
}
// Dispatch methods
/*
/*!
The receiver will attempt to perform the command,
if it responds to it. If not, the <code>nextResponder</code> will be called to do it.
@param aSelector the command to attempt
@@ -239,7 +244,7 @@ CPRightArrowKeyCode = 63235;
[_nextResponder doCommandBySelector:aSelector];
}
/*
/*!
The receiver will attempt to perform the command, or pass it on to the next responder if it doesn't respond to it.
@param aSelector the command to perform
@param anObject the argument to the method
@@ -271,7 +276,7 @@ CPRightArrowKeyCode = 63235;
}
// Getting the Undo Manager
/*
/*!
Returns the undo manager for the receiver.
*/
- (CPUndoManager)undoManager
@@ -280,7 +285,7 @@ CPRightArrowKeyCode = 63235;
}
// Terminating the responder chain
/*
/*!
Called when an event finds no suitable responder.
@param anEventSelector the command that failed
*/
@@ -294,7 +299,7 @@ var CPResponderNextResponderKey = @"CPResponderNextResponderKey";
@implementation CPResponder (CPCoding)
/*
/*!
Initializes the responder with data from a coder.
@param aCoder the coder from which data will be read
@return the initialized responder
@@ -309,7 +314,7 @@ var CPResponderNextResponderKey = @"CPResponderNextResponderKey";
return self;
}
/*
/*!
Archives the responder to a coder.
@param aCoder the coder to which the responder will be archived
*/
AppKit/CPScrollView.j
+47 -61
View File
@@ -26,7 +26,8 @@ import "CPScroller.j"
#include "CoreGraphics/CGGeometry.h"
/*
/*! @class CPScrollView
Used to display views that are too large for the viewing area. the <objj>CPScrollView</objj>
places scroll bars on the side of the view to allow the user to scroll and see the entire
contents of the view.
@@ -74,7 +75,7 @@ import "CPScroller.j"
}
// Determining component sizes
/*
/*!
Returns the size of the scroll view's content view.
*/
- (CGRect)contentSize
@@ -82,7 +83,7 @@ import "CPScroller.j"
return [_contentView frame].size;
}
/*
/*!
Returns the view that is scrolled for the user.
*/
- (id)documentView
@@ -90,7 +91,7 @@ import "CPScroller.j"
return [_contentView documentView];
}
/*
/*!
Sets the content view that clips the document
@param aContentView the content view
*/
@@ -116,7 +117,7 @@ import "CPScroller.j"
[self addSubview:_contentView];
}
/*
/*!
Returns the content view that clips the document.
*/
- (CPClipView)contentView
@@ -124,7 +125,7 @@ import "CPScroller.j"
return _contentView;
}
/*
/*!
Sets the view that is scrolled for the user.
@param aView the view that will be scrolled
*/
@@ -134,9 +135,8 @@ import "CPScroller.j"
[self reflectScrolledClipView:_contentView];
}
/*
Resizes the scroll view to contain the specified
clip view.
/*!
Resizes the scroll view to contain the specified clip view.
@param aClipView the clip view to resize to
*/
- (void)reflectScrolledClipView:(CPClipView)aClipView
@@ -231,7 +231,7 @@ import "CPScroller.j"
}
// Managing Scrollers
/*
/*!
Sets the scroll view's horizontal scroller.
@param aScroller the horizontal scroller for the scroll view
*/
@@ -254,7 +254,7 @@ import "CPScroller.j"
[self reflectScrolledClipView:_contentView];
}
/*
/*!
Returns the scroll view's horizontal scroller
*/
- (CPScroller)horizontalScroller
@@ -262,7 +262,7 @@ import "CPScroller.j"
return _horizontalScroller;
}
/*
/*!
Specifies whether the scroll view can have a horizontal scroller.
@param hasHorizontalScroller <code>YES</code> lets the scroll view
allocate a horizontal scroller if necessary.
@@ -285,16 +285,15 @@ import "CPScroller.j"
}
}
/*
Returns <code>YES</code> if the scroll view can have a horizontal
scroller.
/*!
Returns <code>YES</code> if the scroll view can have a horizontal scroller.
*/
- (BOOL)hasHorizontalScroller
{
return _hasHorizontalScroller;
}
/*
/*!
Sets the scroll view's vertical scroller.
@param aScroller the vertical scroller
*/
@@ -317,7 +316,7 @@ import "CPScroller.j"
[self reflectScrolledClipView:_contentView];
}
/*
/*!
Return's the scroll view's vertical scroller
*/
- (CPScroller)verticalScroller
@@ -325,7 +324,7 @@ import "CPScroller.j"
return _verticalScroller;
}
/*
/*!
Specifies whether the scroll view has can have
a vertical scroller. It allocates it if necessary.
@param hasVerticalScroller <code>YES</code> allows
@@ -349,16 +348,15 @@ import "CPScroller.j"
}
}
/*
Returns <code>YES</code> if the scroll view can have
a vertical scroller.
/*!
Returns <code>YES</code> if the scroll view can have a vertical scroller.
*/
- (BOOL)hasHorizontalScroller
{
return _hasHorizontalScroller;
}
/*
/*!
Sets whether the scroll view hides its scoll bars when not needed.
@param autohidesScrollers <code>YES</code> causes the scroll bars
to be hidden when not needed.
@@ -368,7 +366,7 @@ import "CPScroller.j"
_autohidesScrollers = autohidesScrollers;
}
/*
/*!
Returns <code>YES</code> if the scroll view hides its scroll
bars when not necessary.
*/
@@ -442,7 +440,7 @@ import "CPScroller.j"
[_contentView scrollToPoint:contentBounds.origin];
}
/*
/*!
Lays out the scroll view's components.
*/
- (void)tile
@@ -462,11 +460,9 @@ import "CPScroller.j"
}
// Setting Scrolling Behavior
/*
Sets how much the document moves when scrolled. Sets
the vertical and horizontal scroll.
@param aLineScroll the amount to move the document
when scrolled
/*!
Sets how much the document moves when scrolled. Sets the vertical and horizontal scroll.
@param aLineScroll the amount to move the document when scrolled
*/
- (void)setLineScroll:(float)aLineScroll
{
@@ -474,59 +470,51 @@ import "CPScroller.j"
[self setVerticalLineScroll:aLineScroll];
}
/*
Returns how much the document moves
when scrolled
/*!
Returns how much the document moves when scrolled
*/
- (float)lineScroll
{
return [self horizontalLineScroll];
}
/*
Sets how much the document moves when scrolled
horizontally.
@param aLineScroll the amount to move horizontally
when scrolled.
/*!
Sets how much the document moves when scrolled horizontally.
@param aLineScroll the amount to move horizontally when scrolled.
*/
- (void)setHorizontalLineScroll:(float)aLineScroll
{
_horizontalLineScroll = aLineScroll;
}
/*
Returns how much the document moves horizontally
when scrolled.
/*!
Returns how much the document moves horizontally when scrolled.
*/
- (float)horizontalLineScroll
{
return _horizontalLineScroll;
}
/*
Sets how much the document moves when scrolled
vertically.
@param aLineScroll the new amount to move vertically
when scrolled.
/*!
Sets how much the document moves when scrolled vertically.
@param aLineScroll the new amount to move vertically when scrolled.
*/
- (void)setVerticalLineScroll:(float)aLineScroll
{
_verticalLineScroll = aLineScroll;
}
/*
Returns how much the document moves vertically
when scrolled.
/*!
Returns how much the document moves vertically when scrolled.
*/
- (float)verticalLineScroll
{
return _verticalLineScroll;
}
/*
/*!
Sets the horizontal and vertical page scroll amount.
@param aPageScroll the new horizontal and vertical page
scroll amount
@param aPageScroll the new horizontal and vertical page scroll amount
*/
- (void)setPageScroll:(float)aPageScroll
{
@@ -534,16 +522,15 @@ import "CPScroller.j"
[self setVerticalPageScroll:aPageScroll];
}
/*
Returns the vertical and horizontal page scroll
amount.
/*!
Returns the vertical and horizontal page scroll amount.
*/
- (float)pageScroll
{
return [self horizontalPageScroll];
}
/*
/*!
Sets the horizontal page scroll amount.
@param aPageScroll the new horizontal page scroll amount
*/
@@ -552,7 +539,7 @@ import "CPScroller.j"
_horizontalPageScroll = aPageScroll;
}
/*
/*!
Returns the horizontal page scroll amount.
*/
- (float)horizontalPageScroll
@@ -560,17 +547,16 @@ import "CPScroller.j"
return _horizontalPageScroll;
}
/*
/*!
Sets the vertical page scroll amount.
@param aPageScroll the new vertcal page scroll
amount
@param aPageScroll the new vertcal page scroll amount
*/
- (void)setVerticalPageScroll:(float)aPageScroll
{
_verticalPageScroll = aPageScroll;
}
/*
/*!
Returns the vertical page scroll amount.
*/
- (float)verticalPageScroll
@@ -578,7 +564,7 @@ import "CPScroller.j"
return _verticalPageScroll;
}
/*
/*!
Handles a scroll wheel event from the user.
@param anEvent the scroll wheel event
*/
AppKit/CPScroller.j
+23 -19
View File
@@ -74,6 +74,10 @@ var _CPScrollerKnobIdentifier = @"Knob",
var _CPScrollerClassName = nil,
_CPScrollerPartSizes = {};
/*! @class CPScroller
*/
@implementation CPScroller : CPControl
{
CPControlSize _controlSize;
@@ -206,7 +210,7 @@ var _CPScrollerClassName = nil,
}
// Determining CPScroller Size
/*
/*!
Returns the <objj>CPScroller</objj>'s width for a <objj>CPRegularControlSize</objj>.
*/
+ (float)scrollerWidth
@@ -214,7 +218,7 @@ var _CPScrollerClassName = nil,
return [self scrollerWidthForControlSize:CPRegularControlSize];
}
/*
/*!
Returns the width of a <objj>CPScroller</objj> for the specified <objj>CPControlSize</objj>.
@param aControlSize the size of a controller to return the width for
*/
@@ -223,7 +227,7 @@ var _CPScrollerClassName = nil,
return _CPScrollerWidths[aControlSize];
}
/*
/*!
Sets the scroller's size.
@param aControlSize the scroller's size
*/
@@ -242,7 +246,7 @@ var _CPScrollerClassName = nil,
[self layoutSubviews];
}
/*
/*!
Returns the scroller's control size
*/
- (CPControlSize)controlSize
@@ -251,7 +255,7 @@ var _CPScrollerClassName = nil,
}
// Setting the Knob Position
/*
/*!
Sets the scroller's knob position (ranges from 0.0 to 1.0).
@param aValue the knob position (ranges from 0.0 to 1.0)
*/
@@ -263,7 +267,7 @@ var _CPScrollerClassName = nil,
[self layoutSubviews];
}
/*
/*!
Sets the position and proportion of the knob.
@param aValue the knob position (ranges from 0.0 to 1.0)
@param aProportion the knob's proportion (ranges from 0.0 to 1.0)
@@ -275,7 +279,7 @@ var _CPScrollerClassName = nil,
[self setFloatValue:aValue];
}
/*
/*!
Return's the knob's proportion
*/
- (float)knobProportion
@@ -293,7 +297,7 @@ var _CPScrollerClassName = nil,
return _partRects[aPart];
}
/*
/*!
Returns the part of the scroller that would be hit by <code>aPoint</code>.
@param aPoint the simulated point hit
@return the part of the scroller that intersects the point
@@ -326,7 +330,7 @@ var _CPScrollerClassName = nil,
return CPScrollerNoPart;
}
/*
/*!
Check if there's enough space in the scroller to display the knob
*/
- (void)checkSpaceForParts
@@ -386,7 +390,7 @@ var _CPScrollerClassName = nil,
}
}
/*
/*!
Returns all the parts of the scroller that
are usable for displaying.
*/
@@ -396,7 +400,7 @@ var _CPScrollerClassName = nil,
}
// Drawing the Parts
/*
/*!
Draws the specified arrow and sets the highlight.
@param anArrow the arrow to draw
@param shouldHighlight sets whether the arrow should be highlighted
@@ -415,7 +419,7 @@ var _CPScrollerClassName = nil,
shouldHighlight ? _CPScrollerHighlightedIdentifier : @"")];
}
/*
/*!
Draws the knob
*/
- (void)drawKnob
@@ -429,7 +433,7 @@ var _CPScrollerClassName = nil,
_CPControlIdentifierForControlSize(_controlSize))];
}
/*
/*!
Draws the knob's slot
*/
- (void)drawKnobSlot
@@ -442,7 +446,7 @@ var _CPScrollerClassName = nil,
_CPControlIdentifierForControlSize(_controlSize))];
}
/*
/*!
Caches images for the scroll arrow and knob.
*/
- (void)drawParts
@@ -480,7 +484,7 @@ var _CPScrollerClassName = nil,
[self drawArrow:CPScrollerIncrementArrow highlight:NO];
}
/*
/*!
Draws the scroller's arrow with a possible highlight,
if the user's mouse is over it.
@param shouldHighlight <code>YES</code> will draw the
@@ -496,7 +500,7 @@ var _CPScrollerClassName = nil,
}
// Event Handling
/*
/*!
Returns the part of the scroller that was hit.
*/
- (CPScrollerPart)hitPart
@@ -504,7 +508,7 @@ var _CPScrollerClassName = nil,
return _hitPart;
}
/*
/*!
Tracks the knob.
@param anEvent the input event
*/
@@ -547,7 +551,7 @@ var _CPScrollerClassName = nil,
[self sendAction:[self action] to:[self target]];
}
/*
/*!
Tracks the scroll button.
@param anEvent the input event
*/
@@ -644,7 +648,7 @@ var _CPScrollerClassName = nil,
[self layoutSubviews];
}
/*
/*!
Lays out the scrollers subviews
*/
- (void)layoutSubviews
AppKit/CPSegmentedControl.j
+31 -33
View File
@@ -40,9 +40,9 @@ CPSegmentSwitchTrackingSelectAny = 1;
*/
CPSegmentSwitchTrackingMomentary = 2;
/*
This class is a horizontal button with multiple
segments.
/*! @class CPSegmentedControl
This class is a horizontal button with multiple segments.
*/
@implementation CPSegmentedControl : CPControl
{
@@ -73,7 +73,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return self;
}
/*
/*!
Returns the tag of the selected segment.
*/
- (int)selectedTag
@@ -82,10 +82,9 @@ CPSegmentSwitchTrackingMomentary = 2;
}
// Specifying the number of segments
/*
/*!
Sets the number of segments in the button.
@param aCount the number of segments on
the button
@param aCount the number of segments on the button
*/
- (void)setSegmentCount:(unsigned)aCount
{
@@ -125,7 +124,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self tileWithChangedSegment:0];
}
/*
/*!
Returns the number of segments in the button.
*/
- (unsigned)segmentCount
@@ -134,7 +133,7 @@ CPSegmentSwitchTrackingMomentary = 2;
}
// Specifying Selected Segment
/*
/*!
Selects a segment.
@param aSegment the segment to select
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -145,7 +144,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self setSelected:YES forSegment:aSegment];
}
/*
/*!
Returns the selected segment.
*/
- (unsigned)selectedSegment
@@ -153,9 +152,8 @@ CPSegmentSwitchTrackingMomentary = 2;
return _selectedSegment;
}
/*
Selects the button segment with the
specified tag.
/*!
Selects the button segment with the specified tag.
*/
- (BOOL)selectSegmentWithTag:(int)aTag
{
@@ -209,7 +207,7 @@ CPSegmentSwitchTrackingMomentary = 2;
}
}
/*
/*!
Returns the control's tracking mode.
*/
- (CPSegmentSwitchTracking)trackingMode
@@ -218,7 +216,7 @@ CPSegmentSwitchTrackingMomentary = 2;
}
// Working with Individual Segments
/*
/*!
Sets the width of the specified segment.
@param aWidth the new width for the segment
@param aSegment the segment to set the width for
@@ -231,7 +229,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self tileWithChangedSegment:aSegment];
}
/*
/*!
Returns the width for the specified segment.
@param aSegment the segment to get the width for
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -241,7 +239,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].width;
}
/*
/*!
Sets the image for the specified segment.
@param anImage the image for the segment
@param aSegment the segment to set the image on
@@ -279,7 +277,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self tileWithChangedSegment:aSegment];
}
/*
/*!
Returns the image for the specified segment
@param aSegment the segment to obtain the image for
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -289,7 +287,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].image;
}
/*
/*!
Sets the label for the specified segment
@param aLabel the label for the segment
@param aSegment the segment to label
@@ -329,7 +327,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self tileWithChangedSegment:aSegment];
}
/*
/*!
Returns the label for the specified segment
@param the segment to obtain the label for
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -339,7 +337,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].label;
}
/*
/*!
Sets the menu for the specified segment
@param aMenu the menu to set
@param aSegment the segment to set the menu on
@@ -350,7 +348,7 @@ CPSegmentSwitchTrackingMomentary = 2;
_segments[aSegment].menu = aMenu;
}
/*
/*!
Returns the menu for the specified segment.
@param aSegment the segment to obtain the menu for
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -360,7 +358,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].menu;
}
/*
/*!
Sets the selection for the specified segment. If only one segment
can be selected at a time, any other segment will be deselected.
@param isSelected <code>YES</code> selects the segment. <code>NO</code> deselects it.
@@ -396,7 +394,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self drawSegmentBezel:aSegment highlight:NO];
}
/*
/*!
Returns <code>YES</code> if the specified segment is selected.
@param aSegment the segment to check for selection
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -406,7 +404,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].selected;
}
/*
/*!
Enables/diables the specified segment.
@param isEnabled <code>YES</code> enables the segment
@param aSegment the segment to enable/disble
@@ -417,7 +415,7 @@ CPSegmentSwitchTrackingMomentary = 2;
_segments[aSegment].enabled = isEnabled;
}
/*
/*!
Returns <code>YES</code> if the specified segment is enabled.
@param aSegment the segment to check
@throws CPRangeException if <code>aSegment</code> is out of bounds
@@ -427,7 +425,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].enabled;
}
/*
/*!
Sets a tag for the specified segment.
@param aTag the tag to set
@param aSegment the segment to set the tag on
@@ -437,7 +435,7 @@ CPSegmentSwitchTrackingMomentary = 2;
_segments[aSegment].tag = aTag;
}
/*
/*!
Returns the tag for the specified segment.
@param aSegment the segment to obtain the tag for
*/
@@ -447,7 +445,7 @@ CPSegmentSwitchTrackingMomentary = 2;
}
// Drawings
/*
/*!
Draws the specified segment bezel
@param aSegment the segment to draw the bezel for
@param shouldHighlight <code>YES</code> highlights the bezel
@@ -456,7 +454,7 @@ CPSegmentSwitchTrackingMomentary = 2;
{
}
/*
/*!
Draws the specified segment
@param aSegment the segment to draw
@param shouldHighlight <code>YES</code> highlights the bezel
@@ -550,7 +548,7 @@ CPSegmentSwitchTrackingMomentary = 2;
[self drawSegment:aSegment highlight:NO];
}
/*
/*!
Returns the bounding rectangle for the specified segment.
@param aSegment the segment to get the rectangle for
*/
@@ -559,7 +557,7 @@ CPSegmentSwitchTrackingMomentary = 2;
return _segments[aSegment].frame;
}
/*
/*!
Returns the segment that is hit by the specified point.
@param aPoint the point to test for a segment hit
@return the intersecting segment
@@ -589,7 +587,7 @@ CPSegmentSwitchTrackingMomentary = 2;
{
}
/*
/*!
Handles events for the segment
@param anEvent the event to handle
*/
AppKit/CPShadow.j
+7 -6
View File
@@ -22,7 +22,8 @@
import <Foundation/CPObject.j>
/*
/*! @class CPShadow
Instances of this class contain the attributes of a drop shadow used in Cappuccino.
*/
@implementation CPShadow : CPObject
@@ -34,7 +35,7 @@ import <Foundation/CPObject.j>
CPString _cssString;
}
/*
/*!
Creates a shadow with the specified attributes.
@param anOffset the shadow's offset
@param aBlurRadius the shadow's blur radius
@@ -63,7 +64,7 @@ import <Foundation/CPObject.j>
return self;
}
/*
/*!
Returns the shadow's offset.
*/
- (CGSize)shadowOffset
@@ -71,7 +72,7 @@ import <Foundation/CPObject.j>
return _offset;
}
/*
/*!
Returns the shadow's blur radius
*/
- (float)shadowBlurRadius
@@ -79,7 +80,7 @@ import <Foundation/CPObject.j>
return _blurRadius;
}
/*
/*!
Returns the shadow's color.
*/
- (CPColor)shadowColor
@@ -87,7 +88,7 @@ import <Foundation/CPObject.j>
return _color;
}
/*
/*!
Returns a CSS string representation of the shadow.
*/
- (CPString)cssString
AppKit/CPSlider.j
+16 -15
View File
@@ -27,7 +27,8 @@ var CPSliderHorizontalKnobImage = nil,
CPSliderHorizontalBarRightImage = nil,
CPSliderHorizontalBarCenterImage = nil;
/*
/*! @class CPSlider
An <objj>CPSlider</objj> displays, and allows control of, some value in the application. It represents a continuous stream of values of type <code>float</code>, which can be retrieved by the method <code>floatValue</code> and set by the method <code>setFloatValue:</code>.
*/
@implementation CPSlider : CPControl
@@ -116,7 +117,7 @@ var CPSliderHorizontalKnobImage = nil,
[_knob setFrameOrigin:[self knobPosition]];
}
/*
/*!
Returns the value by which the slider will be
incremented if the user holds down the <code>ALT</code>s key.
*/
@@ -125,7 +126,7 @@ var CPSliderHorizontalKnobImage = nil,
return _altIncrementValue;
}
/*
/*!
Returns the thickness of the slider's knob. This value is in pixels,
and is the size of the knob along the slider's track.
*/
@@ -174,7 +175,7 @@ var CPSliderHorizontalKnobImage = nil,
return CPSliderKnobPushedImage;
}
/*
/*!
Returns the slider's knob.
*/
- (CPView)knob
@@ -192,7 +193,7 @@ var CPSliderHorizontalKnobImage = nil,
return _standardKnob;
}
/*
/*!
Returns the slider's bar.
*/
- (CPView)bar
@@ -220,7 +221,7 @@ var CPSliderHorizontalKnobImage = nil,
}
}
/*
/*!
Sets the value the slider will be incremented if the user holds the <code>ALT</code> key.
*/
- (void)setAltIncrementValue:(double)anIncrementValue
@@ -228,7 +229,7 @@ var CPSliderHorizontalKnobImage = nil,
_altIncrementValue = anIncrementValue;
}
/*
/*!
Returns <code>YES</code> if the slider is vertical.
*/
- (BOOL)isVertical
@@ -241,7 +242,7 @@ var CPSliderHorizontalKnobImage = nil,
return CPRectGetWidth(frame) < CPRectGetHeight(frame);
}
/*
/*!
Returns the slider's maximum value
*/
- (double)maxValue
@@ -249,7 +250,7 @@ var CPSliderHorizontalKnobImage = nil,
return _maxValue;
}
/*
/*!
Returns the slider's minimum value
*/
- (double)minValue
@@ -257,7 +258,7 @@ var CPSliderHorizontalKnobImage = nil,
return _minValue;
}
/*
/*!
Sets the slider's maximum value
@param aMaxValue the new maximum value
*/
@@ -266,7 +267,7 @@ var CPSliderHorizontalKnobImage = nil,
_maxValue = aMaxValue;
}
/*
/*!
Sets the slider's minimum value
@param aMinValue the new minimum value
*/
@@ -275,7 +276,7 @@ var CPSliderHorizontalKnobImage = nil,
_minValue = aMinValue;
}
/*
/*!
Sets the slider's value
@param aValue the new slider value
*/
@@ -286,7 +287,7 @@ var CPSliderHorizontalKnobImage = nil,
[_knob setFrameOrigin:[self knobPosition]];
}
/*
/*!
Returns the slider's value
*/
- (double)value
@@ -361,7 +362,7 @@ var CPSliderMinValueKey = @"CPSliderMinValueKey",
@implementation CPSlider (CPCoding)
/*
/*!
Initializes the slider from the data in a coder.
@param aCoder the coder from which to read the data
@return the initialized slider
@@ -390,7 +391,7 @@ var CPSliderMinValueKey = @"CPSliderMinValueKey",
return self;
}
/*
/*!
Writes out the slider's instance information to a coder.
@param aCoder the coder to which to write the data
*/
AppKit/CPStringDrawing.j
+1 -1
View File
@@ -27,7 +27,7 @@ var CPStringReferenceElement = nil;
@implementation CPString (CPStringDrawing)
/*
/*!
Returns the string
*/
- (CPString)cssString
AppKit/CPTabView.j
+21 -20
View File
@@ -68,7 +68,8 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
CPTabViewWillSelectTabViewItemSelector = 4,
CPTabViewDidChangeNumberOfTabViewItemsSelector = 8;
/*
/*! @class CPTabView
This class represents a view that has multiple subviews (<objj>CPTabViewItem</objj>) presented as individual tabs.
Only one <objj>CPTabViewItem</objj> is shown at a time, and other <objj>CPTabViewItem</objj>s can be made visible
(one at a time) by clicking on the <objj>CPTabViewItem</objj>'s tab at the top of the tab view.
@@ -219,7 +220,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
// Adding and Removing Tabs
/*
/*!
Adds a <objj>CPTabViewItem</objj> to the tab view.
@param aTabViewItem the item to add
*/
@@ -228,7 +229,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self insertTabViewItem:aTabViewItem atIndex:[_tabViewItems count]];
}
/*
/*!
Inserts a <objj>CPTabViewItem</objj> into the tab view
at the specified index.
@param aTabViewItem the item to insert
@@ -247,7 +248,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[_delegate tabViewDidChangeNumberOfTabViewItems:self];
}
/*
/*!
Removes the specified tab view item from the tab view.
@param aTabViewItem the item to remove
*/
@@ -262,7 +263,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
// Accessing Tabs
/*
/*!
Returns the index of the specified item
@param aTabViewItem the item to find the index for
*/
@@ -271,7 +272,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
return [_tabViewItems indexOfObjectIdenticalTo:aTabViewItem];
}
/*
/*!
Returns the index of the <objj>CPTabViewItem</objj> with the specified identifier.
@param anIdentifier the identifier of the item
*/
@@ -287,7 +288,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
return index;
}
/*
/*!
Returns the number of items in the tab view.
*/
- (unsigned)numberOfTabViewItems
@@ -295,7 +296,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
return [_tabViewItems count];
}
/*
/*!
Returns the <objj>CPTabViewItem</objj> at the specified index.
*/
- (CPTabViewItem)tabViewItemAtIndex:(unsigned)anIndex
@@ -303,7 +304,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
return _tabViewItems[anIndex];
}
/*
/*!
Returns the array of items that backs this tab view.
*/
- (CPArray)tabViewItems
@@ -312,7 +313,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
// Selecting a Tab
/*
/*!
Sets the first tab view item in the array to be displayed to the user.
@param aSender the object making this request
*/
@@ -324,7 +325,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self selectTabViewItemAtIndex:0];
}
/*
/*!
Sets the last tab view item in the array to be displayed to the user.
@param aSender the object making this request
*/
@@ -336,7 +337,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self selectTabViewItemAtIndex:count - 1];
}
/*
/*!
Sets the next tab item in the array to be displayed.
@param aSender the object making this request
*/
@@ -351,7 +352,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self selectTabViewItemAtIndex:index + 1 % count];
}
/*
/*!
Selects the previous item in the array for display.
@param aSender the object making this request
*/
@@ -366,7 +367,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self selectTabViewItemAtIndex:index == 0 ? count : index - 1];
}
/*
/*!
Displays the specified item in the tab view.
@param aTabViewItem the item to display
*/
@@ -409,7 +410,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[_delegate tabView:self didSelectTabViewItem:aTabViewItem];
}
/*
/*!
Selects the item at the specified index.
@param anIndex the index of the item to display.
*/
@@ -418,7 +419,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self selectTabViewItem:_tabViewItems[anIndex]];
}
/*
/*!
Returns the current item being displayed.
*/
- (CPTabViewItem)selectedTabViewItem
@@ -427,7 +428,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
//
/*
/*!
Sets the tab view type.
@param aTabViewType the view type
*/
@@ -451,7 +452,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
[self layoutSubviews];
}
/*
/*!
Returns the tab view type.
*/
- (CPTabViewType)tabViewType
@@ -460,7 +461,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
// Determining the Size
/*
/*!
Returns the content rectangle.
*/
- (CGRect)contentRect
@@ -483,7 +484,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
return contentRect;
}
/*
/*!
Sets the delegate for this tab view.
@param aDelegate the tab view's delegate
*/
AppKit/CPTabViewItem.j
+13 -12
View File
@@ -43,7 +43,8 @@ CPBackgroundTab = 1;
*/
CPPressedTab = 2;
/*
/*! @class CPTabView
The class representation of an item in a <objj>CPTabView</objj>. One tab view item
can be shown at a time in a <objj>CPTabView</objj>.
*/
@@ -56,7 +57,7 @@ CPPressedTab = 2;
CPView _auxiliaryView;
}
/*
/*!
Initializes the tab view item with the specified identifier.
@return the initialized <objj>CPTabViewItem</objj>
*/
@@ -71,7 +72,7 @@ CPPressedTab = 2;
}
// Working With Labels
/*
/*!
Sets the <objj>CPTabViewItem</objj>'s label.
@param aLabel the label for the item
*/
@@ -80,7 +81,7 @@ CPPressedTab = 2;
_label = aLabel;
}
/*
/*!
Returns the <objj>CPTabViewItem</objj>'s label
*/
- (CPString)label
@@ -89,7 +90,7 @@ CPPressedTab = 2;
}
// Checking the Tab Display State
/*
/*!
Returns the tab's current state.
*/
- (CPTabState)tabState
@@ -98,7 +99,7 @@ CPPressedTab = 2;
}
// Assigning an Identifier Object
/*
/*!
Sets the item's identifier.
@param anIdentifier the new identifier for the item
*/
@@ -107,7 +108,7 @@ CPPressedTab = 2;
_identifier = anIdentifier;
}
/*
/*!
Returns the tab's identifier.
*/
- (id)identifier
@@ -116,7 +117,7 @@ CPPressedTab = 2;
}
// Assigning a View
/*
/*!
Sets the view that gets displayed in this tab.
*/
- (void)setView:(CPView)aView
@@ -124,7 +125,7 @@ CPPressedTab = 2;
_view = aView;
}
/*
/*!
Returns the tab's view.
*/
- (CPView)view
@@ -133,7 +134,7 @@ CPPressedTab = 2;
}
// Assigning an Auxiliary View
/*
/*!
Sets the tab's auxillary view.
@param anAuxillaryView the new auxillary view
*/
@@ -142,7 +143,7 @@ CPPressedTab = 2;
_auxiliaryView = anAuxiliaryView;
}
/*
/*!
Returns the tab's auxillary view
*/
- (CPView)auxiliaryView
@@ -151,7 +152,7 @@ CPPressedTab = 2;
}
// Accessing the Parent Tab View
/*
/*!
Returns the tab view that contains this item.
*/
- (CPTabView)tabView
AppKit/CPTableColumn.j
+22 -21
View File
@@ -43,7 +43,8 @@ CPTableColumnAutoresizingMask = 1;
*/
CPTableColumnUserResizingMask = 2;
/*
/*! @class CPTableColumn
An <objj>CPTableColumn</objj> object mainly keeps information about the width of the column, its minimum and maximum width; whether the column can be edited or resized; and the cells used to draw the column header and the data in the column. You can change all these attributes of the column by calling the appropriate methods. Please note that the table column does not hold nor has access to the data to be displayed in the column; this data is maintained in the table view's data source.</p>
<p>Each <objj>CPTableColumn</objj> object is identified by a <objj>CPString</objj>, called the column identifier. The reason is that, after a column has been added to a table view, the user might move the columns around, so there is a need to identify the columns regardless of its position in the table.
@@ -63,7 +64,7 @@ CPTableColumnUserResizingMask = 2;
unsigned _resizingMask;
}
/*
/*!
Initializes the table column with the specified identifier.
@param anIdentifier the identifier
@return the initialized table column
@@ -87,7 +88,7 @@ CPTableColumnUserResizingMask = 2;
return self;
}
/*
/*!
Sets the table column's identifier
@param anIdentifier the new identifier
*/
@@ -96,7 +97,7 @@ CPTableColumnUserResizingMask = 2;
_identifier = anIdentifier;
}
/*
/*!
Returns the table column's identifier
*/
- (CPString)identifier
@@ -105,7 +106,7 @@ CPTableColumnUserResizingMask = 2;
}
// Setting the CPTableView
/*
/*!
Sets the table's view. This is called automatically by Cappuccino.
@param aTableView the new table view
*/
@@ -114,7 +115,7 @@ CPTableColumnUserResizingMask = 2;
_tableView = aTableView;
}
/*
/*!
Returns the column's table view.
*/
- (CPTableView)tableView
@@ -123,7 +124,7 @@ CPTableColumnUserResizingMask = 2;
}
// Controlling size
/*
/*!
Sets the column's width.
@param aWidth the new column width
*/
@@ -132,7 +133,7 @@ CPTableColumnUserResizingMask = 2;
_width = aWidth;
}
/*
/*!
Returns the column's width
*/
- (float)width
@@ -140,7 +141,7 @@ CPTableColumnUserResizingMask = 2;
return _width;
}
/*
/*!
Sets column's minimum width.
@param aWidth the new minimum column width
*/
@@ -150,7 +151,7 @@ CPTableColumnUserResizingMask = 2;
[self setWidth:_minWidth];
}
/*
/*!
The column's minimum width
*/
- (float)minWidth
@@ -158,7 +159,7 @@ CPTableColumnUserResizingMask = 2;
return _minWidth;
}
/*
/*!
Sets the column's maximum width.
@param aWidth the new maximum width
*/
@@ -168,7 +169,7 @@ CPTableColumnUserResizingMask = 2;
[self setWidth:_maxWidth];
}
/*
/*!
Sets the resizing mask. The mask is one of:
<pre>
CPTableColumnNoResizing;
@@ -182,7 +183,7 @@ CPTableColumnUserResizingMask;
_resizingMask = aMask;
}
/*
/*!
Returns the column's resizing mask. One of:
<pre>
CPTableColumnNoResizing;
@@ -195,7 +196,7 @@ CPTableColumnUserResizingMask;
return _resizingMask;
}
/*
/*!
Resizes the column according to the min, max and set width.
*/
- (void)sizeToFit
@@ -211,7 +212,7 @@ CPTableColumnUserResizingMask;
[self setWidth:width];
}
/*
/*!
Sets whether the column in this data is editable.
@param aFlag <code>YES</code> means the column data is editable
*/
@@ -220,7 +221,7 @@ CPTableColumnUserResizingMask;
_isEditable = aFlag;
}
/*
/*!
Returns <code>YES</code> if the column data is editable.
*/
- (BOOL)isEditable
@@ -228,7 +229,7 @@ CPTableColumnUserResizingMask;
return _isEditable;
}
/*
/*!
Sets the view that draws the column's header.
@param aHeaderView the view that will draws the column header
*/
@@ -237,7 +238,7 @@ CPTableColumnUserResizingMask;
_headerView = aHeaderView;
}
/*
/*!
Return the view that draws the column's header
*/
- (CPView)headerView
@@ -245,7 +246,7 @@ CPTableColumnUserResizingMask;
return _headerView;
}
/*
/*!
Sets the data cell that draws rows in this column.
*/
- (void)setDataCell:(CPCell)aDataCell
@@ -253,7 +254,7 @@ CPTableColumnUserResizingMask;
_dataCell = aDataCell;
}
/*
/*!
Returns the data cell that draws rows in this column
*/
- (CPCell)dataCell
@@ -261,7 +262,7 @@ CPTableColumnUserResizingMask;
return _dataCell;
}
/*
/*!
By default returns the value from <code>dataCell</code>. This can
be overridden by a subclass to return different cells for different
rows.
AppKit/CPTextField.j
+21 -21
View File
@@ -82,7 +82,7 @@ var _CPTextFieldSquareBezelColor = nil;
@implementation CPString (CPTextFieldAdditions)
/*
/*!
Returns the string (<code>self</code>).
*/
- (CPString)string
@@ -92,7 +92,7 @@ var _CPTextFieldSquareBezelColor = nil;
@end
/*
/*!
This control displays editable text in a Cappuccino application.
*/
@implementation CPTextField : CPControl
@@ -167,7 +167,7 @@ var _CPTextFieldSquareBezelColor = nil;
}
// Setting the Bezel Style
/*
/*!
Sets whether the textfield will have a bezeled border.
@param shouldBeBezeled <code>YES</code> means the textfield will draw a bezeled border
*/
@@ -181,7 +181,7 @@ var _CPTextFieldSquareBezelColor = nil;
[self _updateBackground];
}
/*
/*!
Returns <code>YES</code> if the textfield draws a bezeled border.
*/
- (BOOL)isBezeled
@@ -189,7 +189,7 @@ var _CPTextFieldSquareBezelColor = nil;
return _isBezeled;
}
/*
/*!
Sets the textfield's bezel style.
@param aBezelStyle the constant for the desired bezel style
*/
@@ -203,7 +203,7 @@ var _CPTextFieldSquareBezelColor = nil;
[self _updateBackground];
}
/*
/*!
Returns the textfield's bezel style.
*/
- (CPTextFieldBezelStyle)bezelStyle
@@ -211,7 +211,7 @@ var _CPTextFieldSquareBezelColor = nil;
return _bezelStyle;
}
/*
/*!
Sets whether the textfield will have a border drawn.
@param shouldBeBordered <code>YES</code> makes the textfield draw a border
*/
@@ -225,7 +225,7 @@ var _CPTextFieldSquareBezelColor = nil;
[self _updateBackground];
}
/*
/*!
Returns <code>YES</code> if the textfield has a border.
*/
- (BOOL)isBordered
@@ -337,7 +337,7 @@ var _CPTextFieldSquareBezelColor = nil;
return YES;
}
/*
/*!
Sets whether or not the receiver text field can be edited
*/
- (void)setEditable:(BOOL)shouldBeEditable
@@ -345,7 +345,7 @@ var _CPTextFieldSquareBezelColor = nil;
_isEditable = shouldBeEditable;
}
/*
/*!
Returns <code>YES</code> if the textfield is currently editable by the user.
*/
- (BOOL)isEditable
@@ -362,7 +362,7 @@ var _CPTextFieldSquareBezelColor = nil;
#endif
}
/*
/*!
Returns <code>YES</code> if the field's text is selectable by the user.
*/
- (BOOL)isSelectable
@@ -370,7 +370,7 @@ var _CPTextFieldSquareBezelColor = nil;
return _isSelectable;
}
/*
/*!
Sets whether the field's text is selectable by the user.
@param aFlag <code>YES</code> makes the text selectable
*/
@@ -379,7 +379,7 @@ var _CPTextFieldSquareBezelColor = nil;
_isSelectable = aFlag;
}
/*
/*!
Sets the alignment of the text in the field.
@param anAlignment
*/
@@ -407,7 +407,7 @@ var _CPTextFieldSquareBezelColor = nil;
#endif
}
/*
/*!
Sets the way line breaks occur in the text field.
@param aLineBreakMode the line break style
*/
@@ -431,7 +431,7 @@ var _CPTextFieldSquareBezelColor = nil;
#endif
}
/*
/*!
Returns the string the text field.
*/
- (CPString)stringValue
@@ -472,7 +472,7 @@ var _CPTextFieldSquareBezelColor = nil;
#endif
}
/*
/*!
Returns the receiver's placeholder string
*/
- (CPString)placeholderString
@@ -480,7 +480,7 @@ var _CPTextFieldSquareBezelColor = nil;
return _placeholderString;
}
/*
/*!
Sets a placeholder string for the receiver. The placeholder is displayed until editing begins,
and after editing ends, if the text field has an empty string value
*/
@@ -489,7 +489,7 @@ var _CPTextFieldSquareBezelColor = nil;
_placeholderString = aStringValue;
}
/*
/*!
Adjusts the text field's size in the application.
*/
- (void)sizeToFit
@@ -501,7 +501,7 @@ var _CPTextFieldSquareBezelColor = nil;
#endif
}
/*
/*!
Select all the text in the CPTextField.
*/
- (void)selectText:(id)sender
@@ -523,7 +523,7 @@ var CPTextFieldIsSelectableKey = @"CPTextFieldIsSelectableKey",
@implementation CPTextField (CPCoding)
/*
/*!
Initializes the textfield with data from a coder.
@param aCoder the coder from which to read the textfield data
@return the initialized textfield
@@ -564,7 +564,7 @@ var CPTextFieldIsSelectableKey = @"CPTextFieldIsSelectableKey",
return self;
}
/*
/*!
Encodes the data of this textfield into the provided coder.
@param aCoder the coder into which the data will be written
*/
AppKit/CPToolbar.j
+32 -28
View File
@@ -49,25 +49,14 @@ CPToolbarDisplayModeLabelOnly = 3;
var CPToolbarsByIdentifier = nil;
var CPToolbarConfigurationsByIdentifier = nil;
/* @ignore */
var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
{
var lhsVisibilityPriority = [lhs visibilityPriority],
rhsVisibilityPriority = [rhs visibilityPriority];
if (lhsVisibilityPriority == rhsVisibilityPriority)
return CPOrderedSame;
/*!
@class CPToolbar
if (lhsVisibilityPriority > rhsVisibilityPriority)
return CPOrderedAscending;
return CPOrderedDescending;
}
/*
A <objj>CPToolbar</objj> is displayed at the top of a window with multiple
A CPToolbar is displayed at the top of a window with multiple
buttons (tools) that offer the user quick access to features.
@par Delegate Methods
@delegate -(CPArray)toolbarDefaultItemIdentifiers:(CPToolbar)toolbar;
Called to obtain the toolbar's default item identifiers. Required.
@param toolbar the toolbar to obtain identifiers for
@@ -117,7 +106,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
CPToolbarConfigurationsByIdentifier = [CPDictionary dictionary];
}
/*
/*!
Initializes the toolbar with the specified identifier.
@param anIdentifier the identifier for the toolbar
@return the initialized toolbar
@@ -148,7 +137,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return self;
}
/*
/*!
Sets the toolbar's display mode. NOT YET IMPLEMENTED.
*/
- (void)setDisplayMode:(CPToolbarDisplayMode)aDisplayMode
@@ -156,7 +145,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
}
/*
/*!
Returns the toolbar's identifier
*/
- (CPString)identifier
@@ -164,7 +153,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return _identifier;
}
/*
/*!
Returns the toolbar's delegate
*/
- (id)delegate
@@ -172,7 +161,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return _delegate;
}
/*
/*!
Returns <code>YES</code> if the toolbar is currently visible
*/
- (BOOL)isVisible
@@ -180,7 +169,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return _isVisible;
}
/*
/*!
Sets whether the toolbar should be visible.
@param aFlag <code>YES</code> makes the toolbar visible
*/
@@ -195,7 +184,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
[self _reloadToolbarItems];
}
/*
/*!
Sets the delegate for the toolbar.
@param aDelegate the new toolbar delegate
*/
@@ -278,7 +267,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
[_toolbarView reloadToolbarItems];
}
/*
/*!
Returns all the items in this toolbar.
*/
- (CPArray)items
@@ -286,7 +275,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return _items;
}
/*
/*!
Returns all the visible items in this toolbar
*/
- (CPArray)visibleItems
@@ -294,7 +283,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return [_toolbarView visibleItems];
}
/*
/*!
Returns the index of the specified toolbar item
@param anItem the item to obtain the index for
*/
@@ -308,7 +297,7 @@ var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
return info.index;
}
/*
/*!
Returns the toolbar items sorted by their <code>visibilityPriority</code>(ies).
*/
- (CPArray)itemsSortedByVisibilityPriority
@@ -698,3 +687,18 @@ var _CPToolbarItemInfoMake = function(anIndex, aView, aLabel, aMinWidth)
}
@end
/* @ignore */
var _CPToolbarItemVisibilityPriorityCompare = function(lhs, rhs)
{
var lhsVisibilityPriority = [lhs visibilityPriority],
rhsVisibilityPriority = [rhs visibilityPriority];
if (lhsVisibilityPriority == rhsVisibilityPriority)
return CPOrderedSame;
if (lhsVisibilityPriority > rhsVisibilityPriority)
return CPOrderedAscending;
return CPOrderedDescending;
}
AppKit/CPToolbarItem.j
+31 -30
View File
@@ -57,7 +57,8 @@ CPToolbarPrintItemIdentifier = @"CPToolbarPrintItemIdentifier";
var _CPToolbarSeparatorItemView = nil;
/*
/*! @class CPToolbarItem
A representation of an item in a <objj>CPToolbar</objj>.
*/
@implementation CPToolbarItem : CPObject
@@ -83,7 +84,7 @@ var _CPToolbarSeparatorItemView = nil;
}
// Creating a Toolbar Item
/*
/*!
Initializes the toolbar item with a specified identifier.
@param anItemIdentifier the item's identifier
@return the initialized toolbar item
@@ -106,7 +107,7 @@ var _CPToolbarSeparatorItemView = nil;
}
// Managing Attributes
/*
/*!
Returns the item's identifier.
*/
- (CPString)itemIdentifier
@@ -114,7 +115,7 @@ var _CPToolbarSeparatorItemView = nil;
return _itemIdentifier;
}
/*
/*!
Returns the toolbar of which this item is a part.
*/
- (CPToolbar)toolbar
@@ -122,7 +123,7 @@ var _CPToolbarSeparatorItemView = nil;
return _toolbar;
}
/*
/*!
Returns the item's label
*/
- (CPString)label
@@ -130,7 +131,7 @@ var _CPToolbarSeparatorItemView = nil;
return _label;
}
/*
/*!
Sets the item's label.
@param aLabel the new label for the item
*/
@@ -139,7 +140,7 @@ var _CPToolbarSeparatorItemView = nil;
_label = aLabel;
}
/*
/*!
Returns the palette label.
*/
- (CPString)paletteLabel
@@ -147,7 +148,7 @@ var _CPToolbarSeparatorItemView = nil;
return _paletteLabel;
}
/*
/*!
Sets the palette label
@param aPaletteLabel the new palette label
*/
@@ -156,7 +157,7 @@ var _CPToolbarSeparatorItemView = nil;
_paletteLabel = aPaletteLabel;
}
/*
/*!
Returns the item's tooltip. A tooltip pops up
next to the cursor when the user hovers over
the item with the mouse.
@@ -166,7 +167,7 @@ var _CPToolbarSeparatorItemView = nil;
return _toolTip;
}
/*
/*!
Sets the item's tooltip. A tooltip pops up next to the cursor when the user hovers over the item with the mouse.
@param aToolTip the new item tool tip
*/
@@ -175,7 +176,7 @@ var _CPToolbarSeparatorItemView = nil;
_toolTip = aToolTip;
}
/*
/*!
Returns the item's tag.
*/
- (int)tag
@@ -183,7 +184,7 @@ var _CPToolbarSeparatorItemView = nil;
return _tag;
}
/*
/*!
Sets the item's tag.
@param aTag the new tag for the item
*/
@@ -192,7 +193,7 @@ var _CPToolbarSeparatorItemView = nil;
_tag = aTag;
}
/*
/*!
Returns the item's action target.
*/
- (id)target
@@ -200,7 +201,7 @@ var _CPToolbarSeparatorItemView = nil;
return _target;
}
/*
/*!
Sets the target of the action that is triggered when the user clicks this item. <code>nil</code> will cause
the action to be passed on to the first responder.
@param aTarget the new target
@@ -210,7 +211,7 @@ var _CPToolbarSeparatorItemView = nil;
_target = aTarget;
}
/*
/*!
Returns the action that is triggered when the user clicks this item.
*/
- (SEL)action
@@ -218,7 +219,7 @@ var _CPToolbarSeparatorItemView = nil;
return _action;
}
/*
/*!
Sets the action that is triggered when the user clicks this item.
@param anAction the new action
*/
@@ -227,7 +228,7 @@ var _CPToolbarSeparatorItemView = nil;
_action = anAction;
}
/*
/*!
Returns <code>YES</code> if the item is enabled.
*/
- (BOOL)isEnabled
@@ -235,7 +236,7 @@ var _CPToolbarSeparatorItemView = nil;
return _isEnabled;
}
/*
/*!
Sets whether the item is enabled.
@param aFlag <code>YES</code> enables the item
*/
@@ -244,7 +245,7 @@ var _CPToolbarSeparatorItemView = nil;
_isEnabled = aFlag;
}
/*
/*!
Returns the item's image
*/
- (CPImage)image
@@ -252,7 +253,7 @@ var _CPToolbarSeparatorItemView = nil;
return _image;
}
/*
/*!
Sets the item's image.
@param anImage the new item image
*/
@@ -277,7 +278,7 @@ var _CPToolbarSeparatorItemView = nil;
}
}
/*
/*!
Sets the alternate image. This image is displayed on the item when the user is clicking it.
@param anImage the new alternate image
*/
@@ -289,7 +290,7 @@ var _CPToolbarSeparatorItemView = nil;
[_view setAlternateImage:anImage];
}
/*
/*!
Returns the alternate image. This image is displayed on the item when the user is clicking it.
*/
- (CPImage)alternateImage
@@ -297,7 +298,7 @@ var _CPToolbarSeparatorItemView = nil;
return _alternateImage;
}
/*
/*!
Returns the item's view.
*/
- (CPView)view
@@ -305,7 +306,7 @@ var _CPToolbarSeparatorItemView = nil;
return _view;
}
/*
/*!
Sets the item's view
@param aView the item's new view
*/
@@ -314,7 +315,7 @@ var _CPToolbarSeparatorItemView = nil;
_view = aView;
}
/*
/*!
Returns the item's minimum size.
*/
- (CGSize)minSize
@@ -322,7 +323,7 @@ var _CPToolbarSeparatorItemView = nil;
return _minSize;
}
/*
/*!
Sets the item's minimum size.
@param aMinSize the new minimum size
*/
@@ -334,7 +335,7 @@ var _CPToolbarSeparatorItemView = nil;
_maxSize = CGSizeMake(MAX(_minSize.width, _maxSize.width), MAX(_minSize.height, _maxSize.height));
}
/*
/*!
Returns the item's maximum size.
*/
- (CGSize)maxSize
@@ -342,7 +343,7 @@ var _CPToolbarSeparatorItemView = nil;
return _maxSize;
}
/*
/*!
Sets the item's new maximum size.
@param aMaxSize the new maximum size
*/
@@ -355,7 +356,7 @@ var _CPToolbarSeparatorItemView = nil;
}
// Visibility Priority
/*
/*!
Returns the item's visibility priority. The value will be one of:
<pre>
CPToolbarItemVisibilityPriorityStandard
@@ -369,7 +370,7 @@ CPToolbarItemVisibilityPriorityUser
return _visibilityPriority;
}
/*
/*!
Sets the item's visibility priority. The value must be one of:
<pre>
CPToolbarItemVisibilityPriorityStandard
AppKit/CPView.j
+86 -85
View File
@@ -99,7 +99,8 @@ var DOMElementPrototype = nil,
CustomDrawRectViews = {};
#endif
/*
/*! @class CPView
<objj>CPView</objj> is an abstract class which provides facilities for drawing
in a window and receiving events. It is the superclass of many of the visual
elements of the GUI.</p>
@@ -195,7 +196,7 @@ var DOMElementPrototype = nil,
return [self initWithFrame:CGRectMakeZero()];
}
/*
/*!
Initializes the receiver for usage with the specified bounding rectangle
@return the initialized view
*/
@@ -240,7 +241,7 @@ var DOMElementPrototype = nil,
return self;
}
/*
/*!
Returns the container view of the receiver
@return the receiver's containing view
*/
@@ -249,7 +250,7 @@ var DOMElementPrototype = nil,
return _superview;
}
/*
/*!
Returns an array of all the views contained as direct children of the receiver
@return an array of <objj>CPView</objj>s
*/
@@ -258,7 +259,7 @@ var DOMElementPrototype = nil,
return _subviews;
}
/*
/*!
Returns the window containing this receiver
*/
- (CPWindow)window
@@ -266,7 +267,7 @@ var DOMElementPrototype = nil,
return _window;
}
/*
/*!
Makes the argument a subview of the receiver.
@param aSubview the <objj>CPView</objj> to make a subview
*/
@@ -275,7 +276,7 @@ var DOMElementPrototype = nil,
[self _insertSubview:aSubview atIndex:CPNotFound];
}
/*
/*!
Makes <code>aSubview</code> a subview of the receiver. It is positioned relative to <code>anotherView</code>
@param aSubview the view to add as a subview
@param anOrderingMode specifies <code>aSubview</code>'s ordering relative to <code>anotherView</code>
@@ -359,7 +360,7 @@ var DOMElementPrototype = nil,
[self didAddSubview:aSubview];
}
/*
/*!
Called when the receiver has added <code>aSubview</code> to it's child views.
@param aSubview the view that was added
*/
@@ -367,7 +368,7 @@ var DOMElementPrototype = nil,
{
}
/*
/*!
Removes the receiver from it's container view and window.
Does nothing if there's no container view.
*/
@@ -388,7 +389,7 @@ var DOMElementPrototype = nil,
[self _setWindow:nil];
}
/*
/*!
Replaces the specified child view with another view
@param aSubview the view to replace
@param aView the replacement view
@@ -421,7 +422,7 @@ var DOMElementPrototype = nil,
[self viewDidMoveToWindow];
}
/*
/*!
Returns <code>YES</code> if the receiver is, or is a descendant of, <code>aView</code>.
@param aView the view to test for ancestry
*/
@@ -438,7 +439,7 @@ var DOMElementPrototype = nil,
return NO;
}
/*
/*!
Called when the receiver's superview has changed.
*/
- (void)viewDidMoveToSuperview
@@ -447,14 +448,14 @@ var DOMElementPrototype = nil,
[self setNeedsDisplay:YES];
}
/*
/*!
Called when the receiver has been moved to a new <objj>CPWindow</objj>.
*/
- (void)viewDidMoveToWindow
{
}
/*
/*!
Called when the receiver is about to be moved to a new view.
@param aView the view to which the receiver will be moved
*/
@@ -462,7 +463,7 @@ var DOMElementPrototype = nil,
{
}
/*
/*!
Called when the receiver is about to be moved to a new window.
@param aWindow the window to which the receiver will be moved.
*/
@@ -470,7 +471,7 @@ var DOMElementPrototype = nil,
{
}
/*
/*!
Called when the receiver is about to be remove one of its subviews.
@param aView the view that will be removed
*/
@@ -478,7 +479,7 @@ var DOMElementPrototype = nil,
{
}
/*
/*!
Returns the menu item containing the receiver or one of its ancestor views.
@return a menu item, or <code>nil</code> if the view or one of its ancestors wasn't found
*/
@@ -507,7 +508,7 @@ var DOMElementPrototype = nil,
return _tag;
}
/*
/*!
Returns whether the view is flipped.
@return <code>YES</code> if the view is flipped. <code>NO</code>, otherwise.
*/
@@ -516,7 +517,7 @@ var DOMElementPrototype = nil,
return YES;
}
/*
/*!
Sets the frame size of the receiver to the dimensions and origin of the provided rectangle in the coordinate system
of the superview. The method also posts an <objj>CPViewFrameDidChangeNotification</objj> to the notification
center if the receiver is configured to do so. If the frame is the same as the current frame, the method simply
@@ -539,7 +540,7 @@ var DOMElementPrototype = nil,
[_CPViewNotificationCenter postNotificationName:CPViewFrameDidChangeNotification object:self];
}
/*
/*!
Returns the receiver's frame.
@return a copy of the receiver's frame
*/
@@ -548,7 +549,7 @@ var DOMElementPrototype = nil,
return _CGRectMakeCopy(_frame);
}
/*
/*!
Sets the receiver's frame origin to the provided point. The point is defined in the superview's coordinate system.
The method posts a <objj>CPViewFrameDidChangeNotification</objj> to the default notification center if the receiver
is configured to do so. If the specified origin is the same as the frame's current origin, the method will
@@ -573,7 +574,7 @@ var DOMElementPrototype = nil,
#endif
}
/*
/*!
Sets the receiver's frame size. If <code>aSize</code> is the same as the frame's current dimensions, this
method simply returns. The method posts a <objj>CPViewFrameDidChangeNotification</objj> to the
default notification center if the receiver is configured to do so.
@@ -646,7 +647,7 @@ var DOMElementPrototype = nil,
#endif
}
/*
/*!
Sets the receiver's bounds. The bounds define the size and location of the receiver inside it's frame. Posts a
<objj>CPViewBoundsDidChangeNotification</objj> to the default notification center if the receiver is configured to do so.
@param bounds the new bounds
@@ -667,7 +668,7 @@ var DOMElementPrototype = nil,
[_CPViewNotificationCenter postNotificationName:CPViewBoundsDidChangeNotification object:self];
}
/*
/*!
Returns the receiver's bounds. The bounds define the size
and location of the receiver inside its frame.
*/
@@ -676,7 +677,7 @@ var DOMElementPrototype = nil,
return _CGRectMakeCopy(_bounds);
}
/*
/*!
Sets the location of the receiver inside its frame. The method
posts a <objj>CPViewBoundsDidChangeNotification</objj> to the
default notification center if the receiver is configured to do so.
@@ -719,7 +720,7 @@ var DOMElementPrototype = nil,
[_CPViewNotificationCenter postNotificationName:CPViewBoundsDidChangeNotification object:self];
}
/*
/*!
Sets the receiver's size inside its frame. The method posts a
<objj>CPViewBoundsDidChangeNotification</objj> to the default
notification center if the receiver is configured to do so.
@@ -758,7 +759,7 @@ var DOMElementPrototype = nil,
}
/*
/*!
Notifies subviews that the superview changed size.
@param aSize the size of the old superview
*/
@@ -789,7 +790,7 @@ var DOMElementPrototype = nil,
[self setFrame:newFrame];
}
/*
/*!
Initiates <code>superviewSizeChanged:</code> messages to subviews.
@param aSize the size for the subviews
*/
@@ -801,7 +802,7 @@ var DOMElementPrototype = nil,
[_subviews[count] resizeWithOldSuperviewSize:aSize];
}
/*
/*!
Specifies whether the receiver view should automatically resize its
subviews when its <code>setFrameSize:</code> method receives a change.
@param aFlag If <code>YES</code>, then subviews will automatically be resized
@@ -813,7 +814,7 @@ var DOMElementPrototype = nil,
_autoresizesSubviews = aFlag;
}
/*
/*!
Reports whether the receiver automatically resizes its subviews when its frame size changes.
@return <code>YES</code> means it resizes its subviews on a frame size change.
*/
@@ -822,7 +823,7 @@ var DOMElementPrototype = nil,
return _autoresizesSubviews;
}
/*
/*!
Determines automatic resizing behavior.
@param aMask a bit mask with options
*/
@@ -831,7 +832,7 @@ var DOMElementPrototype = nil,
_autoresizingMask = aMask;
}
/*
/*!
Returns the bit mask options for resizing behavior
*/
- (unsigned)autoresizingMask
@@ -840,7 +841,7 @@ var DOMElementPrototype = nil,
}
// Fullscreen Mode
/*
/*!
Puts the receiver into full screen mode.
@param aScreen the that should be used
@param options configuration options
@@ -871,7 +872,7 @@ var DOMElementPrototype = nil,
return YES;
}
/*
/*!
The receiver should exit full screen mode.
@param options configurations options
*/
@@ -889,7 +890,7 @@ var DOMElementPrototype = nil,
[[self window] orderOut:self];
}
/*
/*!
Returns <code>YES</code> if the receiver is currently in full screen mode.
*/
- (BOOL)isInFullScreenMode
@@ -897,7 +898,7 @@ var DOMElementPrototype = nil,
return _isInFullScreenMode;
}
/*
/*!
Sets whether the receiver should be hidden.
@param aFlag <code>YES</code> makes the receiver hidden.
*/
@@ -913,7 +914,7 @@ var DOMElementPrototype = nil,
#endif
}
/*
/*!
Returns <code>YES</code> if the receiver is hidden.
*/
- (BOOL)isHidden
@@ -921,7 +922,7 @@ var DOMElementPrototype = nil,
return _isHidden;
}
/*
/*!
Sets the opacity of the receiver. The value must be in the range of 0.0 to 1.0, where 0.0 is
completely transparent and 1.0 is completely opaque.
@param anAlphaValue an alpha value ranging from 0.0 to 1.0.
@@ -943,7 +944,7 @@ var DOMElementPrototype = nil,
#endif
}
/*
/*!
Returns the alpha value of the receiver. Ranges from 0.0 to
1.0, where 0.0 is completely transparent and 1.0 is completely opaque.
*/
@@ -952,7 +953,7 @@ var DOMElementPrototype = nil,
return _opacity;
}
/*
/*!
Returns <code>YES</code> if the receiver is hidden, or one
of it's ancestor views is hidden. <code>NO</code>, otherwise.
*/
@@ -966,7 +967,7 @@ var DOMElementPrototype = nil,
return view != nil;
}
/*
/*!
Returns whether the receiver should be sent a <code>mouseDown:</code> message for <code>anEvent</code>.<br/>
Returns <code>YES</code> by default.
@return <code>YES</code>, if the view object accepts first mouse-down event. <code>NO</code>, otherwise.
@@ -977,7 +978,7 @@ var DOMElementPrototype = nil,
return YES;
}
/*
/*!
Returns whether or not the view responds to hit tests.
@return <code>YES</code> if this view listens to hitTest messages, <code>NO</code> otherwise.
*/
@@ -986,7 +987,7 @@ var DOMElementPrototype = nil,
return YES;
}
/*
/*!
Set whether or not the view should respond to hit tests.
@param shouldHitTest should be <code>YES</code> if this view should respond to hit tests, <code>NO</code> otherwise.
*/
@@ -995,7 +996,7 @@ var DOMElementPrototype = nil,
_hitTests = shouldHitTest;
}
/*
/*!
Tests whether a point is contained within this view, or one of its subviews.
@param aPoint the point to test
@return returns the containing view, or nil if the point is not contained
@@ -1019,7 +1020,7 @@ var DOMElementPrototype = nil,
return self;
}
/*
/*!
Returns <code>YES</code> if mouse events aren't needed by the receiver and can be sent to the superview. The
default implementation returns <code>NO</code> if the view is opaque.
*/
@@ -1034,7 +1035,7 @@ var DOMElementPrototype = nil,
[super mouseDown:anEvent];
}
/*
/*!
Sets the background color of the receiver.
@param aColor the new color for the receiver's background
*/
@@ -1149,7 +1150,7 @@ var DOMElementPrototype = nil,
#endif
}
/*
/*!
Returns the background color of the receiver
*/
- (CPColor)backgroundColor
@@ -1158,7 +1159,7 @@ var DOMElementPrototype = nil,
}
// Converting Coordinates
/*
/*!
Converts <code>aPoint</code> from the coordinate space of <code>aView</code> to the coordinate space of the receiver.
@param aPoint the point to convert
@param aView the view space to convert from
@@ -1169,7 +1170,7 @@ var DOMElementPrototype = nil,
return CGPointApplyAffineTransform(aPoint, _CPViewGetTransform(aView, self));
}
/*
/*!
Converts <code>aPoint</code> from the receiver's coordinate space to the coordinate space of <code>aView</code>.
@param aPoint the point to convert
@param aView the coordinate space to which the point will be converted
@@ -1180,7 +1181,7 @@ var DOMElementPrototype = nil,
return CGPointApplyAffineTransform(aPoint, _CPViewGetTransform(self, aView));
}
/*
/*!
Convert's <code>aSize</code> from <code>aView</code>'s coordinate space to the receiver's coordinate space.
@param aSize the size to convert
@param aView the coordinate space to convert from
@@ -1191,7 +1192,7 @@ var DOMElementPrototype = nil,
return CGSizeApplyAffineTransform(aSize, _CPViewGetTransform(aView, self));
}
/*
/*!
Convert's <code>aSize</code> from the receiver's coordinate space to <code>aView</code>'s coordinate space.
@param aSize the size to convert
@param the coordinate space to which the size will be converted
@@ -1202,7 +1203,7 @@ var DOMElementPrototype = nil,
return CGSizeApplyAffineTransform(aSize, _CPViewGetTransform(self, aView));
}
/*
/*!
Converts <code>aRect</code> from <code>aView</code>'s coordinate space to the receiver's space.
@param aRect the rectangle to convert
@param aView the coordinate space from which to convert
@@ -1213,7 +1214,7 @@ var DOMElementPrototype = nil,
return CGRectApplyAffineTransform(aRect, _CPViewGetTransform(aView, self));
}
/*
/*!
Converts <code>aRect</code> from the receiver's coordinate space to <code>aView</code>'s coordinate space.
@param aRect the rectangle to convert
@param aView the coordinate space to which the rectangle will be converted
@@ -1224,7 +1225,7 @@ var DOMElementPrototype = nil,
return CGRectApplyAffineTransform(aRect, _CPViewGetTransform(self, aView));
}
/*
/*!
Sets whether the receiver posts a <objj>CPViewFrameDidChangeNotification</objj> notification
to the default notification center when its frame is changed. The default is <code>NO</code>.
Methods that could cause a frame change notification are:
@@ -1247,7 +1248,7 @@ setFrameOrigin:
[_CPViewNotificationCenter postNotificationName:CPViewFrameDidChangeNotification object:self];
}
/*
/*!
Returns <code>YES</code> if the receiver posts a <objj>CPViewFrameDidChangeNotification</objj> if its frame is changed.
*/
- (BOOL)postsFrameChangedNotifications
@@ -1255,7 +1256,7 @@ setFrameOrigin:
return _postsFrameChangedNotifications;
}
/*
/*!
Sets whether the receiver posts a <objj>CPViewBoundsDidChangeNotification</objj> notification
to the default notification center when its bounds is changed. The default is <code>NO</code>.
Methods that could cause a bounds change notification are:
@@ -1278,7 +1279,7 @@ setBoundsOrigin:
[_CPViewNotificationCenter postNotificationName:CPViewBoundsDidChangeNotification object:self];
}
/*
/*!
Returns <code>YES</code> if the receiver posts a
<objj>CPViewBoundsDidChangeNotification</objj> when its
bounds is changed.
@@ -1288,7 +1289,7 @@ setBoundsOrigin:
return _postsBoundsChangedNotifications;
}
/*
/*!
Initiates a drag operation from the receiver to another view that accepts dragged data.
@param anImage the image to be dragged
@param aLocation the lower-left corner coordinate of <code>anImage</code>
@@ -1303,7 +1304,7 @@ setBoundsOrigin:
[_window dragImage:anImage at:[self convertPoint:aLocation toView:nil] offset:mouseOffset event:anEvent pasteboard:aPasteboard source:aSourceObject slideBack:slideBack];
}
/*
/*!
Initiates a drag operation from the receiver to another view that accepts dragged data.
@param aView the view to be dragged
@param aLocation the lower-left corner coordinate of <code>aView</code>
@@ -1318,7 +1319,7 @@ setBoundsOrigin:
[_window dragView:aView at:[self convertPoint:aLocation toView:nil] offset:mouseOffset event:anEvent pasteboard:aPasteboard source:aSourceObject slideBack:slideBack];
}
/*
/*!
Sets the receiver's list of acceptable data types for a dragging operation.
@param pasteboardTypes an array of <objj>CPPasteboard</objj>s
*/
@@ -1327,7 +1328,7 @@ setBoundsOrigin:
_registeredDraggedTypes = [pasteboardTypes copy];
}
/*
/*!
Returns an array of all types the receiver accepts for dragging operations.
@return an array of <objj>CPPasteBoard</objj>s
*/
@@ -1336,7 +1337,7 @@ setBoundsOrigin:
return _registeredDraggedTypes;
}
/*
/*!
Resets the array of acceptable data types for a dragging operation.
*/
- (void)unregisterDraggedTypes
@@ -1344,7 +1345,7 @@ setBoundsOrigin:
_registeredDraggedTypes = nil;
}
/*
/*!
Draws the receiver into <code>aRect</code>. This method should be overridden by subclasses.
@param aRect the area that should be drawn into
*/
@@ -1355,7 +1356,7 @@ setBoundsOrigin:
// Displaying
/*
/*!
Marks the entire view as dirty, and needing a redraw.
*/
- (void)setNeedsDisplay:(BOOL)aFlag
@@ -1368,7 +1369,7 @@ setBoundsOrigin:
#endif
}
/*
/*!
Marks the area denoted by <code>aRect</code> as dirty, and initiates a redraw on it.
@param aRect the area that needs to be redrawn
*/
@@ -1406,7 +1407,7 @@ setBoundsOrigin:
return _dirtyRect && !_CGRectIsEmpty(_dirtyRect);
}
/*
/*!
Displays the receiver and any of its subviews that need to be displayed.
*/
- (void)displayIfNeeded
@@ -1415,7 +1416,7 @@ setBoundsOrigin:
[self displayRect:_dirtyRect];
}
/*
/*!
Draws the entire area of the receiver as defined by its <code>bounds</code>.
*/
- (void)display
@@ -1429,7 +1430,7 @@ setBoundsOrigin:
[self displayRect:aRect];
}
/*
/*!
Draws the receiver into the area defined by <code>aRect</code>.
@param aRect the area to be drawn
*/
@@ -1456,7 +1457,7 @@ setBoundsOrigin:
{
}
/*
/*!
Locks focus on the receiver, so drawing commands apply to it.
*/
- (void)lockFocus
@@ -1491,7 +1492,7 @@ setBoundsOrigin:
CGContextSaveGState([_graphicsContext graphicsPort]);
}
/*
/*!
Takes focus away from the receiver, and restores it to the previous view.
*/
- (void)unlockFocus
@@ -1501,7 +1502,7 @@ setBoundsOrigin:
[CPGraphicsContext setCurrentContext:nil];
}
/*
/*!
Returns whether the receiver is completely opaque. By default, returns <code>NO</code>.
*/
- (BOOL)isOpaque
@@ -1509,7 +1510,7 @@ setBoundsOrigin:
return NO;
}
/*
/*!
Returns the rectangle of the receiver not clipped by its superview.
*/
- (CGRect)visibleRect
@@ -1533,7 +1534,7 @@ setBoundsOrigin:
return superview;
}
/*
/*!
Changes the receiver's frame origin to a 'constrained' <code>aPoint</code>.
@param aPoint the proposed frame origin
*/
@@ -1547,7 +1548,7 @@ setBoundsOrigin:
[clipView scrollToPoint:[self convertPoint:aPoint toView:clipView]];
}
/*
/*!
Scrolls the nearest ancestor <objj>CPClipView</objj> a minimum amount so <code>aRect</code> can become visible.
@param aRect the area to become visible
@return <codeYES</code> if any scrolling occurred, <code>NO</code> otherwise.
@@ -1596,7 +1597,7 @@ setBoundsOrigin:
return NO;
}
/*
/*!
Subclasses can override this to modify the visible rectangle after a
scrolling operation. The default implementation simply returns the provided rectangle.
@param proposedVisibleRect the rectangle to alter
@@ -1607,7 +1608,7 @@ setBoundsOrigin:
return proposedVisibleRect;
}
/*
/*!
Should be overridden by subclasses.
*/
- (void)scrollRect:(CGRect)aRect by:(float)anAmount
@@ -1615,7 +1616,7 @@ setBoundsOrigin:
}
/*
/*!
Returns the <objj>CPScrollView</objj> containing the receiver.
@return the <objj>CPScrollView</objj> containing the receiver.
*/
@@ -1630,7 +1631,7 @@ setBoundsOrigin:
return superview;
}
/*
/*!
Scrolls the clip view to a specified point
@param the clip view to scoll
@param the point to scroll to
@@ -1640,7 +1641,7 @@ setBoundsOrigin:
[aClipView scrollToPoint:aPoint];
}
/*
/*!
Notifies the receiver (superview of a <objj>CPClipView</objj>)
that the clip view bounds or the document view bounds have changed.
@param aClipView the clip view of the superview being notified
@@ -1653,7 +1654,7 @@ setBoundsOrigin:
@implementation CPView (CoreAnimationAdditions)
/*
/*!
Sets the core animation layer to be used by this receiver.
*/
- (void)setLayer:(CALayer)aLayer
@@ -1685,7 +1686,7 @@ setBoundsOrigin:
}
}
/*
/*!
Returns the core animation layer used by the receiver.
*/
- (CALayer)layer
@@ -1693,7 +1694,7 @@ setBoundsOrigin:
return _layer;
}
/*
/*!
Sets whether the receiver wants a core animation layer.
@param <code>YES</code> means the receiver wants a layer.
*/
@@ -1702,7 +1703,7 @@ setBoundsOrigin:
_wantsLayer = aFlag;
}
/*
/*!
Returns <code>YES</code> if the receiver uses a <objj>CALayer</objj>
@returns <code>YES</code> if the receiver uses a <objj>CALayer</objj>
*/
@@ -1728,7 +1729,7 @@ var CPViewAutoresizingMaskKey = @"CPViewAutoresizingMask",
@implementation CPView (CPCoding)
/*
/*!
Initializes the view from an archive.
@param aCoder the coder from which to initialize
@return the initialized view
@@ -1792,7 +1793,7 @@ var CPViewAutoresizingMaskKey = @"CPViewAutoresizingMask",
return self;
}
/*
/*!
Archives the view to a coder.
@param aCoder the object into which the view's data will be archived.
*/
AppKit/CPWindow.j
+78 -75
View File
@@ -184,7 +184,8 @@ var SHADOW_MARGIN_LEFT = 20.0,
var CPWindowSaveImage = nil,
CPWindowSavingImage = nil;
/*
/*! @class CPWindow
An <objj>CPWindow</objj> instance represents a window, panel or menu on the screen.</p>
<p>Each window has a style, which determines how the window is decorated; whether it has a border, a title bar, a resize bar, minimise and close buttons.</p>
@@ -195,6 +196,8 @@ var CPWindowSaveImage = nil,
<p>You can convert between view coordinates and window base coordinates using the <objj>[CPView -convertPoint:fromView:]</objj>, <objj>[CPView -convertPoint:toView:]</objj>, <objj>[CPView -convertRect:fromView:]</objj>, and <objj>[CPView -convertRect:toView:]</objj> methods with a <objj>nil</objj> view argument.
@par Delegate Methods
@delegate -(void)windowDidResize:(CPNotification)notification;
Sent from the notification center when the window has been resized.
@param notification contains information about the resize event
@@ -294,7 +297,7 @@ var CPWindowSaveImage = nil,
CPWindowSavingImage = [[CPImage alloc] initWithContentsOfFile:[bundle pathForResource:@"CPProgressIndicator/CPProgressIndicatorSpinningStyleRegular.gif"] size:CGSizeMake(16.0, 16.0)]
}
/*
/*!
Initializes the window. The method also takes a style bit mask made up
of any of the following values:
<pre>
@@ -314,7 +317,7 @@ CPTexturedBackgroundWindowMask
return [self initWithContentRect:aContentRect styleMask:aStyleMask bridge:[CPDOMWindowBridge sharedDOMWindowBridge]];
}
/*
/*!
Initializes the window. The method also takes a style bit mask made up
of any of the following values:
<pre>
@@ -388,7 +391,7 @@ CPTexturedBackgroundWindowMask
return self;
}
/*
/*!
Returns the window's style mask.
*/
- (unsigned)styleMask
@@ -396,7 +399,7 @@ CPTexturedBackgroundWindowMask
return _styleMask;
}
/*
/*!
Returns the frame rectangle used by a window.
@param aContentRect the content rectangle of the window
@param aStyleMask the style mask of the window
@@ -409,7 +412,7 @@ CPTexturedBackgroundWindowMask
return frame;
}
/*
/*!
Returns the receiver's content rectangle. A content rectangle does not include toolbars.
@param aFrame the window's frame rectangle
*/
@@ -442,7 +445,7 @@ CPTexturedBackgroundWindowMask
return contentRect;
}
/*
/*!
Retrieves the frame rectangle for this window.
@param aContentRect the window's content rectangle
@return the window's frame rectangle
@@ -457,7 +460,7 @@ CPTexturedBackgroundWindowMask
return frame;
}
/*
/*!
Returns the window's frame rectangle
*/
- (CGRect)frame
@@ -465,7 +468,7 @@ CPTexturedBackgroundWindowMask
return _frame;
}
/*
/*!
Sets the window's frame rectangle. Also tells the window whether it should animate
the resize operation, and redraw itself if necessary.
@param aFrame the new size and location for the window
@@ -487,7 +490,7 @@ CPTexturedBackgroundWindowMask
}
}
/*
/*!
Sets the window's frame rectangle
*/
- (void)setFrame:(CGRect)aFrame
@@ -495,7 +498,7 @@ CPTexturedBackgroundWindowMask
[self setFrame:aFrame display:YES animate:NO];
}
/*
/*!
Sets the window's location.
@param anOrigin the new location for the window
*/
@@ -514,7 +517,7 @@ CPTexturedBackgroundWindowMask
#endif
}
/*
/*!
Sets the window's size.
@param aSize the new size for the window
*/
@@ -581,7 +584,7 @@ CPTexturedBackgroundWindowMask
[CPApp setTarget:self selector:@selector(trackResizeWithEvent:) forNextEventMatchingMask:CPLeftMouseDraggedMask | CPLeftMouseUpMask untilDate:nil inMode:nil dequeue:YES];
}
/*
/*!
Makes the receiver the front most window in the screen ordering.
@param aSender the object that requested this
*/
@@ -600,7 +603,7 @@ CPTexturedBackgroundWindowMask
//[_bridge order:CPWindowBelow
}
/*
/*!
Hides the window.
@param the object that requested this
*/
@@ -619,7 +622,7 @@ CPTexturedBackgroundWindowMask
}
}
/*
/*!
Relocates the window in the screen list.
@param aPlace the positioning relative to <code>otherWindowNumber</code>
@param otherWindowNumber the window relative to which the receiver should be placed
@@ -629,7 +632,7 @@ CPTexturedBackgroundWindowMask
[_bridge order:aPlace window:self relativeTo:CPApp._windows[otherWindowNumber]];
}
/*
/*!
Sets the window's level
@param the window's new level
*/
@@ -638,7 +641,7 @@ CPTexturedBackgroundWindowMask
_level = aLevel;
}
/*
/*!
Returns the window's current level
*/
- (int)level
@@ -646,7 +649,7 @@ CPTexturedBackgroundWindowMask
return _level;
}
/*
/*!
Returns <code>YES</code> if the window is visible. It does not mean that the window is not obscured by other windows.
*/
- (BOOL)isVisible
@@ -654,7 +657,7 @@ CPTexturedBackgroundWindowMask
return _isVisible;
}
/*
/*!
Returns <code>YES</code> if the window's resize indicator is showing. <code>NO</code> otherwise.
*/
- (BOOL)showsResizeIndicator
@@ -662,7 +665,7 @@ CPTexturedBackgroundWindowMask
return [_windowView showsResizeIndicator];
}
/*
/*!
Sets the window's resize indicator.
@param shouldShowResizeIndicator <code>YES</code> sets the window to show its resize indicator.
*/
@@ -671,7 +674,7 @@ CPTexturedBackgroundWindowMask
[_windowView setShowsResizeIndicator:shouldShowResizeIndicator];
}
/*
/*!
Returns the offset of the window's resize indicator.
*/
- (CGSize)resizeIndicatorOffset
@@ -679,7 +682,7 @@ CPTexturedBackgroundWindowMask
return [_windowView resizeIndicatorOffset];
}
/*
/*!
Sets the offset of the window's resize indicator.
@param aSize the offset for the resize indicator
*/
@@ -688,7 +691,7 @@ CPTexturedBackgroundWindowMask
[_windowView setResizeIndicatorOffset:anOffset];
}
/*
/*!
Sets the window's content view. The new view will be resized to fit
inside the content rectangle of the window.
@param aView the new content view for the receiver
@@ -705,7 +708,7 @@ CPTexturedBackgroundWindowMask
[_windowView addSubview:_contentView positioned:CPWindowBelow relativeTo:nil];
}
/*
/*!
Returns the window's current content view.
*/
- (CPView)contentView
@@ -713,7 +716,7 @@ CPTexturedBackgroundWindowMask
return _contentView;
}
/*
/*!
Sets the window's background color.
@param aColor the new color for the background
*/
@@ -722,7 +725,7 @@ CPTexturedBackgroundWindowMask
[_windowView setBackgroundColor:aColor];
}
/*
/*!
Returns the window's background color.
*/
- (CPColor)backgroundColor
@@ -730,7 +733,7 @@ CPTexturedBackgroundWindowMask
return [_windowView backgroundColor];
}
/*
/*!
Sets the window's minimum size. If the provided
size is the same as the current minimum size, the method simply returns.
@aSize the new minimum size for the window
@@ -761,7 +764,7 @@ CPTexturedBackgroundWindowMask
[self setFrameSize:size];
}
/*
/*!
Returns the windows minimum size.
*/
- (CGSize)minSize
@@ -769,7 +772,7 @@ CPTexturedBackgroundWindowMask
return _minSize;
}
/*
/*!
Sets the window's maximum size. If the provided
size is the same as the current maximum size,
the method simply returns.
@@ -801,7 +804,7 @@ CPTexturedBackgroundWindowMask
[self setFrameSize:size];
}
/*
/*!
Returns the window's maximum size.
*/
- (CGSize)maxSize
@@ -809,7 +812,7 @@ CPTexturedBackgroundWindowMask
return _maxSize;
}
/*
/*!
Returns <code>YES</code> if the window has a drop shadow. <code>NO</code> otherwise.
*/
- (BOOL)hasShadow
@@ -817,7 +820,7 @@ CPTexturedBackgroundWindowMask
return _hasShadow;
}
/*
/*!
Sets whether the window should have a drop shadow.
@param shouldHaveShadow <code>YES</code> to have a drop shadow.
*/
@@ -871,7 +874,7 @@ CPTexturedBackgroundWindowMask
}
}
/*
/*!
Sets the delegate for the window. Passing <code>nil</code> will just remove the window's current delegate.
@param aDelegate an object to respond to the various delegate methods of <objj>CPWindow</objj>
*/
@@ -898,7 +901,7 @@ CPTexturedBackgroundWindowMask
object:self];
}
/*
/*!
Returns window's delegate
*/
- (id)delegate
@@ -906,7 +909,7 @@ CPTexturedBackgroundWindowMask
return _delegate;
}
/*
/*!
Sets the window's controller
@param aWindowController a window controller
*/
@@ -915,7 +918,7 @@ CPTexturedBackgroundWindowMask
_windowController = aWindowController;
}
/*
/*!
Returns the window's controller.
*/
- (CPWindowController)windowController
@@ -936,7 +939,7 @@ CPTexturedBackgroundWindowMask
return YES;
}
/*
/*!
Attempts to make the <code>aResponder</code> the first responder. Before trying
to make it the first responder, the receiver will ask the current first responder
to resign its first responder status. If it resigns, it will ask
@@ -963,7 +966,7 @@ CPTexturedBackgroundWindowMask
return YES;
}
/*
/*!
Returns the window's current first responder.
*/
- (CPResponder)firstResponder
@@ -983,7 +986,7 @@ CPTexturedBackgroundWindowMask
// Managing Titles
/*
/*!
Returns the window's title bar string
*/
- (CPString)title
@@ -991,7 +994,7 @@ CPTexturedBackgroundWindowMask
return _title;
}
/*
/*!
Sets the window's title bar string
*/
- (void)setTitle:(CPString)aTitle
@@ -1003,7 +1006,7 @@ CPTexturedBackgroundWindowMask
[self _synchronizeMenuBarTitleWithWindowTitle];
}
/*
/*!
Sets the title bar to represent a file path
*/
- (void)setTitleWithRepresentedFilename:(CPString)aFilePath
@@ -1012,7 +1015,7 @@ CPTexturedBackgroundWindowMask
[self setTitle:[aFilePath lastPathComponent]];
}
/*
/*!
Sets the path to the file the receiver represents
*/
- (void)setRepresentedFilename:(CPString)aFilePath
@@ -1021,7 +1024,7 @@ CPTexturedBackgroundWindowMask
[self setRepresentedURL:aFilePath];
}
/*
/*!
Returns the path to the file the receiver represents
*/
- (CPString)representedFilename
@@ -1029,7 +1032,7 @@ CPTexturedBackgroundWindowMask
return _representedURL;
}
/*
/*!
Sets the URL that the receiver represents
*/
- (void)setRepresentedURL:(CPURL)aURL
@@ -1037,7 +1040,7 @@ CPTexturedBackgroundWindowMask
_representedURL = aURL;
}
/*
/*!
Returns the URL that the receiver represents
*/
- (CPURL)representedURL
@@ -1047,7 +1050,7 @@ CPTexturedBackgroundWindowMask
// Moving
/*
/*!
Sets whether the window can be moved by dragging its background. The default is based on the window style.
@param shouldBeMovableByWindowBackground <code>YES</code> makes the window move from a background drag.
*/
@@ -1056,7 +1059,7 @@ CPTexturedBackgroundWindowMask
_isMovableByWindowBackground = shouldBeMovableByWindowBackground;
}
/*
/*!
Returns <code>YES</code> if the window can be moved by dragging its background.
*/
- (BOOL)isMovableByWindowBackground
@@ -1064,7 +1067,7 @@ CPTexturedBackgroundWindowMask
return _isMovableByWindowBackground;
}
/*
/*!
Sets the window location to be the center of the screen
*/
- (void)center
@@ -1075,7 +1078,7 @@ CPTexturedBackgroundWindowMask
[self setFrameOrigin:CGPointMake((bridgeSize.width - size.width) / 2.0, (bridgeSize.height - size.height) / 2.0)];
}
/*
/*!
Dispatches events that are sent to it from <objj>CPApplication</objj>.
@param anEvent the event to be dispatched
*/
@@ -1149,7 +1152,7 @@ CPTexturedBackgroundWindowMask
}
}
/*
/*!
Returns the window's number in the desktop's screen list
*/
- (int)windowNumber
@@ -1157,7 +1160,7 @@ CPTexturedBackgroundWindowMask
return _windowNumber;
}
/*
/*!
Called when the receiver should become the key window. It also sends
the <code>becomeKeyWindow</code> message to the first responder.
*/
@@ -1167,7 +1170,7 @@ CPTexturedBackgroundWindowMask
[_firstResponder becomeKeyWindow];
}
/*
/*!
Determines if the window can become the key window.
@return <code>YES</code> means the window can become the key window.
*/
@@ -1176,7 +1179,7 @@ CPTexturedBackgroundWindowMask
return YES;
}
/*
/*!
Returns <code>YES</code> if the window is the key window.
*/
- (BOOL)isKeyWindow
@@ -1184,7 +1187,7 @@ CPTexturedBackgroundWindowMask
return [CPApp keyWindow] == self;
}
/*
/*!
Makes the window the key window and brings it to the front of the screen list.
@param aSender the object requesting this
*/
@@ -1196,7 +1199,7 @@ CPTexturedBackgroundWindowMask
[self makeMainWindow];
}
/*
/*!
Makes this window the key window.
*/
- (void)makeKeyWindow
@@ -1211,7 +1214,7 @@ CPTexturedBackgroundWindowMask
[self becomeKeyWindow];
}
/*
/*!
Causes the window to resign it's key window status.
*/
- (void)resignKeyWindow
@@ -1223,7 +1226,7 @@ CPTexturedBackgroundWindowMask
[_delegate windowDidResignKey:self];
}
/*
/*!
Initiates a drag operation from the receiver to another view that accepts dragged data.
@param anImage the image to be dragged
@param aLocation the lower-left corner coordinate of <code>anImage</code>
@@ -1238,7 +1241,7 @@ CPTexturedBackgroundWindowMask
[[CPDragServer sharedDragServer] dragImage:anImage fromWindow:self at:[self convertBaseToBridge:imageLocation] offset:mouseOffset event:anEvent pasteboard:aPasteboard source:aSourceObject slideBack:slideBack];
}
/*
/*!
Initiates a drag operation from the receiver to another view that accepts dragged data.
@param aView the view to be dragged
@param aLocation the lower-left corner coordinate of <code>aView</code>
@@ -1255,7 +1258,7 @@ CPTexturedBackgroundWindowMask
// Accessing Editing Status
/*
/*!
Sets whether the document has been edited.
@param isDocumentEdited <code>YES</code> if the document has been edited.
*/
@@ -1269,7 +1272,7 @@ CPTexturedBackgroundWindowMask
[CPMenu _setMenuBarIconImageAlphaValue:_isDocumentEdited ? 0.5 : 1.0];
}
/*
/*!
Returns <code>YES</code> if the document has been edited.
*/
- (BOOL)isDocumentEdited
@@ -1326,7 +1329,7 @@ CPTexturedBackgroundWindowMask
// Closing Windows
/*
/*!
Simulates the user closing the window, then closes the window.
@param aSender the object making this request
*/
@@ -1339,7 +1342,7 @@ CPTexturedBackgroundWindowMask
[self close];
}
/*
/*!
Closes the window. Posts a <code>CPWindowWillCloseNotification</code> to the
notification center before closing the window.
*/
@@ -1351,7 +1354,7 @@ CPTexturedBackgroundWindowMask
}
// Managing Main Status
/*
/*!
Returns <code>YES</code> if this the main window.
*/
- (BOOL)isMainWindow
@@ -1359,7 +1362,7 @@ CPTexturedBackgroundWindowMask
return [CPApp mainWindow] == self;
}
/*
/*!
Returns <code>YES</code> if the window can become the main window.
*/
- (BOOL)canBecomeMainWindow
@@ -1371,7 +1374,7 @@ CPTexturedBackgroundWindowMask
return NO;
}
/*
/*!
Makes the receiver the main window.
*/
- (void)makeMainWindow
@@ -1386,7 +1389,7 @@ CPTexturedBackgroundWindowMask
[self becomeMainWindow];
}
/*
/*!
Called to tell the receiver that it has become the main window.
*/
- (void)becomeMainWindow
@@ -1399,7 +1402,7 @@ CPTexturedBackgroundWindowMask
object:self];
}
/*
/*!
Called when the window resigns main window status.
*/
- (void)resignMainWindow
@@ -1410,7 +1413,7 @@ CPTexturedBackgroundWindowMask
}
// Managing Toolbars
/*
/*!
Return's the window's toolbar
*/
- (CPToolbar)toolbar
@@ -1418,7 +1421,7 @@ CPTexturedBackgroundWindowMask
return _toolbar;
}
/*
/*!
Sets the window's toolbar.
@param aToolbar the window's new toolbar
*/
@@ -1521,7 +1524,7 @@ CPTexturedBackgroundWindowMask
[_bridge order:CPWindowAbove window:aSheet relativeTo:self];
}
/*
/*!
Returns the window's attached sheet.
*/
- (CPWindow)attachedSheet
@@ -1529,7 +1532,7 @@ CPTexturedBackgroundWindowMask
return _attachedSheet;
}
/*
/*!
Returns <code>YES</code> if the window has ever run as a sheet.
*/
- (BOOL)isSheet
@@ -1547,7 +1550,7 @@ CPTexturedBackgroundWindowMask
return NO;
}
/*
/*!
Returns <code>YES</code> if the receiver is able to receive input events
even when a modal session is active.
*/
@@ -1662,7 +1665,7 @@ CPTexturedBackgroundWindowMask
}
// Undo and Redo Support
/*
/*!
Returns the window's undo manager.
*/
- (CPUndoManager)undoManager
@@ -1676,7 +1679,7 @@ CPTexturedBackgroundWindowMask
return _undoManager;
}
/*
/*!
Sends the undo manager an <code>undo</code> message.
@param aSender the object requesting this
*/
@@ -1685,7 +1688,7 @@ CPTexturedBackgroundWindowMask
[[self undoManager] undo];
}
/*
/*!
Sends the undo manager a <code>redo:</code> message.
@param aSender the object requesting this
*/
AppKit/CPWindowController.j
+17 -16
View File
@@ -29,7 +29,8 @@ import "CPDocument.j"
#include "Platform/Platform.h"
/*
/*! @class CPWindowController
An instance of a <objj>CPWindowController</objj> manages a <objj>CPWindow</objj>. It has methods
that get called when the window is loading, and after the window has loaded. In the
Model-View-Controller method of program design, the <objj>CPWindowController</objj> would be
@@ -43,7 +44,7 @@ import "CPDocument.j"
CPString _windowCibName;
}
/*
/*!
Initializes the controller with a window.
@param aWindow the window to control
@return the initialzed window controller
@@ -62,7 +63,7 @@ import "CPDocument.j"
return self;
}
/*
/*!
Initializes the controller with a Capppuccino Interface Builder name.
@param aWindowCibName the cib name of the window to control
@return the initialized window controller
@@ -72,7 +73,7 @@ import "CPDocument.j"
return [self initWithWindowCibName:aWindowCibName owner:self];
}
/*
/*!
Initializes the controller with a cafe name.
@param aWindowCibName the cib name of the window to control
@param anOwner the owner of the cib file
@@ -93,7 +94,7 @@ import "CPDocument.j"
return self;
}
/*
/*!
Loads the window
*/
- (void)loadWindow
@@ -105,7 +106,7 @@ import "CPDocument.j"
[self windowDidLoad];
}
/*
/*!
Shows the window.
@param aSender the object requesting the show
*/
@@ -119,7 +120,7 @@ import "CPDocument.j"
[theWindow makeKeyAndOrderFront:aSender];
}
/*
/*!
Returns <code>YES</code> if the window has been loaded. Specifically,
if <objj>loadWindow</objj> has been called.
*/
@@ -128,7 +129,7 @@ import "CPDocument.j"
return _window;
}
/*
/*!
Returns the window this object controls.
*/
- (CPWindow)window
@@ -139,7 +140,7 @@ import "CPDocument.j"
return _window;
}
/*
/*!
Sets the window to be controlled.
@param aWindow the new window to control
*/
@@ -151,7 +152,7 @@ import "CPDocument.j"
[_window setNextResponder:self];
}
/*
/*!
The method notifies the controller that it's window has loaded.
*/
- (void)windowDidLoad
@@ -161,7 +162,7 @@ import "CPDocument.j"
[self synchronizeWindowTitleWithDocumentName];
}
/*
/*!
The method notifies the controller that it's window is about to load.
*/
- (void)windowWillLoad
@@ -169,7 +170,7 @@ import "CPDocument.j"
[_document windowControllerWillLoadNib:self];
}
/*
/*!
Sets the document that is inside the controlled window.
@param aDocument the document in the controlled window
*/
@@ -238,7 +239,7 @@ import "CPDocument.j"
[[self window] setDocumentSaving:NO];
}
/*
/*!
Returns the document in the controlled window.
*/
- (CPDocument)document
@@ -246,7 +247,7 @@ import "CPDocument.j"
return _document;
}
/*
/*!
Sets whether the document has unsaved changes. The window can use this as a hint to
@param isEdited <code>YES</code> means the document has unsaved changes.
*/
@@ -257,7 +258,7 @@ import "CPDocument.j"
// Setting and Getting Window Attributes
/*
/*!
Sets the title of the window as the name of the document.
*/
- (void)synchronizeWindowTitleWithDocumentName
@@ -269,7 +270,7 @@ import "CPDocument.j"
[_window setTitle:[self windowTitleForDocumentDisplayName:[_document displayName]]];
}
/*
/*!
Returns the window title based on the document's name.
@param aDisplayName the document's filename
*/
AppKit/CoreAnimation/CAAnimation.j
+16 -16
View File
@@ -33,7 +33,7 @@ import "CAMediaTimingFunction.j"
BOOL _isRemovedOnCompletion;
}
/*
/*!
Creates a new <objj>CAAnimation</objj> instance
@return a new <objj>CAAnimation</objj> instance
*/
@@ -52,7 +52,7 @@ import "CAMediaTimingFunction.j"
return self;
}
/*
/*!
Returns <code>YES</code>
@return <code>YES</code>
*/
@@ -61,7 +61,7 @@ import "CAMediaTimingFunction.j"
return YES;
}
/*
/*!
Returns <code>nil</code>
@return <code>nil</code>
*/
@@ -70,7 +70,7 @@ import "CAMediaTimingFunction.j"
return nil;
}
/*
/*!
Specifies whether this animation should be removed after it has completed.
@param <code>YES</code> means the animation should be removed
*/
@@ -79,7 +79,7 @@ import "CAMediaTimingFunction.j"
_isRemovedOnCompletion = isRemovedOnCompletion;
}
/*
/*!
Returns <code>YES</code> if the animation is removed after completion
*/
- (BOOL)removedOnCompletion
@@ -87,7 +87,7 @@ import "CAMediaTimingFunction.j"
return _isRemovedOnCompletion;
}
/*
/*!
Returns <code>YES</code> if the animation is removed after completion
*/
- (BOOL)isRemovedOnCompletion
@@ -95,7 +95,7 @@ import "CAMediaTimingFunction.j"
return _isRemovedOnCompletion;
}
/*
/*!
Returns the animation's timing function. If <code>nil</code>, then it has a linear pacing.
*/
- (CAMediaTimingFunction)timingFunction
@@ -104,7 +104,7 @@ import "CAMediaTimingFunction.j"
return nil;
}
/*
/*!
Sets the animation delegate
@param aDelegate the new delegate
*/
@@ -113,7 +113,7 @@ import "CAMediaTimingFunction.j"
_delegate = aDelegate;
}
/*
/*!
Returns the animation's delegate
*/
- (id)delegate
@@ -190,7 +190,7 @@ import "CAMediaTimingFunction.j"
@end
/*
/*!
A <objj>CABasicAnimation</objj> is a simple animation that moves a
<objj>CALayer</objj> from one point to another over a specified
period of time.
@@ -202,7 +202,7 @@ import "CAMediaTimingFunction.j"
id _byValue;
}
/*
/*!
Sets the starting position for the animation.
@param aValue the animation starting position
*/
@@ -211,7 +211,7 @@ import "CAMediaTimingFunction.j"
_fromValue = aValue;
}
/*
/*!
Returns the animation's starting position.
*/
- (id)fromValue
@@ -219,7 +219,7 @@ import "CAMediaTimingFunction.j"
return _fromValue;
}
/*
/*!
Sets the ending position for the animation.
@param aValue the animation ending position
*/
@@ -228,7 +228,7 @@ import "CAMediaTimingFunction.j"
_toValue = aValue;
}
/*
/*!
Returns the animation's ending position.
*/
- (id)toValue
@@ -236,7 +236,7 @@ import "CAMediaTimingFunction.j"
return _toValue;
}
/*
/*!
Sets the optional byValue for animation interpolation.
@param aValue the byValue
*/
@@ -245,7 +245,7 @@ import "CAMediaTimingFunction.j"
_byValue = aValue;
}
/*
/*!
Returns the animation's byValue.
*/
- (id)byValue
AppKit/CoreAnimation/CALayer.j
+51 -50
View File
@@ -49,7 +49,8 @@ var CALayerFrameOriginUpdateMask = 1,
var CALayerRegisteredRunLoopUpdates = nil;
/*
/*! @class CALayer
A <objj>CALayer</objj> is similar to a <objj>CPView</objj>, but with the ability
to have a transform applied to it.
@@ -118,7 +119,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
CGAffineTransform _transformFromLayer;
}
/*
/*!
Returns a new animation layer.
*/
+ (CALayer)layer
@@ -126,7 +127,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return [[[self class] alloc] init];
}
/*
/*!
Initializes the animation layer.
*/
- (id)init
@@ -172,7 +173,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
}
// Modifying the Layer Geometry
/*
/*!
Sets the bounds (origin and size) of the rectangle.
@param aBounds the new bounds for the layer
*/
@@ -201,7 +202,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_CALayerRecalculateGeometry(self, CALayerGeometryBoundsMask);
}
/*
/*!
Returns the layer's bound.
*/
- (CGRect)bounds
@@ -209,7 +210,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _bounds;
}
/*
/*!
Sets the layer's position.
@param aPosition the layer's new position
*/
@@ -223,7 +224,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_CALayerRecalculateGeometry(self, CALayerGeometryPositionMask);
}
/*
/*!
Returns the layer's position
*/
- (CGPoint)position
@@ -231,7 +232,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _position;
}
/*
/*!
Sets the layer's z-ordering.
@param aZPosition the layer's new z-ordering
*/
@@ -245,7 +246,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
[self registerRunLoopUpdateWithMask:CALayerZPositionUpdateMask];
}
/*
/*!
Sets the layer's anchor point. The default point is [0.5, 0.5].
@param anAnchorPoint the layer's new anchor point
*/
@@ -269,7 +270,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_CALayerRecalculateGeometry(self, CALayerGeometryAnchorPointMask);
}
/*
/*!
Returns the layer's anchor point.
*/
- (CGPoint)anchorPoint
@@ -277,7 +278,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _anchorPoint;
}
/*
/*!
Sets the affine transform applied to this layer.
@param anAffineTransform the new affine transform
*/
@@ -291,7 +292,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_CALayerRecalculateGeometry(self, CALayerGeometryAffineTransformMask);
}
/*
/*!
Returns the layer's affine transform.
*/
- (CGAffineTransform)affineTransform
@@ -299,7 +300,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _affineTransform;
}
/*
/*!
Sets the affine transform that gets applied to all the sublayers.
@param anAffineTransform the transform to apply to sublayers
*/
@@ -325,7 +326,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
}
}
/*
/*!
Returns the affine transform applied to the sublayers.
*/
- (CGAffineTransform)sublayerTransform
@@ -342,7 +343,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _transformToLayer;
}
/*
/*!
Sets the frame of the layer. The frame defines a bounding
rectangle in the superlayer's coordinate system.
@param aFrame the new frame rectangle
@@ -352,7 +353,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
alert("FIXME IMPLEMENT");
}
/*
/*!
Returns the layer's frame.
The frame defines the bounding box of the layer: the smallest
@@ -367,7 +368,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _frame;
}
/*
/*!
The Backing Store Frame specifies the frame of the actual backing
store used to contain this layer. Naturally, by default it is the
same as the frame, however, users can specify their own custom
@@ -380,7 +381,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _backingStoreFrame;
}
/*
/*!
Sets the frame's backing store.
@param aFrame the new backing store.
*/
@@ -416,7 +417,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
}
// Providing Layer Content
/*
/*!
Returns the <objj>CGImage</objj> contents of this layer.
The default contents are <code>nil</code>.
*/
@@ -425,7 +426,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _contents;
}
/*
/*!
Sets the image contents of this layer.
@param contents the image to display
*/
@@ -479,7 +480,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
CGContextRestoreGState(_context);
}
/*
/*!
Displays the contents of this layer.
*/
- (void)display
@@ -526,7 +527,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
[self composite];
}
/*
/*!
Draws this layer's contents into the specified context.
@param aContext the context to draw the layer into
*/
@@ -544,7 +545,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
// Style Attributes
/*
/*!
Returns the opacity of the layer. The value is between
<code>0.0</code> (transparent) and <code>1.0</code> (opaque).
*/
@@ -553,7 +554,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _opacity;
}
/*
/*!
Sets the opacity for the layer.
@param anOpacity the new opacity (between <code>0.0</code> (transparent) and <code>1.0</code> (opaque)).
*/
@@ -568,7 +569,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_DOMElement.style.filter = "alpha(opacity=" + anOpacity * 100 + ")";
}
/*
/*!
Sets whether the layer is hidden.
@param isHidden <code>YES</code> means the layer will be hidden. <code>NO</code> means the layer will be visible.
*/
@@ -578,7 +579,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_DOMElement.style.display = isHidden ? "none" : "block";
}
/*
/*!
Returns <code>YES</code> if the layer is hidden.
*/
- (BOOL)hidden
@@ -586,7 +587,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _isHidden;
}
/*
/*!
Returns <code>YES</code> if the layer is hidden.
*/
- (BOOL)isHidden
@@ -594,7 +595,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _isHidden;
}
/*
/*!
Sets whether content that goes lies outside the bounds is hidden or visible.
@param masksToBounds <code>YES</code> hides the excess content. <code>NO</code> makes it visible.
*/
@@ -607,7 +608,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
_DOMElement.style.overflow = _masksToBounds ? "hidden" : "visible";
}
/*
/*!
Sets the layer's background color.
@param aColor the new background color
*/
@@ -618,7 +619,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
[self setNeedsDisplay];
}
/*
/*!
Returns the layer's background color.
*/
- (CPColor)backgroundColor
@@ -627,7 +628,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
}
// Managing Layer Hierarchy
/*
/*!
Returns an array of the receiver's sublayers.
*/
- (CPArray)sublayers
@@ -635,7 +636,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
return _sublayers;
}
/*
/*!
Returns the receiver's superlayer.
*/
- (CALayer)superlayer
@@ -647,7 +648,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)\
_DOMContentsElement.style.zIndex -= 100.0;\
/*
/*!
Adds the specified layer as a sublayer of the receiver.
*/
- (void)addSublayer:(CALayer)aLayer
@@ -660,7 +661,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
_DOMElement.appendChild(DOM(aLayer));
}
/*
/*!
Removes the receiver from its superlayer.
*/
- (void)removeFromSuperlayer
@@ -677,7 +678,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
_superlayer = nil;
}
/*
/*!
Inserts the specified layer as a sublayer into the specified index.
@param aLayer the layer to insert
@param anIndex the index to insert the layer at
@@ -719,7 +720,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
_CALayerRecalculateGeometry(aLayer, 0xFFFFFFF);
}
/*
/*!
Inserts a layer below another layer.
@param aLayer the layer to insert
@param aSublayer the layer to insert below
@@ -732,7 +733,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
[self insertSublayer:aLayer atIndex:index == CPNotFound ? _sublayers.length : index];
}
/*
/*!
Inserts a layer above another layer.
@param aLayer the layer to insert
@param aSublayer the layer to insert above
@@ -747,7 +748,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
[_sublayers insertObject:aLayer atIndex:index == CPNotFound ? _sublayers.length : index + 1];
}
/*
/*!
Replaces a sublayer.
@param aSublayer the layer to insert
@param aLayer the layer to replace
@@ -823,7 +824,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
[self registerRunLoopUpdateWithMask:CALayerCompositeUpdateMask];
}
/*
/*!
Marks the layer as needing to be redrawn.
*/
- (void)setNeedsDisplay
@@ -831,7 +832,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
[self registerRunLoopUpdateWithMask:CALayerDisplayUpdateMask];
}
/*
/*!
Sets whether the layer needs to be redrawn when its bounds are changed.
@param needsDisplayOnBoundsChange <code>YES</code> means the display is redraw on a bounds change.
*/
@@ -840,7 +841,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
_needsDisplayOnBoundsChange = needsDisplayOnBoundsChange;
}
/*
/*!
Returns <code>YES</code> if the display should be redrawn on a bounds change.
*/
- (BOOL)needsDisplayOnBoundsChange
@@ -848,7 +849,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
return _needsDisplayOnBoundsChange;
}
/*
/*!
Marks the specified rectange as needing to be redrawn.
@param aRect the area that needs to be redrawn.
*/
@@ -859,7 +860,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
}
// Mapping Between Coordinate and Time Spaces
/*
/*!
Converts the point from the specified layer's coordinate system into the receiver's coordinate system.
@param aPoint the point to convert
@param aLayer the layer coordinate system to convert from
@@ -870,7 +871,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
return CGPointApplyAffineTransform(aPoint, _CALayerGetTransform(aLayer, self));
}
/*
/*!
Converts the point from the receiver's coordinate system to the specified layer's coordinate system.
@param aPoint the point to convert
@param aLayer the layer coordinate system to convert to
@@ -881,7 +882,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
return CGPointApplyAffineTransform(aPoint, _CALayerGetTransform(self, aLayer));
}
/*
/*!
Converts the rectangle from the specified layer's coordinate system to the receiver's coordinate system.
@param aRect the rectangle to convert
@param aLayer the layer coordinate system to convert from
@@ -892,7 +893,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
return CGRectApplyAffineTransform(aRect, _CALayerGetTransform(aLayer, self));
}
/*
/*!
Converts the rectangle from the receier's coordinate system to the specified layer's coordinate system.
@param aRect the rectange to convert
@param aLayer the layer coordinate system to convert to
@@ -904,7 +905,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
}
// Hit Testing
/*
/*!
Returns <code>YES</code> if the layer contains the point.
@param aPoint the point to test
*/
@@ -913,7 +914,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
return _CGRectContainsPoint(_bounds, aPoint);
}
/*
/*!
Returns the farthest descendant of this layer that contains the specified point.
@param aPoint the point to test
@return the containing layer or <code>nil</code> if there was no hit.
@@ -941,7 +942,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
}
// Modifying the Delegate
/*
/*!
Sets the delegate for this layer.
@param aDelegate the delegate
*/
@@ -959,7 +960,7 @@ if (_DOMContentsElement && aLayer._zPosition > _DOMContentsElement.style.zIndex)
[self setNeedsDisplay];
}
/*
/*!
Returns the layer's delegate
*/
- (id)delegate
AppKit/CoreGraphics/CGAffineTransform.j
+5 -5
View File
@@ -55,7 +55,7 @@ function CGAffineTransformCreateCopy(aTransform)
return _CGAffineTransformMakeCopy(aTransform);
}
/*
/*!
Returns a transform that rotates a coordinate system.
@param anAngle the amount in radians for the transform
to rotate a coordinate system
@@ -71,7 +71,7 @@ function CGAffineTransformMakeRotation(anAngle)
return _CGAffineTransformMake(cos, sin, -sin, cos, 0.0, 0.0);
}
/*
/*!
Rotates a transform.
@param aTransform the transform to rotate
@param anAngle the amount to rotate in radians
@@ -93,7 +93,7 @@ function CGAffineTransformRotate(aTransform, anAngle)
};
}
/*
/*!
Inverts a transform.
@param aTransform the transform to invert
@return CGAffineTransform an inverted transform
@@ -113,7 +113,7 @@ function CGAffineTransformInvert(aTransform)
};
}
/*
/*!
Applies a transform to the rectangle's points. The transformed rectangle
will be the smallest box that contains the transformed points.
@param aRect the rectangle to transform
@@ -139,7 +139,7 @@ function CGRectApplyAffineTransform(aRect, anAffineTransform)
return _CGRectMake(minX, minY, (maxX - minX), (maxY - minY));
}
/*
/*!
Creates and returns a string representation of an affine transform.
@param anAffineTransform the transform to represent as a string
@return CPString a string describing the transform
AppKit/CoreGraphics/CGColor.j
+15 -15
View File
@@ -45,7 +45,7 @@ function CGColorGetConstantColor(aColorName)
alert("FIX ME");
}
/*
/*!
This function is for source compatability.
*/
function CGColorRetain(aColor)
@@ -53,14 +53,14 @@ function CGColorRetain(aColor)
return aColor;
}
/*
/*!
This function is for source compatability.
*/
function CGColorRelease()
{
}
/*
/*!
Creates a new <objj>CGColor</objj>.
@param aColorSpace the <objj>CGColorSpace</objj> of the color
@param components the color's intensity values plus alpha
@@ -84,7 +84,7 @@ function CGColorCreate(aColorSpace, components)
return _CGColorMap[UID] = { colorspace:aColorSpace, pattern:NULL, components:components };
}
/*
/*!
Creates a copy of a color... but not really. <objj>CGColor</objj>s
are immutable, so to be efficient, this function will just
return the same object that was passed in.
@@ -98,7 +98,7 @@ function CGColorCreateCopy(aColor)
return aColor;
}
/*
/*!
Creates a gray color object.
@param gray the value to use for the color intensities (<code>0.0-1.0</code>)
@param alpha the gray's alpha value (<code>0.0-1.0</code>)
@@ -110,7 +110,7 @@ function CGColorCreateGenericGray(gray, alpha)
return CGColorCreate(0, [gray, alpha]);
}
/*
/*!
Creates an RGB color.
@param red the red component (<code>0.0-1.0</code>)
@param green the green component (<code>0.0-1.0</code>)
@@ -124,7 +124,7 @@ function CGColorCreateGenericRGB(red, green, blue, alpha)
return CGColorCreate(0, [red, green, blue, alpha]);
}
/*
/*!
Creates a CMYK color.
@param cyan the cyan component (<code>0.0-1.0</code>)
@param magenta the magenta component (<code>0.0-1.0</code>)
@@ -139,7 +139,7 @@ function CGColorCreateGenericCMYK(cyan, magenta, yellow, black, alpha)
return CGColorCreate(0, [cyan, magenta, yellow, black, alpha]);
}
/*
/*!
Creates a copy of the color with a specified alpha.
@param aColor the color object to copy
@param anAlpha the new alpha component for the copy (<code>0.0-1.0</code>)
@@ -163,7 +163,7 @@ function CGColorCreateCopyWithAlpha(aColor, anAlpha)
return copy;
}
/*
/*!
Creates a color using the specified pattern.
@param aColorSpace the <objj>CGColorSpace</objj>
@param aPattern the pattern image
@@ -179,7 +179,7 @@ function CGColorCreateWithPattern(aColorSpace, aPattern, components)
return { colorspace:aColorSpace, pattern:aPattern, components:components.slice() };
}
/*
/*!
Determines if two colors are the same.
@param lhs the first <objj>CGColor</objj>
@param rhs the second <objj>CGColor</objj>
@@ -214,7 +214,7 @@ function CGColorEqualToColor(lhs, rhs)
return true;
}
/*
/*!
Returns the color's alpha component.
@param aColor the color
@return float the alpha component (<code>0.0-1.0</code>)
@@ -227,7 +227,7 @@ function CGColorGetAlpha(aColor)
return components[components.length - 1];
}
/*
/*!
Returns the <objj>CGColor</objj>'s color space.
@return <objj>CGColorSpace</objj>
@group CGColor
@@ -237,7 +237,7 @@ function CGColorGetColorSpace(aColor)
return aColor.colorspace;
}
/*
/*!
Returns the <objj>CGColor</objj>'s components
including the alpha in an array.
@param aColor the color
@@ -248,7 +248,7 @@ function CGColorGetComponents(aColor)
return aColor.components;
}
/*
/*!
Returns the number of color components
(including alpha) in the specified color.
@param aColor the <objj>CGColor</objj>
@@ -260,7 +260,7 @@ function CGColorGetNumberOfComponents(aColor)
return aColor.components.length;
}
/*
/*!
Gets the <objj>CGColor</objj>'s pattern.
@param a <objj>CGColor</objj>
@return CGPatternFIXME the pattern image
AppKit/CoreGraphics/CGContext.j
+12 -12
View File
@@ -182,7 +182,7 @@ kCGBlendModePlusDarker = 26;
*/
kCGBlendModePlusLighter = 27;
/*
/*!
This function is just here for source compatability.
It does nothing.
@group CGContext
@@ -191,7 +191,7 @@ function CGContextRelease()
{
}
/*
/*!
This function is just here for source compatability.
It does nothing.
@param aContext a CGContext
@@ -421,7 +421,7 @@ function CGContextSetShadowWithColor(aContext, aSize, aBlur, aColor)
} // END CANVAS IF
// GOOD.
/*
/*!
Fills in the area of the current path, using the even-odd fill rule.
@param aContext the CGContext of the path
@return void
@@ -432,7 +432,7 @@ function CGContextEOFillPath(aContext)
CGContextDrawPath(aContext, kCGPathEOFill);
}
/*
/*!
Fills in the area of the current path, using the non-zero winding number rule.
@param aContext the CGContext of the path
@return void
@@ -445,7 +445,7 @@ function CGContextFillPath(aContext)
var KAPPA = 4.0 * ((SQRT2 - 1.0) / 3.0);
/*
/*!
Draws the outline of an ellipse bounded by a rectangle.
@param aContext CGContext to draw on
@param aRect the rectangle bounding the ellipse
@@ -474,7 +474,7 @@ function CGContextAddEllipseInRect(aContext, aRect)
CGContextClosePath(aContext);
}
/*
/*!
Fills an ellipse bounded by a rectangle.
@param aContext CGContext to draw on
@param aRect the rectangle bounding the ellipse
@@ -487,7 +487,7 @@ function CGContextFillEllipseInRect(aContext, aRect)
CGContextFillPath(aContext);
}
/*
/*!
Strokes an ellipse bounded by the specified rectangle.
@param aContext CGContext to draw on
@param aRect the rectangle bounding the ellipse
@@ -500,7 +500,7 @@ function CGContextStrokeEllipseInRect(aContext, aRect)
CGContextStrokePath(aContext);
}
/*
/*!
Paints a line in the current path of the current context.
@param aContext CGContext to draw on
@return void
@@ -511,7 +511,7 @@ function CGContextStrokePath(aContext)
CGContextDrawPath(aContext, kCGPathStroke);
}
/*
/*!
Strokes multiple line segments.
@param aContext CGContext to draw on
@param points an array with an even number of points. The
@@ -543,7 +543,7 @@ function CGContextStrokeLineSegments(aContext, points, count)
//FIXME: THIS IS WRONG!!!
/*
/*!
Sets the current fill color.
@param aContext the CGContext
@param aColor the new color for the fill
@@ -557,7 +557,7 @@ function CGContextSetFillColor(aContext, aColor)
aContext.gState.fillStyle = [aColor cssString];
}
/*
/*!
Sets the current stroke color.
@param aContext the CGContext
@param aColor the new color for the stroke
@@ -570,7 +570,7 @@ function CGContextSetStrokeColor(aContext, aColor)
aContext.gState.strokeStyle = [aColor cssString];
}
/*
/*!
Fills a rounded rectangle.
@param aContext the CGContext to draw into
@param aRect the base rectangle
AppKit/CoreGraphics/CGGeometry.j
+4 -4
View File
@@ -65,7 +65,7 @@ _function(CGRectIsNull(aRect))
_function(CGRectContainsPoint(aRect, aPoint))
/*
/*!
Returns a <code>BOOL</code> indicating whether <objj>CGRect</objj> <code>lhsRect</code>
contains <objj>CGRect</objj> <code>rhsRect</code>.
@group CGRect
@@ -80,7 +80,7 @@ function CGRectContainsRect(lhsRect, rhsRect)
return _CGRectEqualToRect(union, lhsRect);
}
/*
/*!
Returns <code>YES</code> if the two rectangles intersect
@group CGRect
@param lhsRect the first <objj>CGRect</objj>
@@ -94,7 +94,7 @@ function CGRectIntersectsRect(lhsRect, rhsRect)
return !_CGRectIsEmpty(intersection);
}
/*
/*!
Makes the origin and size of a <objj>CGRect</objj> all integers. Specifically, by making
the southwest corner the origin (rounded down), and the northeast corner a <objj>CGSize</objj> (rounded up).
@param aRect the rectangle to operate on
@@ -118,7 +118,7 @@ function CGRectIntegral(aRect)
return aRect;
}
/*
/*!
Returns the intersection of the two provided rectangles as a new rectangle.
@param lhsRect the first rectangle used for calculation
@param rhsRect the second rectangle used for calculation
AppKit/Platform/DOM/CPDOMWindowBridge.j
+7 -7
View File
@@ -68,7 +68,7 @@ var ExcludedDOMElements = [];
CPString _overriddenEventType;
}
/*
/*!
Returns the shared DOMWindowBridge.
*/
+ (id)sharedDOMWindowBridge
@@ -375,7 +375,7 @@ var CTRL_KEY_CODE = 17;
@implementation CPDOMWindowBridge (Events)
/*
/*!
When using command (mac) or control (windows), keys are propagated to the browser by default.
To prevent a character key from propagating (to prevent its default action, and instead use it
in your own application), use these methods. These methods are additive -- the list builds until you clear it.
@@ -388,7 +388,7 @@ var CTRL_KEY_CODE = 17;
CharacterKeysToPrevent[""+characters[i-1].toLowerCase()] = YES;
}
/*
/*!
@param character a character to stop propagating keypresses to the browser.
*/
- (void)preventCharacterKeyFromPropagating:(CPString)character
@@ -396,7 +396,7 @@ var CTRL_KEY_CODE = 17;
CharacterKeysToPrevent[character.toLowerCase()] = YES;
}
/*
/*!
Clear the list of characters for which we are not sending keypresses to the browser.
*/
- (void)clearCharacterKeysToPreventFromPropagating
@@ -404,7 +404,7 @@ var CTRL_KEY_CODE = 17;
CharacterKeysToPrevent = {};
}
/*
/*!
Prevent these keyCodes from sending their keypresses to the browser.
@param keyCodes an array of keycodes to prevent propagation.
*/
@@ -414,7 +414,7 @@ var CTRL_KEY_CODE = 17;
KeyCodesToPrevent[keyCodes[i-1]] = YES;
}
/*
/*!
Prevent this keyCode from sending its key events to the browser.
@param keyCode a keycode to prevent propagation.
*/
@@ -423,7 +423,7 @@ var CTRL_KEY_CODE = 17;
KeyCodesToPrevent[keyCode] = YES;
}
/*
/*!
Clear the list of keyCodes for which we are not sending keypresses to the browser.
*/
- (void)clearKeyCodesToPreventFromPropagating
Foundation/CPArray.j
+89 -89
View File
@@ -86,55 +86,55 @@ import "CPException.j"
@end
/*
/*! @class CPArray
A mutable array class backed by a JavaScript Array.
There is also a <objj>CPMutableArray</objj> class,
There is also a CPMutableArray class,
but it is just a child class of this class with an
empty implementation. All mutable functionality is
implemented directly in <objj>CPArray</objj>.
implemented directly in CPArray.
*/
@implementation CPArray : CPObject
/*
Returns a new uninitialized <objj>CPArray</objj>.
/*!
Returns a new uninitialized CPArray.
*/
+ (id)alloc
{
return [];
}
/*
Returns a new initialized <objj>CPArray</objj>.
/*!
Returns a new initialized CPArray.
*/
+ (id)array
{
return [[self alloc] init];
}
/*
/*!
Creates a new array containing the objects in <code>anArray</code>.
@param anArray Objects in this array will be added to the new array
@return a new <objj>CPArray</objj> of the provided objects
@return a new CPArray of the provided objects
*/
+ (id)arrayWithArray:(CPArray)anArray
{
return [[self alloc] initWithArray:anArray];
}
/*
/*!
Creates a new array with <code>anObject</code> in it.
@param anObject the object to be added to the array
@return a new <objj>CPArray</objj> containing a single object
@return a new CPArray containing a single object
*/
+ (id)arrayWithObject:(id)anObject
{
return [[self alloc] initWithObjects:anObject];
}
/*
Creates a new <objj>CPArray</objj> containing all the objects passed as arguments to the method.
/*!
Creates a new CPArray containing all the objects passed as arguments to the method.
@param anObject the objects that will be added to the new array
@return a new <objj>CPArray</objj> containing the argument objects
@return a new CPArray containing the argument objects
*/
+ (id)arrayWithObjects:(id)anObject, ...
{
@@ -148,19 +148,19 @@ import "CPException.j"
return array;
}
/*
Creates a <objj>CPArray</objj> from a JavaScript array of objects.
/*!
Creates a CPArray from a JavaScript array of objects.
@param objects the JavaScript Array
@param aCount the number of objects in the JS Array
@return a new <objj>CPArray</objj> containing the specified objects
@return a new CPArray containing the specified objects
*/
+ (id)arrayWithObjects:(id)objects count:(unsigned)aCount
{
return [[self alloc] initWithObjects:objects count:aCount];
}
/*
Initializes the <objj>CPArray</objj>.
/*!
Initializes the CPArray.
@return the initialized array
*/
- (id)init
@@ -169,10 +169,10 @@ import "CPException.j"
}
// Creating an Array
/*
Creates a new <objj>CPArray</objj> from <code>anArray</code>.
/*!
Creates a new CPArray from <code>anArray</code>.
@param anArray objects in this array will be added to the new array
@return a new <objj>CPArray</objj> containing the objects of <code>anArray</code>
@return a new CPArray containing the objects of <code>anArray</code>
*/
- (id)initWithArray:(CPArray)anArray
{
@@ -184,7 +184,7 @@ import "CPException.j"
return self;
}
/*
/*!
Initializes a the array with the contents of <code>anArray</code>
and optionally performs a deep copy of the objects based on <code>copyItems</code>.
@param anArray the array to copy the data from
@@ -217,10 +217,10 @@ import "CPException.j"
return self;
}
/*
initializes
/*!
initializes an array with the contents of anArray
*/
- (id)initWithObjects:(Array)anObject, ...
- (id)initWithObjects:(Array)anArray, ...
{
// The arguments array contains self and _cmd, so the first object is at position 2.
var i = 2,
@@ -232,11 +232,11 @@ import "CPException.j"
return self;
}
/*
/*!
Initializes the array with a JavaScript array of objects.
@param objects the array of objects to add to the receiver
@param aCount the number of objects in <code>objects</code>
@return the initialized <objj>CPArray</objj>
@return the initialized CPArray
*/
- (id)initWithObjects:(id)objects count:(unsigned)aCount
{
@@ -253,8 +253,8 @@ import "CPException.j"
return self;
}
/*
Returns a hash of the <objj>CPArray</objj>.
/*!
Returns a hash of the CPArray.
@return an unsigned integer hash
*/
- (unsigned)hash
@@ -266,7 +266,7 @@ import "CPException.j"
}
// Querying an array
/*
/*!
Returns <code>YES</code> if the array contains <code>anObject</code>. Otherwise, it returns <code>NO</code>.
@param anObject the method checks if this object is already in the array
*/
@@ -275,7 +275,7 @@ import "CPException.j"
return [self indexOfObject:anObject] != CPNotFound;
}
/*
/*!
Returns the number of elements in the array
*/
- (int)count
@@ -283,7 +283,7 @@ import "CPException.j"
return length;
}
/*
/*!
Returns the index of <code>anObject</code> in this array.
If the object is <code>nil</code> or not in the array,
returns <code>CPNotFound</code>. It first attempts to find
@@ -318,7 +318,7 @@ import "CPException.j"
return CPNotFound;
}
/*
/*!
Returns the index of <code>anObject</code> in the array
within <code>aRange</code>. It first attempts to find
a match using <code>isEqual:</code>, then <code>==</code>.
@@ -350,7 +350,7 @@ import "CPException.j"
return CPNotFound;
}
/*
/*!
Returns the index of <code>anObject</code> in the array. The test for equality is done using only <code>==</code>.
@param anObject the object to search for
@return the index of the object in the array. <code>CPNotFound</code> if the object is not in the array.
@@ -379,7 +379,7 @@ import "CPException.j"
return CPNotFound;
}
/*
/*!
Returns the index of <code>anObject</code> in the array
within <code>aRange</code>. The test for equality is
done using only <code>==</code>.
@@ -416,7 +416,7 @@ import "CPException.j"
return CPNotFound;
}
/*
/*!
Returns the last object in the array. If the array is empty, returns <code>nil</code>/
*/
- (id)lastObject
@@ -428,7 +428,7 @@ import "CPException.j"
return self[count - 1];
}
/*
/*!
Returns the object at index <code>anIndex</code>.
@throws CPRangeException if <code>anIndex</code> is out of bounds
*/
@@ -437,8 +437,8 @@ import "CPException.j"
return self[anIndex];
}
/*
Returns the objects at <code>indexes</code> in a new <objj>CPArray</objj>.
/*!
Returns the objects at <code>indexes</code> in a new CPArray.
@param indexes the set of indices
@throws CPRangeException if any of the indices is greater than or equal to the length of the array
*/
@@ -456,7 +456,7 @@ import "CPException.j"
return objects;
}
/*
/*!
Returns an enumerator describing the array sequentially
from the first to the last element. You should not modify
the array during enumeration.
@@ -466,7 +466,7 @@ import "CPException.j"
return [[_CPArrayEnumerator alloc] initWithArray:self];
}
/*
/*!
Returns an enumerator describing the array sequentially
from the last to the first element. You should not modify
the array during enumeration.
@@ -477,7 +477,7 @@ import "CPException.j"
}
// Sending messages to elements
/*
/*!
Sends each element in the array a message.
@param aSelector the selector of the message to send
@throws CPInvalidArgumentException if <code>aSelector</code> is <code>nil</code>
@@ -494,7 +494,7 @@ import "CPException.j"
objj_msgSend(self[index], aSelector);
}
/*
/*!
Sends each element in the array a message with an argument.
@param aSelector the selector of the message to send
@param anObject the first argument of the message
@@ -513,7 +513,7 @@ import "CPException.j"
}
// Comparing arrays
/*
/*!
Returns the first object found in the receiver (starting at index 0) which is present in the
<code>otherArray</code> as determined by using the <code>-containsObject:</code> method.
@return the first object found, or <code>nil</code> if no common object was found.
@@ -533,7 +533,7 @@ import "CPException.j"
return nil;
}
/*
/*!
Returns true if anArray contains exactly the same objects as the reciever.
*/
- (BOOL)isEqualToArray:(id)anArray
@@ -552,7 +552,7 @@ import "CPException.j"
}
// Deriving new arrays
/*
/*!
Returns a copy of this array plus <code>anObject</code> inside the copy.
@param anObject the object to be added to the array copy
@throws CPInvalidArgumentException if <code>anObject</code> is <code>nil</code>
@@ -571,7 +571,7 @@ import "CPException.j"
return array;
}
/*
/*!
Returns a new array which is the concatenation of <code>self</code> and otherArray (in this precise order).
@param anArray the array that will be concatenated to the receiver's copy
*/
@@ -595,7 +595,7 @@ import "CPException.j"
}
*/
/*
/*!
Returns a subarray of the receiver containing the objects found in the specified range <code>aRange</code>.
@param aRange the range of objects to be copied into the subarray
@throws CPRangeException if the specified range exceeds the bounds of the array
@@ -621,7 +621,7 @@ import "CPException.j"
return sorted;
}
/*
/*!
Returns an array in which the objects are ordered according
to a sort with <code>aFunction</code>. This invokes
<code>-sortUsingFunction:context</code>.
@@ -638,7 +638,7 @@ import "CPException.j"
return sorted;
}
/*
/*!
Returns a new array in which the objects are ordered according to a sort with <code>aSelector</code>.
@param aSelector the selector that will perform object comparisons
*/
@@ -653,7 +653,7 @@ import "CPException.j"
// Working with string elements
/*
/*!
Returns a string formed by concatenating the objects in the
receiver, with the specified separator string inserted between each part.
If the element is a Objective-J object, then the <code>description</code>
@@ -670,7 +670,7 @@ import "CPException.j"
// Creating a description of the array
/*
/*!
Returns a human readable description of this array and it's elements.
*/
- (CPString)description
@@ -691,11 +691,11 @@ import "CPException.j"
}
// Collecting paths
/*
/*!
Returns a new array subset formed by selecting the elements that have
filename extensions from <code>filterTypes</code>. Only elements
that are of type <objj>CPString</objj> are candidates for inclusion in the returned array.
@param filterTypes an array of <objj>CPString</objj> objects that contain file extensions (without the '.')
that are of type CPString are candidates for inclusion in the returned array.
@param filterTypes an array of CPString objects that contain file extensions (without the '.')
@return a new array with matching paths
*/
- (CPArray)pathsMatchingExtensions:(CPArray)filterTypes
@@ -712,7 +712,7 @@ import "CPException.j"
}
// Key value coding
/*
/*!
Sets the key-value for each element in the array.
@param aValue the value for the coding
@param aKey the key for the coding
@@ -726,7 +726,7 @@ import "CPException.j"
[self[i] setValue:aValue forKey:aKey];
}
/*
/*!
Returns the value for <code>aKey</code> from each element in the array.
@param aKey the key to return the value for
@return an array of containing a value for each element in the array
@@ -745,9 +745,9 @@ import "CPException.j"
// Copying arrays
/*
/*!
Makes a copy of the receiver.
@return a new <objj>CPArray</objj> copy
@return a new CPArray copy
*/
- (id)copy
{
@@ -759,9 +759,9 @@ import "CPException.j"
@implementation CPArray(CPMutableArray)
// Creating arrays
/*
/*!
Creates an array able to store at least <code>aCapacity</code>
items. Because <objj>CPArray</objj> is backed by JavaScript arrays,
items. Because CPArray is backed by JavaScript arrays,
this method ends up simply returning a regular array.
*/
+ (CPArray)arrayWithCapacity:(unsigned)aCapacity
@@ -769,8 +769,8 @@ import "CPException.j"
return [[self alloc] initWithCapacity:aCapacity];
}
/*
Initializes an array able to store at least <code>aCapacity</code> items. Because <objj>CPArray</objj>
/*!
Initializes an array able to store at least <code>aCapacity</code> items. Because CPArray
is backed by JavaScript arrays, this method ends up simply returning a regular array.
*/
- (id)initWithCapacity:(unsigned)aCapacity
@@ -779,7 +779,7 @@ import "CPException.j"
}
// Adding and replacing objects
/*
/*!
Adds <code>anObject</code> to the end of the array.
@param anObject the object to add to the array
*/
@@ -788,7 +788,7 @@ import "CPException.j"
push(anObject);
}
/*
/*!
Adds the objects in <code>anArray</code> to the receiver array.
@param anArray the array of objects to add to the end of the receiver
*/
@@ -797,7 +797,7 @@ import "CPException.j"
splice.apply(self, [length, 0].concat(anArray));
}
/*
/*!
Inserts an object into the receiver at the specified location.
@param anObject the object to insert into the array
@param anIndex the location to insert <code>anObject</code> at
@@ -807,7 +807,7 @@ import "CPException.j"
splice(anIndex, 0, anObject);
}
/*
/*!
Inserts the objects in the provided array into the receiver at the indexes specified.
@param objects the objects to add to this array
@param anIndexSet the indices for the objects
@@ -821,7 +821,7 @@ import "CPException.j"
[self insertObject:objects[index++] atindex:position];
}
/*
/*!
Replaces the element at <code>anIndex</code> with <code>anObject</code>.
The current element at position <code>anIndex</code> will be removed from the array.
@param anIndex the position in the array to place <code>anObject</code>
@@ -831,7 +831,7 @@ import "CPException.j"
self[anIndex] = anObject;
}
/*
/*!
Replace the elements at the indices specified by <code>anIndexSet</code> with
the objects in <code>objects</code>.
@param anIndexSet the set of indices to array positions that will be replaced
@@ -849,7 +849,7 @@ import "CPException.j"
}
}
/*
/*!
Replaces some of the receiver's objects with objects from <code>anArray</code>. Specifically, the elements of the
receiver in the range specified by <code>aRange</code>,
with the elements of <code>anArray</code> in the range specified by <code>otherRange</code>.
@@ -865,7 +865,7 @@ import "CPException.j"
splice.apply(self, [aRange.location, aRange.length].concat([anArray subarrayWithRange:otherRange]));
}
/*
/*!
Replaces some of the receiver's objects with the objects from
<code>anArray</code>. Specifically, the elements of the
receiver in the range specified by <code>aRange</code>.
@@ -877,7 +877,7 @@ import "CPException.j"
splice.apply(self, [aRange.location, aRange.length].concat(anArray));
}
/*
/*!
Sets the contents of the receiver to be identical to the contents of <code>anArray</code>.
@param anArray the array of objects used to replace the receiver's objects
*/
@@ -889,7 +889,7 @@ import "CPException.j"
}
// Removing Objects
/*
/*!
Removes all objects from this array.
*/
- (void)removeAllObjects
@@ -897,7 +897,7 @@ import "CPException.j"
splice(0, length);
}
/*
/*!
Removes the last object from the array.
*/
- (void)removeLastObject
@@ -905,7 +905,7 @@ import "CPException.j"
pop();
}
/*
/*!
Removes all entries of <code>anObject</code> from the array.
@param anObject the object whose entries are to be removed
*/
@@ -914,7 +914,7 @@ import "CPException.j"
[self removeObject:anObject inRange:CPMakeRange(0, length)];
}
/*
/*!
Removes all entries of <code>anObject</code> from the array, in the range specified by <code>aRange</code>.
@param anObject the object to remove
@param aRange the range to search in the receiver for the object
@@ -930,7 +930,7 @@ import "CPException.j"
}
}
/*
/*!
Removes the object at <code>anIndex</code>.
@param anIndex the location of the element to be removed
*/
@@ -939,7 +939,7 @@ import "CPException.j"
splice(anIndex, 1);
}
/*
/*!
Removes the objects at the indices specified by <code>CPIndexSet</code>.
@param anIndexSet the indices of the elements to be removed from the array
*/
@@ -954,7 +954,7 @@ import "CPException.j"
}
}
/*
/*!
Remove the first instance of <code>anObject</code> from the array.
The search for the object is done using <code>==</code>.
@param anObject the object to remove
@@ -964,7 +964,7 @@ import "CPException.j"
[self removeObjectIdenticalTo:anObject inRange:CPMakeRange(0, length)];
}
/*
/*!
Remove the first instance of <code>anObject</code> from the array,
within the range specified by <code>aRange</code>.
The search for the object is done using <code>==</code>.
@@ -982,7 +982,7 @@ import "CPException.j"
}
}
/*
/*!
Remove the objects in <code>anArray</code> from the receiver array.
@param anArray the array of objects to remove from the receiver
*/
@@ -995,7 +995,7 @@ import "CPException.j"
[self removeObject:anArray[index]];
}
/*
/*!
Removes all the objects in the specified range from the receiver.
@param aRange the range of objects to remove
*/
@@ -1005,7 +1005,7 @@ import "CPException.j"
}
// Rearranging objects
/*
/*!
Swaps the elements at the two specified indices.
@param anIndex the first index to swap from
@param otherIndex the second index to swap from
@@ -1033,7 +1033,7 @@ import "CPException.j"
});
}
/*
/*!
Sorts the receiver array using a JavaScript function as a comparator, and a specified context.
@param aFunction a JavaScript function that will be called to compare objects
@param aContext an object that will be passed to <code>aFunction</code> with comparison
@@ -1043,7 +1043,7 @@ import "CPException.j"
sort(function(lhs, rhs) { return aFunction(lhs, rhs, aContext); });
}
/*
/*!
Sorts the receiver array using an Objective-J method as a comparator.
@param aSelector the selector for the method to call for comparison
*/
@@ -1068,9 +1068,9 @@ import "CPException.j"
@end
/*
This class is just an empty subclass of <objj>CPArray</objj>.
<objj>CPArray</objj> already implements mutable methods and
/*!
This class is just an empty subclass of CPArray.
CPArray already implements mutable methods and
this class only exists for source compatability.
*/
@implementation CPMutableArray : CPArray
Foundation/CPCoder.j
+13 -13
View File
@@ -23,7 +23,7 @@
import "CPObject.j"
import "CPException.j"
/*
/*! @class CPCoder
Top-level class defining methods for use when archiving (encoding) objects to a byte array
or file, and when restoring (decoding) objects.
*/
@@ -32,7 +32,7 @@ import "CPException.j"
}
/*
/*!
Returns a flag indicating whether the receiver supports keyed coding. The default implementation returns
<code>NO</code>. Subclasses supporting keyed coding must override this to return <code>YES</code>.
*/
@@ -41,7 +41,7 @@ import "CPException.j"
return NO;
}
/*
/*!
Encodes a structure or object of a specified type. Usually this
is used for primitives though it can be used for objects as well.
Subclasses must override this method.
@@ -53,7 +53,7 @@ import "CPException.j"
CPInvalidAbstractInvocation();
}
/*
/*!
Encodes a data object. Subclasses must override this method.
@param aData the object to be encoded.
*/
@@ -62,7 +62,7 @@ import "CPException.j"
CPInvalidAbstractInvocation();
}
/*
/*!
Encodes an object. Subclasses must override this method.
@param anObject the object to be encoded
*/
@@ -71,7 +71,7 @@ import "CPException.j"
// [self encodeValueOfObjCType:@encode(id) at:object];
}
/*
/*!
Encodes a point
@param aPoint the point to be encoded.
*/
@@ -81,7 +81,7 @@ import "CPException.j"
[self encodeNumber:aPoint.y];
}
/*
/*!
Encodes a CGRect
@param aRect the rectangle to be encoded.
*/
@@ -91,7 +91,7 @@ import "CPException.j"
[self encodeSize:aRect.size];
}
/*
/*!
Encodes a CGSize
@param aSize the size to be encoded
*/
@@ -101,7 +101,7 @@ import "CPException.j"
[self encodeNumber:aSize.height];
}
/*
/*!
Encodes a property list. Not yet implemented.
@param aPropertyList the property list to be encoded
*/
@@ -110,7 +110,7 @@ import "CPException.j"
// [self encodeValueOfObjCType:@encode(id) at:&propertyList];
}
/*
/*!
Encodes the root object of a group of Obj-J objects.
@param rootObject the root object to be encoded.
*/
@@ -119,7 +119,7 @@ import "CPException.j"
[self encodeObject:anObject];
}
/*
/*!
Encodes an object.
@param anObject the object to be encoded.
*/
@@ -128,7 +128,7 @@ import "CPException.j"
[self encodeObject:object];
}
/*
/*!
Encodes an object.
@param anObject the object to be encoded.
*/
@@ -141,7 +141,7 @@ import "CPException.j"
@implementation CPObject (CPCoding)
/*
/*!
Called after an object is unarchived in case a different object should be used in place of it.
The defaut method returns <code>self</code>. Interested subclasses should override this.
@param aDecoder
Foundation/CPDictionary.j
+24 -24
View File
@@ -57,15 +57,15 @@ import "CPException.j"
@end
/*
/*! @class CPDictionary
A dictionary is the standard way of passing around key-value pairs in
the Cappuccino framework. It is similar to the
<a href="http://java.sun.com/javase/6/docs/api/index.html">Java map interface</a>,
except all keys are <objj>CPString</objj>s and values can be any
except all keys are CPStrings and values can be any
Cappuccino or JavaScript object.</p>
<p>If you are familiar with dictionaries in Cocoa, you'll notice that
there is no CPMutableDictionary class. The regular <objj>CPDictionary</objj>
there is no CPMutableDictionary class. The regular CPDictionary
has <code>setObject:</code> and <code>removeObjectForKey:</code> methods.
In Cappuccino there is no distinction between immutable and mutable classes.
They are all mutable.
@@ -82,48 +82,48 @@ import "CPException.j"
return new objj_dictionary();
}
/*
Returns a new empty <objj>CPDictionary</objj>.
/*!
Returns a new empty CPDictionary.
*/
+ (id)dictionary
{
return [[self alloc] init];
}
/*
/*!
Returns a new dictionary, initialized with the contents of <code>aDictionary</code>.
@param aDictionary the dictionary to copy key-value pairs from
@return the new <objj>CPDictionary</objj>
@return the new CPDictionary
*/
+ (id)dictionaryWithDictionary:(CPDictionary)aDictionary
{
return [[self alloc] initWithDictionary:aDictionary];
}
/*
/*!
Creates a new dictionary with single key-value pair.
@param anObject the object for the paring
@param aKey the key for the pairing
@return the new <objj>CPDictionary</objj>
@return the new CPDictionary
*/
+ (id)dictionaryWithObject:(id)anObject forKey:(id)aKey
{
return [[self alloc] initWithObjects:[anObject] forKeys:[aKey]];
}
/*
/*!
Creates a dictionary with multiple key-value pairs.
@param objects the objects to place in the dictionary
@param keys the keys for each of the objects
@throws CPInvalidArgumentException if the number of objects and keys is different
@return the new <objj>CPDictionary</objj>
@return the new CPDictionary
*/
+ (id)dictionaryWithObjects:(CPArray)objects forKeys:(CPArray)keys
{
return [[self alloc] initWithObjects:objects forKeys:keys];
}
/*
/*!
Initializes the dictionary with the contents of another dictionary.
@param aDictionary the dictionary to copy key-value pairs from
@return the initialized dictionary
@@ -139,7 +139,7 @@ import "CPException.j"
return dictionary;
}
/*
/*!
Initializes the dictionary from the arrays of keys and objects.
@param objects the objects to put in the dictionary
@param keyArray the keys for the objects to put in the dictionary
@@ -164,7 +164,7 @@ import "CPException.j"
return self;
}
/*
/*!
Returns the number of entries in the dictionary
*/
- (int)count
@@ -172,7 +172,7 @@ import "CPException.j"
return count;
}
/*
/*!
Returns an array of keys for all the entries in the dictionary.
*/
- (CPArray)allKeys
@@ -180,7 +180,7 @@ import "CPException.j"
return _keys;
}
/*
/*!
Returns an array of values for all the entries in the dictionary.
*/
- (CPArray)allValues
@@ -194,7 +194,7 @@ import "CPException.j"
return values;
}
/*
/*!
Returns an enumerator that enumerates over all the dictionary's keys.
*/
- (CPEnumerator)keyEnumerator
@@ -202,7 +202,7 @@ import "CPException.j"
return [_keys objectEnumerator];
}
/*
/*!
Returns an enumerator that enumerates over all the dictionary's values.
*/
- (CPEnumerator)objectEnumerator
@@ -263,7 +263,7 @@ import "CPException.j"
return this._objects.objectEnumerator();
}
*/
/*
/*!
Returns the object for the entry with key <code>aKey</code>.
@param aKey the key for the object's entry
@return the object for the entry
@@ -306,7 +306,7 @@ import "CPException.j"
while(key= keyEnumerator.nextObject()) this.setObjectForKey(aDictionary.objectForKey(key), key);
}
*/
/*
/*!
Removes all the entries from the dictionary.
*/
- (void)removeAllObjects
@@ -316,7 +316,7 @@ import "CPException.j"
_buckets = {};
}
/*
/*!
Removes the entry for the specified key.
@param aKey the key of the entry to be removed
*/
@@ -351,7 +351,7 @@ import "CPException.j"
while(i--) this._dictionary[this._keys[i]]= { object: this._objects[i], index: i };
}
*/
/*
/*!
Adds an entry into the dictionary.
@param anObject the object for the entry
@param aKey the entry's key
@@ -373,7 +373,7 @@ import "CPException.j"
}
*/
/*
/*!
Returns a human readable description of the dictionary.
*/
- (CPString)description
@@ -404,7 +404,7 @@ import "CPException.j"
return [aCoder _decodeDictionaryOfObjectsForKey:@"CP.objects"];
}
/*
/*!
Archives the dictionary to a provided coder.
@param aCoder the coder to which the dictionary data will be archived.
*/
Foundation/CPEnumerator.j
+4 -4
View File
@@ -22,15 +22,15 @@
import "CPObject.j"
/*
<objj>CPEnumerator</objj> is a superclass (with useless method bodies)
/*! @class CPEnumerator
CPEnumerator is a superclass (with useless method bodies)
that defines an interface for subclasses to follow. The purpose of an
enumerator is to be a convenient system for traversing over the elements
of a collection of objects.
*/
@implementation CPEnumerator : CPObject
/*
/*!
Returns the next object in the collection.
No particular ordering is guaranteed.
*/
@@ -39,7 +39,7 @@ import "CPObject.j"
return nil;
}
/*
/*!
Returns all objects in the collection in an array.
No particular ordering is guaranteed.
*/
Foundation/CPException.j
+11 -11
View File
@@ -30,7 +30,7 @@ CPUnsupportedMethodException = "CPUnsupportedMethodException";
CPRangeException = "CPRangeException";
CPInternalInconsistencyException = "CPInternalInconsistencyException";
/*
/*! @class CPException
An example of throwing an exception in Objective-J:
<pre>
// some code here...
@@ -52,7 +52,7 @@ if (input == nil)
return new objj_exception();
}
/*
/*!
Raises an exception with a name and reason.
@param aName the name of the exception to raise
@param aReason the reason for the exception
@@ -62,7 +62,7 @@ if (input == nil)
[[self exceptionWithName:aName reason:aReason userInfo:nil] raise];
}
/*
/*!
Creates an exception with a name, reason and user info.
@param aName the name of the exception
@param aReason the reason the exception occurred
@@ -74,7 +74,7 @@ if (input == nil)
return [[self alloc] initWithName:aName reason:aReason userInfo:aUserInfo];
}
/*
/*!
Initializes the exception.
@param aName the name of the exception
@param aReason the reason for the exception
@@ -95,7 +95,7 @@ if (input == nil)
return self;
}
/*
/*!
Returns the name of the exception.
*/
- (CPString)name
@@ -103,7 +103,7 @@ if (input == nil)
return name;
}
/*
/*!
Returns the reason for the exception.
*/
- (CPString)reason
@@ -111,7 +111,7 @@ if (input == nil)
return reason;
}
/*
/*!
Returns data containing info about the receiver.
*/
- (CPDictionary)userInfo
@@ -119,7 +119,7 @@ if (input == nil)
return userInfo;
}
/*
/*!
Returns the exception's reason.
*/
- (CPString)description
@@ -127,7 +127,7 @@ if (input == nil)
return reason;
}
/*
/*!
Raises the exception and causes the program to go to the exception handler.
*/
- (void)raise
@@ -148,7 +148,7 @@ if (input == nil)
@implementation CPException (CPCoding)
/*
/*!
Initializes the exception with data from a coder.
@param aCoder the coder from which to read the exception data
@return the initialized exception
@@ -167,7 +167,7 @@ if (input == nil)
return self;
}
/*
/*!
Encodes the exception's data into a coder.
@param aCoder the coder to which the data will be written
*/
Foundation/CPIndexSet.j
+39 -39
View File
@@ -23,7 +23,7 @@
import "CPRange.j"
import "CPObject.j"
/*
/*! @class CPIndexSet
Instances of this class are collections of numbers. Each integer can appear in a collection only once.
*/
@implementation CPIndexSet : CPObject
@@ -34,7 +34,7 @@ import "CPObject.j"
}
// Creating an Index Set
/*
/*!
Returns a new empty index set.
*/
+ (id)indexSet
@@ -42,7 +42,7 @@ import "CPObject.j"
return [[self alloc] init];
}
/*
/*!
Returns a new index set with just one index.
*/
+ (id)indexSetWithIndex:(int)anIndex
@@ -50,7 +50,7 @@ import "CPObject.j"
return [[self alloc] initWithIndex:anIndex];
}
/*
/*!
Returns a new index set with all the numbers in the specified range.
@param aRange the range of numbers to add to the index set.
*/
@@ -75,7 +75,7 @@ import "CPObject.j"
return self;
}
/*
/*!
Initializes the index set with a single index.
@return the initialized index set
*/
@@ -93,7 +93,7 @@ import "CPObject.j"
return self;
}
/*
/*!
Initializes the index set with numbers from the specified range.
@param aRange the range of numbers to add to the index set
@return the initialized index set
@@ -112,7 +112,7 @@ import "CPObject.j"
return self;
}
/*
/*!
Initializes the index set with another index set.
@param anIndexSet the index set from which to read the initial index set
@return the initialized index set
@@ -138,7 +138,7 @@ import "CPObject.j"
}
// Querying an Index Set
/*
/*!
Compares the receiver with the provided index set.
@param anIndexSet the index set to compare to
@return <code>YES</code> if the receiver and the index set are functionally equivalent
@@ -165,7 +165,7 @@ import "CPObject.j"
return YES;
}
/*
/*!
Returns <code>YES</code> if the index set contains the specified index.
@param anIndex the index to check for in the set
@return <code>YES</code> if <code>anIndex</code> is in the receiver index set
@@ -175,7 +175,7 @@ import "CPObject.j"
return [self containsIndexesInRange:CPMakeRange(anIndex, 1)];
}
/*
/*!
Returns <code>YES</code> if the index set contains all the numbers in the specified range.
@param aRange the range of numbers to check for in the index set
*/
@@ -206,7 +206,7 @@ import "CPObject.j"
return NO;
}
/*
/*!
Returns <code>YES</code> if the receving index set contains all the indices in the argument.
@param anIndexSet the set of indices to check for in the receiving index set
*/
@@ -231,7 +231,7 @@ import "CPObject.j"
return YES;
}
/*
/*!
Checks if the receiver contains at least one number in <code>aRange</code>.
@param aRange the range of numbers to check.
@return <code>YES</code> if the receiving index set contains at least one number in the provided range
@@ -255,7 +255,7 @@ import "CPObject.j"
return NO;
}
/*
/*!
The number of indices in the set
*/
- (int)count
@@ -264,7 +264,7 @@ import "CPObject.j"
}
// Accessing Indexes
/*
/*!
Return the first index in the set
*/
- (int)firstIndex
@@ -272,7 +272,7 @@ import "CPObject.j"
return _count ? _ranges[0].location : CPNotFound;
}
/*
/*!
Returns the last index in the set
*/
- (int)lastIndex
@@ -280,9 +280,9 @@ import "CPObject.j"
return _count ? CPMaxRange(_ranges[_ranges.length - 1]) - 1 : CPNotFound;
}
/*
/*!
Returns the first index value in the receiver which is greater than <code>anIndex</code>.
@return the closest index or <objj>CPNotFound</objj> if no match was found
@return the closest index or CPNotFound if no match was found
*/
- (unsigned)indexGreaterThanIndex:(unsigned)anIndex
{
@@ -305,9 +305,9 @@ import "CPObject.j"
return anIndex;
}
/*
/*!
Returns the first index value in the receiver which is less than <code>anIndex</code>.
@return the closest index or <objj>CPNotFound</objj> if no match was found
@return the closest index or CPNotFound if no match was found
*/
- (unsigned)indexLessThanIndex:(unsigned)anIndex
{
@@ -332,25 +332,25 @@ import "CPObject.j"
return CPNotFound;
}
/*
/*!
Returns the first index value in the receiver which is greater than or equal to <code>anIndex</code>.
@return the matching index or <objj>CPNotFound</objj> if no match was found
@return the matching index or CPNotFound if no match was found
*/
- (unsigned int)indexGreaterThanOrEqualToIndex:(unsigned)anIndex
{
return [self indexGreaterThanIndex:anIndex - 1];
}
/*
/*!
Returns the first index value in the receiver which is less than or equal to <code>anIndex</code>.
@return the matching index or <objj>CPNotFound</objj> if no match was found
@return the matching index or CPNotFound if no match was found
*/
- (unsigned int)indexLessThanOrEqualToIndex:(unsigned)anIndex
{
return [self indexLessThanIndex:anIndex + 1];
}
/*
/*!
Fills up the specified array with numbers from the index set within
the specified range. The method stops filling up the array until the
<code>aMaxCount</code> number have been added or the range maximum is reached.
@@ -431,7 +431,7 @@ import "CPObject.j"
@implementation CPIndexSet(CPMutableIndexSet)
// Adding indexes.
/*
/*!
Adds an index to the set.
@param anIndex the index to add
*/
@@ -440,7 +440,7 @@ import "CPObject.j"
[self addIndexesInRange:CPMakeRange(anIndex, 1)];
}
/*
/*!
Adds indices to the set
@param anIndexSet a set of indices to add to the receiver
*/
@@ -455,7 +455,7 @@ import "CPObject.j"
[self addIndexesInRange:ranges[i]];
}
/*
/*!
Adds the range of indices to the set
@param aRange the range of numbers to add as indices to the set
*/
@@ -549,7 +549,7 @@ import "CPObject.j"
}
// Removing Indexes
/*
/*!
Removes an index from the set
@param anIndex the index to remove
*/
@@ -558,7 +558,7 @@ import "CPObject.j"
[self removeIndexesInRange:CPMakeRange(anIndex, 1)];
}
/*
/*!
Removes the indices from the receiving set.
@param anIndexSet the set of indices to remove
from the receiver
@@ -574,7 +574,7 @@ import "CPObject.j"
[self removeIndexesInRange:ranges[i]];
}
/*
/*!
Removes all indices from the set
*/
- (void)removeAllIndexes
@@ -584,7 +584,7 @@ import "CPObject.j"
_cachedRangeIndex = 0;
}
/*
/*!
Removes the indices in the range from the
set.
@param aRange the range of indices to remove
@@ -651,7 +651,7 @@ import "CPObject.j"
}
// Shifting Index Groups
/*
/*!
Shifts the values of indices left or right by a specified amount.
@param anIndex the index to start the shifting operation from (inclusive)
@param aDelta the amount and direction to shift. A positive value shifts to
@@ -737,7 +737,7 @@ var CPIndexSetCountKey = @"CPIndexSetCountKey",
@implementation CPIndexSet (CPCoding)
/*
/*!
Initializes the index set from a coder.
@param aCoder the coder from which to read the
index set data
@@ -764,7 +764,7 @@ var CPIndexSetCountKey = @"CPIndexSetCountKey",
return self;
}
/*
/*!
Writes out the index set to the specified coder.
@param aCoder the coder to which the index set will
be written
@@ -788,7 +788,7 @@ var CPIndexSetCountKey = @"CPIndexSetCountKey",
@implementation CPIndexSet (CPCopying)
/*
/*!
Creates a deep copy of the index set. The returned copy
is mutable. The reason for the two copy methods is for
source compatability with GNUStep code.
@@ -799,7 +799,7 @@ var CPIndexSetCountKey = @"CPIndexSetCountKey",
return [[[self class] alloc] initWithIndexSet:self];
}
/*
/*!
Creates a deep copy of the index set. The returned copy
is mutable. The reason for the two copy methods is for
source compatability with GNUStep code.
@@ -812,9 +812,9 @@ var CPIndexSetCountKey = @"CPIndexSetCountKey",
@end
/*
This class is an empty of subclass of <objj>CPIndexSet</objj>.
<objj>CPIndexSet</objj> already implements mutable methods, and
/*!
This class is an empty of subclass of CPIndexSet.
CPIndexSet already implements mutable methods, and
this class only exists for source compatability.
*/
@implementation CPMutableIndexSet : CPIndexSet
Foundation/CPInvocation.j
+17 -17
View File
@@ -23,8 +23,8 @@
import "CPObject.j"
import "CPException.j"
/*
A <objj>CPInvocation</objj> is an object representation of a message sent to an object.
/*! @class CPInvocation
A CPInvocation is an object representation of a message sent to an object.
*/
@implementation CPInvocation : CPObject
{
@@ -34,8 +34,8 @@ import "CPException.j"
}
// Creating CPInvocation Objects
/*
Returns a new <objj>CPInvocation</objj> that represents a message to a method.
/*!
Returns a new CPInvocation that represents a message to a method.
@param aMethodSignature the signature of the method to message
@return the new invocation
*/
@@ -44,7 +44,7 @@ import "CPException.j"
return [[self alloc] initWithMethodSignature:aMethodSignature];
}
/*
/*!
Initializes the invocation with a provided method signature
@param aMethodSignature the signature of the method to message
@return the initialized invocation
@@ -63,7 +63,7 @@ import "CPException.j"
}
// Configuring an Invocation Object
/*
/*!
Sets the invocation's selector.
@param the invocation selector
*/
@@ -72,7 +72,7 @@ import "CPException.j"
_arguments[1] = aSelector;
}
/*
/*!
Returns the invocation's selector
*/
- (SEL)selector
@@ -80,7 +80,7 @@ import "CPException.j"
return _arguments[1];
}
/*
/*!
Sets the invocation's target
@param aTarget the invocation target
*/
@@ -89,7 +89,7 @@ import "CPException.j"
_arguments[0] = aTarget;
}
/*
/*!
Returns the invocation's target
*/
- (id)target
@@ -97,7 +97,7 @@ import "CPException.j"
return _arguments[0];
}
/*
/*!
Sets a method argument for the invocation. Arguments 0 and 1 are <code>self</code> and <code>_cmd</code>.
@param anArgument the argument to add
@param anIndex the index of the argument in the method
@@ -107,7 +107,7 @@ import "CPException.j"
_arguments[anIndex] = anArgument;
}
/*
/*!
Returns the argument at the specified index. Arguments 0 and 1 are
<code>self</code> and <code>_cmd</code> respectively. Thus, method arguments start at 2.
@param anIndex the index of the argument to return
@@ -118,7 +118,7 @@ import "CPException.j"
return _arguments[anIndex];
}
/*
/*!
Sets the invocation's return value
@param the invocation return value
*/
@@ -127,7 +127,7 @@ import "CPException.j"
_returnValue = aReturnValue;
}
/*
/*!
Returns the invocation's return value
*/
- (id)returnValue
@@ -136,7 +136,7 @@ import "CPException.j"
}
// Dispatching an Invocation
/*
/*!
Sends the encapsulated message to the stored target.
*/
- (void)invoke
@@ -144,7 +144,7 @@ import "CPException.j"
_returnValue = objj_msgSend.apply(objj_msgSend, _arguments);
}
/*
/*!
Sends the encapsulated message to the specified target.
@param the target to which the message will be sent
*/
@@ -161,7 +161,7 @@ var CPInvocationArguments = @"CPInvocationArguments",
@implementation CPInvocation (CPCoding)
/*
/*!
Initializes the invocation with data from a coder.
@param aCoder the coder from which to obtain initialization data
@return the initialized invocation
@@ -179,7 +179,7 @@ var CPInvocationArguments = @"CPInvocationArguments",
return self;
}
/*
/*!
Writes out the invocation's data to the provided coder.
@param aCoder the coder to which the data will be written
*/
Foundation/CPJSONPConnection.j
+9 -3
View File
@@ -24,12 +24,12 @@ import <Foundation/CPObject.j>
CPJSONPConnectionCallbacks = {};
/*
/*! @class CPJSONPConnection
Important note: CPJSONPConnection is <strong>only</strong> for JSONP APIs.
If aren't sure you <strong>need</strong>
<a href="http://ajaxian.com/archives/jsonp-json-with-padding">JSON<strong>P</strong></a>,
you most likely don't want to use CPJSONPConnection, but rather the more standard
<objj>CPURLConnection</objj>. CPJSONPConnection is designed for cross-domain
CPURLConnection. CPJSONPConnection is designed for cross-domain
connections, and if you are making requests to the same domain (as most web
applications do), you do not need it.
*/
@@ -42,7 +42,13 @@ CPJSONPConnectionCallbacks = {};
DOMElement _scriptTag;
}
+ (CPData)sendRequest:(CPURLRequest)aRequest callback:(CPString)callbackParameter delegate:(id)aDelegate
/*! @deprecated */
+ (CPJSONPConnection)sendRequest:(CPURLRequest)aRequest callback:(CPString)callbackParameter delegate:(id)aDelegate
{
return [self connectionWithRequest:aRequest callback:callbackParameter delegate:aDelegate];
}
+ (CPJSONPConnection)connectionWithRequest:(CPURLRequest)aRequest callback:(CPString)callbackParameter delegate:(id)aDelegate
{
return [[[self class] alloc] initWithRequest:aRequest callback:callbackParameter delegate:aDelegate startImmediately:YES];;
}
Foundation/CPKeyValueObserving.j
+1 -1
View File
@@ -2,7 +2,7 @@
* CPKeyValueCoding.j
* Foundation
*
* Created by Francisco Tolmasky.
* Created by Ross Boucher.
* Copyright 2008, 280 North, Inc.
*
* This library is free software; you can redistribute it and/or
Foundation/CPKeyedArchiver.j
+28 -25
View File
@@ -59,12 +59,15 @@ var _CPKeyedArchiverStringClass = Nil,
}
@end
/*
/*! @class CPKeyedArchiver
Implements keyed archiving of object graphs. Archiving means to
write data out in a format that be read in again later, or possibly
stored in a file. To read the data back in, use a
<code>CPKeyedUnarchiver</code>.
@par Delegate Methods
@delegate -(void)archiverWillFinish:(CPKeyedArchiver)archiver;
Called when the encoding is about to finish.
@param archiver the archiver that's about to finish
@@ -132,7 +135,7 @@ var _CPKeyedArchiverStringClass = Nil,
return YES;
}
/*
/*!
Archives the specified object.
@param anObject the object to archive
@return the archived object
@@ -149,7 +152,7 @@ var _CPKeyedArchiverStringClass = Nil,
}
// Initializing an NSKeyedArchiver object
/*
/*!
Initializes the keyed archiver with the specified <code>CPMutableData</code> for writing.
@param data the object to archive to
@return the initialized keyed archiver
@@ -179,7 +182,7 @@ var _CPKeyedArchiverStringClass = Nil,
}
// Archiving Data
/*
/*!
Finishes up writing any left over data, and notifies delegates.
After calling this method, the archiver can not encode anymore objects.
*/
@@ -220,7 +223,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_delegate archiverDidFinish:self];
}
/*
/*!
Returns the property list format used to archive objects.
*/
- (CPPropertyListFormat)outputFormat
@@ -228,7 +231,7 @@ var _CPKeyedArchiverStringClass = Nil,
return _outputFormat;
}
/*
/*!
Sets the property list format the archiver should use to archive objects.
@param aPropertyListFormat the format to use
*/
@@ -237,7 +240,7 @@ var _CPKeyedArchiverStringClass = Nil,
_outputFormat = aPropertyListFormat;
}
/*
/*!
Encodes a <code>BOOL</code> value
@param aBool the <code>BOOL</code> value
@param aKey the key to associate with the <code>BOOL</code>
@@ -247,7 +250,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, aBOOL, NO) forKey:aKey];
}
/*
/*!
Encodes a <code>double</code> value
@param aDouble the <code>double</code> value
@param aKey the key to associate with the <code>double</code>
@@ -257,7 +260,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, aDouble, NO) forKey:aKey];
}
/*
/*!
Encodes a <code>float</code> value
@param aFloat the <code>float</code> value
@param aKey the key to associate with the <code>float</code>
@@ -267,7 +270,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, aFloat, NO) forKey:aKey];
}
/*
/*!
Encodes a <code>int</code> value
@param anInt the <code>int</code> value
@param aKey the key to associate with the <code>int</code>
@@ -278,7 +281,7 @@ var _CPKeyedArchiverStringClass = Nil,
}
// Managing Delegates
/*
/*!
Sets the keyed archiver's delegate
*/
- (void)setDelegate:(id)aDelegate
@@ -302,7 +305,7 @@ var _CPKeyedArchiverStringClass = Nil,
}
/*
/*!
Returns the keyed archiver's delegate
*/
- (id)delegate
@@ -310,8 +313,8 @@ var _CPKeyedArchiverStringClass = Nil,
return _delegate;
}
/*
Encodes a <objj>CGPoint</objj>
/*!
Encodes a CGPoint
@param aPoint the point to encode
@param aKey the key to associate with the point
*/
@@ -320,8 +323,8 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, CPStringFromPoint(aPoint), NO) forKey:aKey];
}
/*
Encodes a <objj>CGRect</objj>
/*!
Encodes a CGRect
@param aRect the rectangle to encode
@param aKey the key to associate with the rectangle
*/
@@ -330,8 +333,8 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, CPStringFromRect(aRect), NO) forKey:aKey];
}
/*
Encodes a <objj>CGSize</objj>
/*!
Encodes a CGSize
@param aSize the size to encode
@param aKey the key to associate with the size
*/
@@ -340,7 +343,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, CPStringFromSize(aSize), NO) forKey:aKey];
}
/*
/*!
Encodes an conditionally. The method checks if the object has already been
coded into this data stream before. If so, it will only encode a reference
to that first object to save memory.
@@ -352,7 +355,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, anObject, YES) forKey:aKey];
}
/*
/*!
Encodes a number
@param aNumber the number to encode
@param aKey the key to associate with the object
@@ -362,7 +365,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_plistObject setObject:_CPKeyedArchiverEncodeObject(self, aNuumber, NO) forKey:aKey];
}
/*
/*!
Encdoes an object
@param anObject the object to encode
@param aKey the key to associate with the object
@@ -399,7 +402,7 @@ var _CPKeyedArchiverStringClass = Nil,
}
// Managing classes and class names
/*
/*!
Allows substitution of class types for encoding. Specifically classes
of type <code>aClass</code> encountered by all keyed archivers will
instead be archived as a class of type <code>aClassName</code>.
@@ -414,7 +417,7 @@ var _CPKeyedArchiverStringClass = Nil,
[CPArchiverReplacementClassNames setObject:aClassName forKey:CPStringFromClass(aClass)];
}
/*
/*!
Returns the name of the substitute class used for encoding
<code>aClass</code> by all keyed archivers.
@param aClass the class to substitute
@@ -431,7 +434,7 @@ var _CPKeyedArchiverStringClass = Nil,
return className ? className : aClass.name;
}
/*
/*!
Allows substitution of class types for encoding. Specifically classes
of type <code>aClass</code> encountered by this keyed archiver will
instead be archived as a class of type <code>aClassName</code>.
@@ -446,7 +449,7 @@ var _CPKeyedArchiverStringClass = Nil,
[_replacementClassNames setObject:aClassName forKey:CPStringFromClass(aClass)];
}
/*
/*!
Returns the name of the substitute class used for encoding <code>aClass</code> by this keyed archiver.
@param aClass the class to substitute
@return the name of the substitute class, or <code>nil</code> if there is no substitute class
Foundation/CPKeyedUnarchiver.j
+7 -7
View File
@@ -49,9 +49,9 @@ var _CPKeyedUnarchiverArrayClass = Ni
_CPKeyedUnarchiverArchiverValueClass = Nil;
/*
<objj>CPKeyedUnarchiver</objj> is used for creating objects out of
coded files or <objj>CPData</objj> objects that were created by
<objj>CPKeyedArchiver</objj>. More specifically, this class unarchives
CPKeyedUnarchiver is used for creating objects out of
coded files or CPData objects that were created by
CPKeyedArchiver. More specifically, this class unarchives
objects from a data stream or file and brings them back into
memory for programmatic usage.
@@ -66,7 +66,7 @@ var _CPKeyedUnarchiverArrayClass = Ni
@param an array of class names describing the encoded object's
class hierarchy. The first index is the encoded class name, and
each superclass is after that.
@return the <objj>Class</objj> to use instead or <code>nil</code>
@return the Class to use instead or <code>nil</code>
to abort the unarchiving operation
@delegate -(id)unarchiver:(CPKeyedUnarchiver)unarchiver didDecodeObject:(id)object;
@@ -261,7 +261,7 @@ var _CPKeyedUnarchiverArrayClass = Ni
}
/*
Decodes a <objj>CGPoint</objj> from the archive.
Decodes a CGPoint from the archive.
@param aKey the point's associated key
@return the decoded point
*/
@@ -276,7 +276,7 @@ var _CPKeyedUnarchiverArrayClass = Ni
}
/*
Decodes a <objj>CGRect</objj> from the archive.
Decodes a CGRect from the archive.
@param aKey the rectangle's associated key
@return the decoded rectangle
*/
@@ -291,7 +291,7 @@ var _CPKeyedUnarchiverArrayClass = Ni
}
/*
Decodes a <objj>CGSize</objj> from the archive.
Decodes a CGSize from the archive.
@param aKey the size's associated key
@return the decoded size
*/
Foundation/CPNotification.j
+11 -11
View File
@@ -23,11 +23,11 @@
import "CPObject.j"
import "CPException.j"
/*
Represents a notification for posting to an <objj>CPNotificationCenter</objj>. Consists of a name, an object, and an optional dictionary. The notification center will check for observers registered to receive either notifications with the name, the object, or both and pass the notification instance on to them.
/*! @class CPNotification
Represents a notification for posting to an CPNotificationCenter. Consists of a name, an object, and an optional dictionary. The notification center will check for observers registered to receive either notifications with the name, the object, or both and pass the notification instance on to them.
To create a notification use one of the class methods. The default <objj>init</objj> method will throw a
<objj>CPUnsupportedMethodException</objj>.
To create a notification use one of the class methods. The default init method will throw a
CPUnsupportedMethodException.
*/
@implementation CPNotification : CPObject
{
@@ -36,7 +36,7 @@ import "CPException.j"
CPDictionary _userInfo;
}
/*
/*!
Creates a new notification with the specified name, object and dictionary.
@param aNotificationName the name of the notification
@param anObject the associated object
@@ -48,7 +48,7 @@ import "CPException.j"
return [[self alloc] initWithName:aNotificationName object:anObject userInfo:aUserInfo];
}
/*
/*!
Creates a new notification with the specified name and object.
@param aNotificationName the name of the notification
@param anObject the associated object
@@ -59,7 +59,7 @@ import "CPException.j"
return [[self alloc] initWithName:aNotificationName object:anObject userInfo:nil];
}
/*
/*!
@throws CPUnsupportedMethodException always, because the method should not be used
*/
- (id)init
@@ -68,7 +68,7 @@ import "CPException.j"
reason:"CPNotification's init method should not be used"];
}
/*
/*!
Initializes the notification with a name, object and dictionary
@param aNotificationName the name of the notification
@param anObject the associated object
@@ -90,7 +90,7 @@ import "CPException.j"
return self;
}
/*
/*!
Returns the notification name.
*/
- (CPString)name
@@ -98,7 +98,7 @@ import "CPException.j"
return _name;
}
/*
/*!
Returns the notification's object.
*/
- (id)object
@@ -106,7 +106,7 @@ import "CPException.j"
return _object;
}
/*
/*!
Returns the notification's dictionary.
*/
- (CPDictionary)userInfo
Foundation/CPNotificationCenter.j
+13 -11
View File
@@ -28,8 +28,9 @@ import "CPException.j"
var CPNotificationDefaultCenter = nil;
/*
Cappuccino provides a framework for sending messages between objects within a process called notifications. Objects register with an <objj>CPNotificationCenter</objj> to be informed whenever other objects post <objj>CPNotification</objj>s to it matching certain criteria. The notification center processes notifications synchronously -- that is, control is only returned to the notification poster once every recipient of the notification has received it and processed it.
/*! @class CPNotificationCenter
Cappuccino provides a framework for sending messages between objects within a process called notifications. Objects register with an CPNotificationCenter to be informed whenever other objects post CPNotifications to it matching certain criteria. The notification center processes notifications synchronously -- that is, control is only returned to the notification poster once every recipient of the notification has received it and processed it.
*/
@implementation CPNotificationCenter : CPObject
{
@@ -37,7 +38,7 @@ var CPNotificationDefaultCenter = nil;
_CPNotificationRegistry _unnamedRegistry;
}
/*
/*!
Returns the application's notification center
*/
+ (CPNotifcationCenter)defaultCenter
@@ -60,7 +61,7 @@ var CPNotificationDefaultCenter = nil;
return self;
}
/*
/*!
Adds an object as an observer. The observer will receive notifications with the specified name
and/or containing the specified object (depending on if they are <code>nil</code>.
@param anObserver the observing object
@@ -85,7 +86,7 @@ var CPNotificationDefaultCenter = nil;
[registry addObserver:observer object:anObject];
}
/*
/*!
Unregisters the specified observer from all notifications.
@param anObserver the observer to unregister
*/
@@ -100,7 +101,7 @@ var CPNotificationDefaultCenter = nil;
[_unnamedRegistry removeObserver:anObserver object:nil];
}
/*
/*!
Unregisters the specified observer from notifications matching the specified name and/or object.
@param anObserver the observer to remove
@param aNotificationName the name of notifications to no longer watch
@@ -122,10 +123,10 @@ var CPNotificationDefaultCenter = nil;
[[_namedRegistries objectForKey:aNotificationName] removeObserver:anObserver object:anObject];
}
/*
/*!
Posts a notification to all observers that match the specified notification's name and object.
@param aNotification the notification being posted
@throws CPInvalidArgumentException if aNotification is <objj>nil</objj>
@throws CPInvalidArgumentException if aNotification is nil
*/
- (void)postNotification:(CPNotification)aNotification
{
@@ -135,7 +136,7 @@ var CPNotificationDefaultCenter = nil;
_CPNotificationCenterPostNotification(self, aNotification);
}
/*
/*!
Posts a new notification with the specified name, object, and dictionary.
@param aNotificationName the name of the notification name
@param anObject the associated object
@@ -146,7 +147,7 @@ var CPNotificationDefaultCenter = nil;
_CPNotificationCenterPostNotification(self, [[CPNotification alloc] initWithName:aNotificationName object:anObject userInfo:aUserInfo]);
}
/*
/*!
Posts a new notification with the specified name and object.
@param aNotificationName the name of the notification
@param anObject the associated object
@@ -164,7 +165,8 @@ var _CPNotificationCenterPostNotification = function(/* CPNotificationCenter */
[[self._namedRegistries objectForKey:[aNotification name]] postNotification:aNotification];
}
/** Mapping of Notification Name to listening object/selector.
/*
Mapping of Notification Name to listening object/selector.
@ignore
*/
@implementation _CPNotificationRegistry : CPObject
Foundation/CPNull.j
+4 -4
View File
@@ -24,7 +24,7 @@ import "CPObject.j"
var CPNullSharedNull = nil;
/*
/*! @class CPNull
This class is used as an object representation of <code>nil</code>. This is handy when a collection
only accepts objects as values, but you would like a <code>nil</code> representation in there.
*/
@@ -39,9 +39,9 @@ var CPNullSharedNull = nil;
return [super alloc];
}*/
/*
Returns the singleton instance of the <objj>CPNull</objj>
object. While <objj>CPNull</objj> and <code>nil</code> should
/*!
Returns the singleton instance of the CPNull
object. While CPNull and <code>nil</code> should
be <i>interpreted</i> as the same, they are not equal ('==').
*/
+ (CPNull)null
Foundation/CPNumber.j
+5 -2
View File
@@ -26,10 +26,13 @@ import "CPObjJRuntime.j"
var __placeholder = new Number(),
_CPNumberHashes = { };
/*
/*! @class CPNumber
This class primarily exists for source compatability. The JavaScript
<code>Number</code> type can be changed on the fly based on context,
so there is no need to call any of these methods.
so there is no need to call any of these methods.
In other words, native JavaScript numbers are bridged to CPNumber,
so you can use them interchangeably (including operators and methods).
*/
@implementation CPNumber : CPObject
Foundation/CPObject.j
+50 -44
View File
@@ -20,6 +20,12 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*!
@class CPObject
CPObject is the root class for most Cappuccino classes. Your custom classes
should almost always subclass CPObject or one of its children.
*/
@implementation CPObject
{
Class isa;
@@ -34,7 +40,7 @@
// CPLog("calling initialize "+self.name);
}
/*
/*!
Allocates a new instance of the receiver, and sends it an <code>init</code>
@return the new object
*/
@@ -43,7 +49,7 @@
return [[self alloc] init];
}
/*
/*!
Allocates a new instance of the receiving class
*/
+ (id)alloc
@@ -52,7 +58,7 @@
return class_createInstance(self);
}
/*
/*!
Initializes the receiver
@return the initialized receiver
*/
@@ -61,7 +67,7 @@
return self;
}
/*
/*!
Makes a deep copy of the receiver. The copy should be functionally equivalent to the receiver.
@return the copy of the receiver
*/
@@ -70,7 +76,7 @@
return self;
}
/*
/*!
Creates a deep mutable copy of the receiver.
@return the mutable copy of the receiver
*/
@@ -79,7 +85,7 @@
return [self copy];
}
/*
/*!
Not necessary to call in Objective-J. Only exists for code compatability.
*/
- (void)dealloc
@@ -87,23 +93,23 @@
}
// Identifying classes
/*
Returns the <objj>Class</objj> object for this class definition.
/*!
Returns the Class object for this class definition.
*/
+ (Class)class
{
return self;
}
/*
Returns the receiver's <objj>Class</objj>
/*!
Returns the receiver's Class
*/
- (Class)class
{
return isa;
}
/*
/*!
Returns the class object super class
*/
+ (Class)superclass
@@ -111,7 +117,7 @@
return super_class;
}
/*
/*!
Returns <code>YES</code> if the receiving class is a subclass of <code>aClass</code>.
@param aClass the class to test inheritance from
*/
@@ -125,7 +131,7 @@
return NO;
}
/*
/*!
Returns <code>YES</code> if the receiver is a <code>aClass</code> type, or a subtype of it.
@param aClass the class to test as the receiver's class or super class.
*/
@@ -134,7 +140,7 @@
return [isa isSubclassOfClass:aClass];
}
/*
/*!
Returns <code>YES</code> if the receiver is of the <code>aClass</code> class type.
@param aClass the class to test the receiper
*/
@@ -143,7 +149,7 @@
return self.isa == aClass;
}
/*
/*!
Determines whether the receiver's root object is a proxy.
@return <code>YES</code> if the root object is a proxy
*/
@@ -153,7 +159,7 @@
}
// Testing class functionality
/*
/*!
Test whether instances of this class respond to the provided selector.
@param aSelector the selector for which to test the class
@return <code>YES</code> if instances of the class respond to the selector
@@ -163,7 +169,7 @@
return class_getInstanceMethod(self, aSelector);
}
/*
/*!
Tests whether the receiver responds to the provided selector.
@param aSelector the selector for which to test the receiver
@return <code>YES</code> if the receiver responds to the selector
@@ -175,7 +181,7 @@
// Obtaining method information
/*
/*!
Returns the address of the receiver's method for the provided selector.
@param aSelector the selector for the method to return
@return the address of the method's implementation
@@ -185,7 +191,7 @@
return class_getInstanceMethod(isa, aSelector);
}
/*
/*!
Returns the address of the receiving class' method for the provided selector.
@param aSelector the selector for the class method to return
@return the address of the method's implementation
@@ -195,7 +201,7 @@
return class_getInstanceMethod(self, aSelector);
}
/*
/*!
Returns the method signature for the provided selector.
@param aSelector the selector for which to find the method signature
@return the selector's methd signature
@@ -207,7 +213,7 @@
}
// Describing objects
/*
/*!
Returns a human readable string describing the receiver
*/
- (CPString)description
@@ -216,7 +222,7 @@
}
// Sending Messages
/*
/*!
Sends the specified message to the receiver.
@param aSelector the message to send
@return the return value of the message
@@ -226,7 +232,7 @@
return objj_msgSend(self, aSelector);
}
/*
/*!
Sends the specified message to the receiver, with one argument.
@param aSelector the message to send
@param anObject the message argument
@@ -237,7 +243,7 @@
return objj_msgSend(self, aSelector, anObject);
}
/*
/*!
Sends the specified message to the receiver, with two arguments.
@param aSelector the message to send
@param anObject the first message argument
@@ -250,7 +256,7 @@
}
// Forwarding Messages
/*
/*!
Subclasses can override this method to forward message to
other objects. Overwriting this method in conjunction with
<code>methodSignatureForSelector:</code> allows the receiver to
@@ -261,7 +267,7 @@
[self doesNotRecognizeSelector:[anInvocation selector]];
}
/*
/*!
Used for forwarding of messages to other objects.
@ignore
*/
@@ -291,7 +297,7 @@
}
// Error Handling
/*
/*!
Called by the Objective-J runtime when an object can't respond to
a message. It's not recommended to call this method directly, unless
you need your class to not support a method that it has inherited from a super class.
@@ -304,12 +310,12 @@
}
// Archiving
/*
/*!
Subclasses override this method to possibly substitute
the unarchived object with another. This would be
useful if your program utilizes a
<a href="http://en.wikipedia.org/wiki/Flyweight_pattern">flyweight pattern</a>.
The method is called by <objj>CPCoder</objj>.
The method is called by CPCoder.
@param aCoder the coder that contained the receiver's data
*/
- (id)awakeAfterUsingCoder:(CPCoder)aCoder
@@ -317,7 +323,7 @@
return self;
}
/*
/*!
Can be overridden by subclasses to substitute a different class to represent the receiver for keyed archiving.
@return the class to use. A <code>nil</code> means to ignore the method result.
*/
@@ -326,7 +332,7 @@
return [self classForCoder];
}
/*
/*!
Can be overridden by subclasses to substitute a different class to represent the receiver during coding.
@return the class to use for coding
*/
@@ -335,7 +341,7 @@
return [self class];
}
/*
/*!
Can be overridden by subclasses to substitute another object during archiving.
@param anArchiver that archiver
@return the object to archive
@@ -345,7 +351,7 @@
return [self replacementObjectForCoder:anArchiver];
}
/*
/*!
Can be overridden by subclasses to substitute another object during keyed archiving.
@param anArchive the keyed archiver
@return the object to archive
@@ -355,7 +361,7 @@
return [self replacementObjectForCoder:anArchiver];
}
/*
/*!
Can be overridden by subclasses to substitute another object during coding.
@param aCoder the coder
@return the object to code
@@ -365,7 +371,7 @@
return self;
}
/*
/*!
Sets the class version number.
@param the new version number for the class
*/
@@ -376,7 +382,7 @@
return self;
}
/*
/*!
Returns the class version number.
*/
+ (int)version
@@ -385,7 +391,7 @@
}
// Scripting (?)
/*
/*!
Returns the class name
*/
- (CPString)className
@@ -394,7 +400,7 @@
}
// Extras
/*
/*!
Does nothing.
@return the receiver
*/
@@ -403,7 +409,7 @@
return self;
}
/*
/*!
Returns a hash for the object
*/
- (unsigned)hash
@@ -411,7 +417,7 @@
return __address;
}
/*
/*!
Determines if <code>anObject</code> is functionally equivalent to the receiver.
@return <code>YES</code> if <code>anObject</code> is functionally equivalent to the receiver.
*/
@@ -420,7 +426,7 @@
return self === anObject;
}
/*
/*!
Does nothing.
@return the receiver
*/
@@ -429,14 +435,14 @@
return self;
}
/*
/*!
Does nothing.
*/
- (void)release
{
}
/*
/*!
Returns the receiver.
*/
- (id)self
@@ -444,7 +450,7 @@
return self;
}
/*
/*!
Returns the receiver's super class.
*/
- (Class)superclass
Foundation/CPRange.j
+31 -31
View File
@@ -20,8 +20,8 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
Makes a <objj>CPRange</objj>.
/*!
Makes a CPRange.
@param location the location for new range
@param length the length of the new range
@group CPRange
@@ -32,9 +32,9 @@ function CPMakeRange(location, length)
return { location: location, length: length };
}
/*
Makes a copy of a <objj>CPRange</objj>.
@param aRange the <objj>CPRange</objj> to copy
/*!
Makes a copy of a CPRange.
@param aRange the CPRange to copy
@group CPRange
@return CPRange the copy of the range
*/
@@ -43,9 +43,9 @@ function CPCopyRange(aRange)
return { location: aRange.location, length: aRange.length };
}
/*
Makes a copy of a <objj>CPRange</objj>.
@param aRange the <objj>CPRange</objj> to copy
/*!
Makes a copy of a CPRange.
@param aRange the CPRange to copy
@group CPRange
@return CPRange the copy of the range
*/
@@ -54,7 +54,7 @@ function CPMakeRangeCopy(aRange)
return { location:aRange.location, length:aRange.length };
}
/*
/*!
Sets a range's <code>length</code> to 0.
@param aRange the range to empty
@group CPRange
@@ -65,7 +65,7 @@ function CPEmptyRange(aRange)
return aRange.length == 0;
}
/*
/*!
Finds the range maximum. (<code>location + length</code>)
@param aRange the range to calculate a maximum from
@group CPRange
@@ -76,21 +76,21 @@ function CPMaxRange(aRange)
return aRange.location + aRange.length;
}
/*
Determines if two <objj>CPRange</objj>s are equal.
@param lhsRange the first <objj>CPRange</objj>
@param rhsRange the second <objj>CPRange</objj>
@return BOOL <code>YES</code> if the two <objj>CPRange</objj>s are equal.
/*!
Determines if two CPRanges are equal.
@param lhsRange the first CPRange
@param rhsRange the second CPRange
@return BOOL <code>YES</code> if the two CPRanges are equal.
*/
function CPEqualRanges(lhsRange, rhsRange)
{
return ((lhsRange.location == rhsRange.location) && (lhsRange.length == rhsRange.length));
}
/*
Determines if a number is within a specified <objj>CPRange</objj>.
/*!
Determines if a number is within a specified CPRange.
@param aLocation the number to check
@param aRange the <objj>CPRange</objj> to check within
@param aRange the CPRange to check within
@group CPRange
@return BOOL <code>YES</code> if <code>aLocation/code> is within the range
*/
@@ -99,13 +99,13 @@ function CPLocationInRange(aLocation, aRange)
return (aLocation >= aRange.location) && (aLocation < CPMaxRange(aRange));
}
/*
/*!
Creates a new range with the minimum <code>location</code> and a <code>length</code>
that extends to the maximum <code>length</code>.
@param lhsRange the first <objj>CPRange</objj>
@param rhsRange the second <objj>CPRange</objj>
@param lhsRange the first CPRange
@param rhsRange the second CPRange
@group CPRange
@return CPRange the new <objj>CPRange</objj>
@return CPRange the new CPRange
*/
function CPUnionRange(lhsRange, rhsRange)
{
@@ -113,12 +113,12 @@ function CPUnionRange(lhsRange, rhsRange)
return CPMakeRange(location, Math.max(CPMaxRange(lhsRange), CPMaxRange(rhsRange)) - location);
}
/*
Creates a new <objj>CPRange</objj> that spans the common range of two <objj>CPRange</objj>s
@param lhsRange the first <objj>CPRange</objj>
@param rhsRange the second <objj>CPRange</objj>
/*!
Creates a new CPRange that spans the common range of two CPRanges
@param lhsRange the first CPRange
@param rhsRange the second CPRange
@group CPRange
@return CPRange the new <objj>CPRange</objj>
@return CPRange the new CPRange
*/
function CPIntersectionRange(lhsRange, rhsRange)
{
@@ -129,7 +129,7 @@ function CPIntersectionRange(lhsRange, rhsRange)
return CPMakeRange(location, Math.min(CPMaxRange(lhsRange), CPMaxRange(rhsRange)) - location);
}
/*
/*!
Returns a string describing a range.
@param aRange the range to describe
@group CPRange
@@ -140,9 +140,9 @@ function CPStringFromRange(aRange)
return "{" + aRange.location + ", " + aRange.length + "}";
}
/*
Creates a <objj>CPRange</objj> from the contents of a <objj>CPString</objj>.
@param aString the string to create a <objj>CPRange</objj> from
/*!
Creates a CPRange from the contents of a CPString.
@param aString the string to create a CPRange from
@group CPRange
@return CPRange the new range
*/
Foundation/CPRunLoop.j
+9 -8
View File
@@ -24,7 +24,7 @@ import "CPObject.j"
import "CPArray.j"
import "CPString.j"
/*
/*!
@global
@group CPRunLoopMode
*/
@@ -124,7 +124,8 @@ var _CPRunLoopPerformPool = [],
@end
/*
/*! @class CPRunLoop
CPRunLoop instances handle various utility tasks that must be performed repetitively in an application, such as processing input events.
There is one run loop per application, which may always be obtained through the +currentRunLoop method,
@@ -160,23 +161,23 @@ var _CPRunLoopPerformPool = [],
return self;
}
/*
Returns the application's singleton <objj>CPRunLoop</objj>.
/*!
Returns the application's singleton CPRunLoop.
*/
+ (CPRunLoop)currentRunLoop
{
return CPMainRunLoop;
}
/*
Returns the application's singleton <objj>CPRunLoop</objj>.
/*!
Returns the application's singleton CPRunLoop.
*/
+ (CPRunLoop)mainRunLoop
{
return CPMainRunLoop;
}
/*
/*!
Performs the specified selector on the specified target. The method will be invoked synchronously.
@param aSelector the selector of the method to invoke
@param aTarget the target of the selector
@@ -203,7 +204,7 @@ var _CPRunLoopPerformPool = [],
}
}
/*
/*!
Cancels the specified selector and target.
@param aSelector the selector of the method to invoke
@param aTarget the target to invoke the method on
Foundation/CPSortDescriptor.j
+13 -13
View File
@@ -23,27 +23,27 @@
import "CPObject.j"
import "CPObjJRuntime.j"
/*
/*!
The left operand is smaller than the right.
@global
@group CPComparisonResult
*/
CPOrderedAscending = -1;
/*
/*!
The left and right operands are equal.
@global
@group CPComparisonResult
*/
CPOrderedSame = 0;
/*
/*!
The left operand is greater than the right.
@global
@group CPComparisonResult
*/
CPOrderedDescending = 1;
/*
A <objj>CPSortDescriptor</objj> holds the attributes necessary to describe how
/*! @class CPSortDescriptor
A CPSortDescriptor holds the attributes necessary to describe how
to sort a set of objects. The sort descriptor instance holds a property key path
to the sort item of the objects to compare, the method selector to call for sorting and the sort order.
*/
@@ -55,7 +55,7 @@ CPOrderedDescending = 1;
}
// Initializing a sort descriptor
/*
/*!
Initializes the sort descriptor.
@param aKey the property key path to sort
@param isAscending the sort order
@@ -66,12 +66,12 @@ CPOrderedDescending = 1;
return [self initWithKey:aKey ascending:isAscending selector:@selector(compare:)];
}
/*
/*!
Initializes the sort descriptor
@param aKey the property key path to sort
@param isAscending the sort order
@param aSelector this method gets called to compare objects. The method will take one argument
(the object to compare against itself, and must return a <objj>CPComparisonResult</objj>.
(the object to compare against itself, and must return a CPComparisonResult.
*/
- (id)initWithKey:(CPString)aKey ascending:(BOOL)isAscending selector:(SEL)aSelector
{
@@ -88,7 +88,7 @@ CPOrderedDescending = 1;
}
// Getting information about a sort descriptor
/*
/*!
Returns <code>YES</code> if the sort descriptor's order is ascending.
*/
- (BOOL)ascending
@@ -96,7 +96,7 @@ CPOrderedDescending = 1;
return _ascending;
}
/*
/*!
Returns the descriptor's property key
*/
- (CPString)key
@@ -104,7 +104,7 @@ CPOrderedDescending = 1;
return _key;
}
/*
/*!
Returns the selector of the method to call when comparing objects.
*/
- (SEL)selector
@@ -113,7 +113,7 @@ CPOrderedDescending = 1;
}
// Using sort descriptors
/*
/*!
Compares two objects.
@param lhsObject the left hand side object to compre
@param rhsObject the right hand side object to compare
@@ -124,7 +124,7 @@ CPOrderedDescending = 1;
return (_ascending ? 1 : -1) * [[lhsObject valueForKey:_key] performSelector:_selector withObject:[rhsObject valueForKey:_key]];
}
/*
/*!
Makes a copy of this sort descriptor with a reversed sort order.
@return the reversed copy of the sort descriptor
*/
Foundation/CPString.j
+58 -58
View File
@@ -23,30 +23,30 @@
import "CPObject.j"
import "CPException.j"
/*
/*!
A case insensitive search
@global
@class CPString
*/
CPCaseInsensitiveSearch = 1;
/*
/*!
Exact character match
@global
@class CPString
*/
CPLiteralSearch = 2;
/*
/*!
Start searching from the end of the string
@global
@class CPString
*/
CPBackwardsSearch = 4;
/*
/*!
@global
@class CPString
*/
CPAnchoredSearch = 8;
/*
/*!
Numbers in the string are compared as numbers instead of strings
@global
@class CPString
@@ -55,13 +55,13 @@ CPNumericSearch = 64;
var CPStringHashes = new objj_dictionary();
/*
<objj>CPString</objj> is an object that allows management of strings. Because <objj>CPString</objj> is
based on the JavaScript <code>String</code> object, <objj>CPString</objj>s are immutable, although the
class does have methods that create new <objj>CPString</objj>s generated from modifications to the
/*! @class CPString
CPString is an object that allows management of strings. Because CPString is
based on the JavaScript <code>String</code> object, CPStrings are immutable, although the
class does have methods that create new CPStrings generated from modifications to the
receiving instance.</p>
<p>A handy feature of <objj>CPString</objj> instances is that they can be used wherever a JavaScript is
<p>A handy feature of CPString instances is that they can be used wherever a JavaScript is
required, and vice versa.
*/
@implementation CPString : CPObject
@@ -74,7 +74,7 @@ var CPStringHashes = new objj_dictionary();
return new String;
}
/*
/*!
Returns a new string
*/
+ (id)string
@@ -82,8 +82,8 @@ var CPStringHashes = new objj_dictionary();
return [[self alloc] init];
}
/*
Returns a <objj>CPString</objj> containing the specified hash.
/*!
Returns a CPString containing the specified hash.
@param aHash the hash to represent as a string
*/
+ (id)stringWithHash:(unsigned)aHash
@@ -94,11 +94,11 @@ var CPStringHashes = new objj_dictionary();
return zeros.substring(0, zeros.length - digits.length) + digits;
}
/*
/*!
Returns a copy of the specified string.
@param aString a non-<code>nil</code> string to copy
@throws CPInvalidArgumentException if <code>aString</code> is <code>nil</code>
@return the new <objj>CPString</objj>
@return the new CPString
*/
+ (id)stringWithString:(CPString)aString
{
@@ -109,20 +109,20 @@ var CPStringHashes = new objj_dictionary();
return [[self alloc] initWithString:aString];
}
/*
/*!
Initializes the string with data from the specified string.
@param aString the string to copy data from
@return the initialized <objj>CPString</objj>
@return the initialized CPString
*/
- (id)initWithString:(CPString)aString
{
return String(aString);
}
/*
/*!
Initializes a string using C printf-style formatting. First argument should be a constant format string, like ' "float val = %f" ', remaining arguments should be the variables to print the values of, comma-separated.
@param format the format to be used, printf-style
@return the initialized <objj>CPString</objj>
@return the initialized CPString
*/
- (id)initWithFormat:(CPString)format, ...
{
@@ -134,11 +134,11 @@ var CPStringHashes = new objj_dictionary();
return self;
}
/*
/*!
Creates a new string using C printf-style formatting. First argument should be a constant format string,
like ' "float val = %f" ', remaining arguments should be the variables to print the values of, comma-separated.
@param format the format to be used, printf-style
@return the initialized <objj>CPString</objj>
@return the initialized CPString
*/
+ (id)stringWithFormat:(CPString)format, ...
{
@@ -149,15 +149,15 @@ var CPStringHashes = new objj_dictionary();
return sprintf.apply(this, Array.prototype.slice.call(arguments, 2));
}
/*
Returns a description of this <objj>CPString</objj> object.
/*!
Returns a description of this CPString object.
*/
- (CPString)description
{
return "<" + self.isa.name + " 0x" + [CPString stringWithHash:[self hash]] + " \"" + self + "\">";
}
/*
/*!
Returns the number of UTF-8 characters in the string.
*/
- (int)length
@@ -165,7 +165,7 @@ var CPStringHashes = new objj_dictionary();
return length;
}
/*
/*!
Returns the character at the specified index.
@param anIndex the index of the desired character
*/
@@ -176,11 +176,11 @@ var CPStringHashes = new objj_dictionary();
// Combining strings
/*
/*!
Returns a string made by appending to the reciever a string constructed from a given format
string and the floowing arguments
@param format the format string in printf-style.
@return the initialized <objj>CPString</objj>
@return the initialized CPString
*/
- (CPString)stringByAppendingFormat:(CPString)format, ...
{
@@ -190,8 +190,8 @@ var CPStringHashes = new objj_dictionary();
return self + sprintf.apply(this, Array.prototype.slice.call(arguments, 2));
}
/*
Creates a new <objj>CPString</objj> from the concatenation of the receiver and the specified string.
/*!
Creates a new CPString from the concatenation of the receiver and the specified string.
@param aString the string to append to the receiver
@return the new string
*/
@@ -200,14 +200,14 @@ var CPStringHashes = new objj_dictionary();
return self + aString;
}
/*
/*!
Returns a new string formed by padding characters or removing them.
If the padding length is shorter than the receiver's length, the
new string will be trimmed down to the padding length size.
If the padding length is longer than the receiver's length, then the
new string is repeatedly padded with the characters from the
specified string starting at the specified index.
@param aLength the desired length of the new <objj>CPString</objj>
@param aLength the desired length of the new CPString
@param aString the padding string to use (if necessary)
@param anIndex the index of the padding string to start from (if necessary to use)
@return the new padded string
@@ -231,7 +231,7 @@ var CPStringHashes = new objj_dictionary();
}
//Dividing Strings
/*
/*!
Tokenizes the receiver string using the specified
delimiter. For example, if the receiver is:
<pre>"arash.francisco.ross.tom"</pre>
@@ -247,7 +247,7 @@ var CPStringHashes = new objj_dictionary();
return split(aString);
}
/*
/*!
Returns a substring starting from the specified index to the end of the receiver.
@param anIndex the starting string (inclusive)
@return the substring
@@ -257,7 +257,7 @@ var CPStringHashes = new objj_dictionary();
return substr(anIndex);
}
/*
/*!
Returns a substring starting from the specified range <code>location</code> to the range <code>length</code>.
@param the range of the substring
@return the substring
@@ -267,7 +267,7 @@ var CPStringHashes = new objj_dictionary();
return substr(aRange.location, aRange.length);
}
/*
/*!
Creates a substring from the beginning of the receiver to the specified index.
@param anIndex the last index of the receiver to use for the substring (inclusive)
@return the substring
@@ -279,7 +279,7 @@ var CPStringHashes = new objj_dictionary();
// Finding characters and substrings
/*
/*!
Finds the range of characters in the receiver where the specified string exists. If the string
does not exist in the receiver, the range <code>length</code> will be 0.
@param aString the string to search for in the receiver
@@ -290,7 +290,7 @@ var CPStringHashes = new objj_dictionary();
return [self rangeOfString:aString options:0];
}
/*
/*!
Finds the range of characters in the receiver
where the specified string exists. The search
is subject to the options specified in the
@@ -312,7 +312,7 @@ var CPStringHashes = new objj_dictionary();
return [self rangeOfString:aString options:aMask range:nil];
}
/*
/*!
Finds the range of characters in the receiver
where the specified string exists in the given range
of the receiver.The search is subject to the options specified in the
@@ -353,7 +353,7 @@ var CPStringHashes = new objj_dictionary();
//Replacing Substrings
/*
/*!
Returns a new string in which all occurrences of a target string in the reciever are replaced by
another given string.
@param target The string to replace.
@@ -381,7 +381,7 @@ var CPStringHashes = new objj_dictionary();
// Identifying and comparing strings
/*
/*!
Compares the receiver to the specified string.
@param aString the string with which to compare
@return the result of the comparison
@@ -391,7 +391,7 @@ var CPStringHashes = new objj_dictionary();
return [self compare:aString options:CPCaseInsensitiveSearch]
}
/*
/*!
Compares the receiver to the specified string, using options.
@param aString the string with which to compare
@param aMask the options to use for the comparison
@@ -416,7 +416,7 @@ var CPStringHashes = new objj_dictionary();
return CPOrderedSame;
}
/*
/*!
Returns <code>YES</code> if the receiver starts
with the specified string. If <code>aString</code>
is empty, the method will return <code>NO</code>.
@@ -426,7 +426,7 @@ var CPStringHashes = new objj_dictionary();
return aString && aString != "" && indexOf(aString) == 0;
}
/*
/*!
Returns <code>NO</code> if the receiver ends
with the specified string. If <code>aString</code>
is empty, the method will return <code>NO</code>.
@@ -436,7 +436,7 @@ var CPStringHashes = new objj_dictionary();
return aString && aString != "" && lastIndexOf(aString) == (length - aString.length);
}
/*
/*!
Returns <code>YES</code> if the specified string contains the same characters as the receiver.
*/
- (BOOL)isEqualToString:(CPString)aString
@@ -444,7 +444,7 @@ var CPStringHashes = new objj_dictionary();
return self == aString;
}
/*
/*!
Returns a hash of the string instance.
*/
- (unsigned)hash
@@ -460,7 +460,7 @@ var CPStringHashes = new objj_dictionary();
return hash;
}
/*
/*!
Returns a copy of the receiver with all the first letters of words capitalized.
*/
- (CPString)capitalizedString
@@ -476,7 +476,7 @@ var CPStringHashes = new objj_dictionary();
return parts.join("");
}
/*
/*!
Returns a copy of the string with all its characters made lower case.
*/
- (CPString)lowercaseString
@@ -484,7 +484,7 @@ var CPStringHashes = new objj_dictionary();
return toLowerCase();
}
/*
/*!
Returns a copy of the string with all its characters made upper case.
*/
- (CPString)uppercaseString
@@ -492,14 +492,14 @@ var CPStringHashes = new objj_dictionary();
return toUpperCase();
}
/*
/*!
Returns the text as a floating point value.
*/
- (double)doubleValue
{
return parseFloat(self, 10);
}
/*
/*!
Returns <code>YES</code> on encountering one of "Y", "y", "T", "t", or
a digit 1-9. Returns <code>NO</code> otherwise. This method skips the initial
whitespace characters, +,- followed by Zeroes.
@@ -511,7 +511,7 @@ var CPStringHashes = new objj_dictionary();
return RegExp("^[Y,y,t,T,1-9]").test(self.replace(replaceRegExp, ''));
}
/*
/*!
Returns the text as a float point value.
*/
- (float)floatValue
@@ -519,7 +519,7 @@ var CPStringHashes = new objj_dictionary();
return parseFloat(self, 10);
}
/*
/*!
Returns the text as an integer
*/
- (int)intValue
@@ -527,7 +527,7 @@ var CPStringHashes = new objj_dictionary();
return parseInt(self, 10);
}
/*
/*!
Returns an the path components of this string. This
method assumes that the string's content is a '/'
separated file system path.
@@ -537,7 +537,7 @@ var CPStringHashes = new objj_dictionary();
return split('/');
}
/*
/*!
Returns the extension of the file denoted by this string.
The '.' is not a part of the extension. This method assumes
that the string's contents is the path to a file or just a filename.
@@ -547,7 +547,7 @@ var CPStringHashes = new objj_dictionary();
return substr(lastIndexOf('.') + 1);
}
/*
/*!
Returns the last component of this string.
This method assumes that the string's content is a '/'
separated file system path.
@@ -558,7 +558,7 @@ var CPStringHashes = new objj_dictionary();
return components[components.length -1];
}
/*
/*!
Until this is corrected
@ignore
*/
@@ -589,10 +589,10 @@ String.prototype.isa = CPString;
var sprintfFormatRegex = new RegExp("([^%]+|%[\\+\\-\\ \\#0]*[0-9\\*]*(.[0-9\\*]+)?[hlL]?[cdieEfgGosuxXpn%])", "g");
var sprintfTagRegex = new RegExp("(%)([\\+\\-\\ \\#0]*)([0-9\\*]*)((.[0-9\\*]+)?)([hlL]?)([cdieEfgGosuxXpn%])");
/*
/*!
Creates a new string using C printf-style formatting. First argument should be a constant format string, like ' "float val = %f" ', remaining arguments should be the variables to print the values of, comma-separated.
@param format the format to be used, printf-style
@return the initialized <objj>CPString</objj>
@return the initialized CPString
*/
function sprintf(format)
{
Foundation/CPURLRequest.j
+15 -15
View File
@@ -22,8 +22,8 @@
import "CPObject.j"
/*
A helper object for <objj>CPURLConnection</objj>, that contains
/*! @class CPURLRequest
A helper object for CPURLConnection, that contains
data obtained during the life of a request.
*/
@implementation CPURLRequest : CPObject
@@ -36,20 +36,20 @@ import "CPObject.j"
CPDictionary _HTTPHeaderFields;
}
/*
/*!
Creates a request with a specified URL.
@param aURL the URL of the request
@return a <objj>CPURLRequest</objj>
@return a CPURLRequest
*/
+ (id)requestWithURL:(CPURL)aURL
{
return [[CPURLRequest alloc] initWithURL:aURL];
}
/*
/*!
Initializes the request with a URL.
@param aURL the url to set
@return the initialized <objj>CPURLRequest</objj>
@return the initialized CPURLRequest
*/
- (id)initWithURL:(CPURL)aURL
{
@@ -69,7 +69,7 @@ import "CPObject.j"
return self;
}
/*
/*!
Returns the request URL
*/
- (CPURL)URL
@@ -77,7 +77,7 @@ import "CPObject.j"
return _URL;
}
/*
/*!
Sets the URL for this request.
@param aURL the new URL
*/
@@ -86,7 +86,7 @@ import "CPObject.j"
_URL = aURL;
}
/*
/*!
Sets the HTTP body for this request
@param anHTTPBody the new HTTP body
*/
@@ -95,7 +95,7 @@ import "CPObject.j"
_HTTPBody = anHTTPBody;
}
/*
/*!
Returns the request's http body.
*/
- (CPString)HTTPBody
@@ -103,7 +103,7 @@ import "CPObject.j"
return _HTTPBody;
}
/*
/*!
Sets the request's http method.
@param anHTPPMethod the new http method
*/
@@ -112,7 +112,7 @@ import "CPObject.j"
_HTTPMethod = anHTTPMethod;
}
/*
/*!
Returns the request's http method
*/
- (CPString)HTTPMethod
@@ -120,7 +120,7 @@ import "CPObject.j"
return _HTTPMethod;
}
/*
/*!
Returns a dictionar of the http header fields
*/
- (CPDictionary)allHTTPHeaderFields
@@ -128,7 +128,7 @@ import "CPObject.j"
return _HTTPHeaderFields;
}
/*
/*!
Returns the value for the specified header field.
@param aField the header field to obtain a value for
*/
@@ -137,7 +137,7 @@ import "CPObject.j"
return [_HTTPHeaderFields objectForKey:aField];
}
/*
/*!
Sets the value for the specified header field.
@param aValue the value for the header field
@param aField the header field
Foundation/CPURLResponse.j
+3 -3
View File
@@ -29,7 +29,7 @@ import "CPObject.j"
unsigned _expectedContentLength;
CPString _textEncodingName;
*/
/*
/*!
Contains protocol agnostic information about a request to a specific URL.
*/
@implementation CPURLResponse : CPObject
@@ -47,7 +47,7 @@ Getting the Response Properties
*/
@end
/*
/*!
Represents the response to an http request.
*/
@implementation CPHTTPURLResponse : CPURLResponse
@@ -66,7 +66,7 @@ Getting the Response Properties
return self;
}
/*
/*!
Returns the HTTP status code.
*/
- (int)statusCode
Foundation/CPUndoManager.j
+30 -30
View File
@@ -150,8 +150,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
@end
/*
<objj>CPUndoManager</objj> provides a general mechanism supporting implementation of user action "undo" in applications. Essentially, it allows you to store sequences of messages and receivers that need to be invoked to undo or redo an action. The various methods in this class provide for grouping of sets of actions, execution of undo or redo actions, and tuning behavior parameters such as the size of the undo stack. Each application entity with its own editing history (e.g., a document) should have its own undo manager instance. Obtain an instance through a simple <code>[[CPUndoManager alloc] init]</code> message.
/*! @class CPUndoManager
CPUndoManager provides a general mechanism supporting implementation of user action "undo" in applications. Essentially, it allows you to store sequences of messages and receivers that need to be invoked to undo or redo an action. The various methods in this class provide for grouping of sets of actions, execution of undo or redo actions, and tuning behavior parameters such as the size of the undo stack. Each application entity with its own editing history (e.g., a document) should have its own undo manager instance. Obtain an instance through a simple <code>[[CPUndoManager alloc] init]</code> message.
*/
@implementation CPUndoManager : CPObject
{
@@ -170,7 +170,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
BOOL _registeredWithRunLoop;
}
/*
/*!
Initializes the undo manager
@return the initialized undo manager
*/
@@ -194,7 +194,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Registering Undo Operations
/*
/*!
Registers an undo operation. You invoke this method with the target of the undo action providing the selector which can perform the undo with the provided object. The object is often a dictionary of the identifying the attribute and their values before the change. The invocation will be added to the current grouping. If the registrations have been disabled through <code>-disableUndoRegistration</code>, this method does nothing.
@param aTarget the target for the undo invocation
@param aSelector the selector for the action message
@@ -222,7 +222,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
if (_state == CPUndoManagerNormal)
[_redoStack removeAllObjects];
}
/*
/*!
Prepares the specified target for the undo action.
@param aTarget the target to receive the action
@return the undo manager
@@ -246,7 +246,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return nil;//[_preparedTarget methodSignatureForSelector:selector];
}
/*
/*!
Records the specified invocation as an undo operation. Sets the
target on the invocation, and adds it to the current grouping.
@param anInvocation the message to record
@@ -273,7 +273,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Checking Undo Ability
/*
/*!
Returns <code>YES</code> if the user can perform a redo operation.
*/
- (BOOL)canRedo
@@ -281,7 +281,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return _redoStack.length > 0;
}
/*
/*!
Returns <code>YES</code> if the user can perform an undo operation.
*/
- (BOOL)canUndo
@@ -293,7 +293,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Preform Undo and Redo
/*
/*!
Ends the current grouping, and performs an 'undo' operation.
*/
- (void)undo
@@ -304,7 +304,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
[self undoNestedGroup];
}
/*
/*!
Performs an undo on the last undo group.
*/
- (void)undoNestedGroup
@@ -333,7 +333,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
[defaultCenter postNotificationName:CPUndoManagerDidUndoChangeNotification object:self];
}
/*
/*!
Performs the redo operation using the last grouping on the redo stack.
*/
- (void)redo
@@ -372,7 +372,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Creating Undo Groups
/*
/*!
Starts a new grouping of undo tasks, and makes it the current grouping.
*/
- (void)beginUndoGrouping
@@ -380,7 +380,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
_currentGrouping = [_CPUndoGrouping undoGroupingWithParent:_currentGrouping];
}
/*
/*!
Closes the current undo grouping.
@throws CPInternalInconsistencyException if no undo group is open
*/
@@ -418,9 +418,9 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
_currentGrouping = parent;
}
/*
/*!
Enables undo registrations. Calls to this method must
be balanced with calls to <objj>disableUndoRegistration</objj>.
be balanced with calls to disableUndoRegistration.
So, if two disable calls were made, two enable calls are required
to actually enable undo registration again.
*/
@@ -433,7 +433,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
_disableCount--;
}
/*
/*!
Returns <code>YES</code> if the manager groups undo operations at every iteration of the run loop.
*/
- (BOOL)groupsByEvent
@@ -441,7 +441,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return _groupsByEvent;
}
/*
/*!
Sets whether the manager should group undo operations at every iteration of the run loop.
@param aFlag <code>YES</code> groups undo operations
*/
@@ -465,7 +465,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
[self _unregisterWithRunLoop];
}
/*
/*!
Returns the number of undo/redo groups.
*/
- (unsigned)groupingLevel
@@ -480,7 +480,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Disabling Undo
/*
/*!
Disables undo registrations.
*/
- (void)disableUndoRegistration
@@ -488,7 +488,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
++_disableCount;
}
/*
/*!
Returns <code>YES</code> if undo registration is enabled.
*/
- (BOOL)isUndoRegistrationEnabled
@@ -497,7 +497,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Checking Whether Undo or Redo Is Being Performed
/*
/*!
Returns <code>YES</code> if the manager is currently performing an undo.
*/
- (BOOL)isUndoing
@@ -505,7 +505,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return _state == CPUndoManagerUndoing;
}
/*
/*!
Returns <code>YES</code> if the manager is currently performing a redo.
*/
- (BOOL)isRedoing
@@ -514,7 +514,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Clearing Undo Operations
/*
/*!
Clears all redo and undo operations and enables undo registrations.
*/
- (void)removeAllActions
@@ -524,7 +524,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
_disableCount = 0;
}
/*
/*!
Removes any redo and undo operations that use the specified target.
@param aTarget the target for which operations should be removed.
*/
@@ -558,7 +558,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Managing the Action Name
/*
/*!
Sets the name associated with the actions of the current group.
Typically, you can call this method while registering the actions for the current group.
@param anActionName the new name for the current group
@@ -568,7 +568,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
_actionName = anActionName;
}
/*
/*!
If the receiver can perform a redo, this method returns the action
name previously associated with the top grouping with
<code>-setActionName:</code>. This name should identify the action to be redone.
@@ -579,7 +579,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return [self canRedo] ? _actionName : nil;
}
/*
/*!
If the receiver can perform an undo, this method returns the action
name previously associated with the top grouping with
<code>-setActionName:</code>. This name should identify the action to be undone.
@@ -591,8 +591,8 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
}
// Working With Run Loops
/*
Returns the <objj>CPRunLoopMode</objj>s in which the receiver registers
/*!
Returns the CPRunLoopModes in which the receiver registers
the <code>-endUndoGrouping</code> processing when it <code>-groupsByEvent</code>.
*/
- (CPArray)runLoopModes
@@ -600,7 +600,7 @@ var _CPUndoGroupingParentKey = @"_CPUndoGroupingParentKey",
return _runLoopModes;
}
/*
/*!
Sets the modes in which the receiver registers the calls
with the current run loop to invoke <code>-endUndoGrouping</code>
when it <code>-groupsByEvent</code>. This method first
Foundation/CPValue.j
+9 -9
View File
@@ -23,7 +23,7 @@
import "CPObject.j"
import "CPCoder.j"
/*
/*! @class CPValue
The class can be subclassed to hold different types of scalar values.
*/
@implementation CPValue : CPObject
@@ -31,20 +31,20 @@ import "CPCoder.j"
JSObject _JSObject;
}
/*
/*!
Creates a value from the specified JavaScript object
@param aJSObject a JavaScript object containing a value
@return the converted <objj>CPValue</objj>
@return the converted CPValue
*/
+ (id)valueWithJSObject:(JSObject)aJSObject
{
return [[self alloc] initWithJSObject:aJSObject];
}
/*
/*!
Initializes the value from a JavaScript object
@param aJSObject the object to get data from
@return the initialized <objj>CPValue</objj>
@return the initialized CPValue
*/
- (id)initWithJSObject:(JSObject)aJSObject
{
@@ -56,7 +56,7 @@ import "CPCoder.j"
return self;
}
/*
/*!
Returns the JavaScript object backing this value.
*/
- (JSObject)JSObject
@@ -70,10 +70,10 @@ var CPValueValueKey = @"CPValueValueKey";
@implementation CPValue (CPCoding)
/*
/*!
Initializes the value from a coder.
@param aCoder the coder from which to initialize
@return the initialized <objj>CPValue</objj>
@return the initialized CPValue
*/
- (id)initWithCoder:(CPCoder)aCoder
{
@@ -85,7 +85,7 @@ var CPValueValueKey = @"CPValueValueKey";
return self;
}
/*
/*!
Encodes the data into the specified coder.
@param the coder into which the data will be written.
*/