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

Cleaned up old deprecated documentation stuff and added documentation to deploy.

Browse Source 
Reviewed by me.
This commit is contained in:
Francisco Ryan Tolmasky I
2008-12-10 15:57:31 -08:00
parent b87493bd5f
commit d92fc8c4d0
47 changed files with 255 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AppKit/CPAnimation.j
+1 -1
View File
@@ -68,7 +68,7 @@ ACTUAL_FRAME_RATE = 0;
@param animation the animation that was stopped
@delegate - (float)animation:(CPAnimation)animation valueForProgress:(float)progress;
The value from this method will be returned when <objj>CPAnimation</objj>'s
The value from this method will be returned when CPAnimation's
<code>currentValue</code> method is called.
@param animation the animation to obtain the curve value for
@param progress the current animation progress
AppKit/CPApplication.j
+4 -4
View File
@@ -230,7 +230,7 @@ CPRunContinuesResponse = -1002;
/*!
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
CPApplicationDidFinishLaunchingNotification. If you override
<code>finishLaunching</code>, the subclass method should invoke the superclass method.
*/
- (void)finishLaunching
@@ -437,7 +437,7 @@ CPRunContinuesResponse = -1002;
}
/*!
Returns the <objj>CPWindow</objj> object corresponding to <code>aWindowNumber</code>.
Returns the CPWindow object corresponding to <code>aWindowNumber</code>.
*/
- (CPWindow)windowWithWindowNumber:(int)aWindowNumber
{
@@ -445,7 +445,7 @@ CPRunContinuesResponse = -1002;
}
/*!
Returns an array of the application's <objj>CPWindow</objj>s
Returns an array of the application's CPWindows
*/
- (CPArray)windows
{
@@ -599,7 +599,7 @@ CPRunContinuesResponse = -1002;
<ol>
<li>a responder from the key window</li>
<li>a responder frmo the main window</li>
<li>the <objj>CPApplication</objj> instance</li>
<li>the CPApplication instance</li>
<li>the application delegate</li>
<li>the document controller</li>
</ol>
AppKit/CPButton.j
+4 -4
View File
@@ -222,7 +222,7 @@ var _CPButtonClassName = nil,
/*! @class CPButton
<objj>CPButton</objj> is a subclass of <objj>CPControl</objj> that
CPButton is a subclass of CPControl that
intercepts mouse-down events and sends an action message to a
target object when it's clicked or pressed.
*/
@@ -252,7 +252,7 @@ var _CPButtonClassName = nil,
}
/*!
Initializes the <objj>CPButton</objj> class.
Initializes the CPButton class.
@ignore
*/
+ (void)initialize
@@ -437,7 +437,7 @@ var _CPButtonClassName = nil,
/*!
Sets the button's state to <code>aState</code>.
@param aState Possible states are any of the <objj>CPButton</objj> globals:
@param aState Possible states are any of the CPButton globals:
<code>CPOffState, CPOnState, CPMixedState</code>
*/
- (void)setState:(int)aState
@@ -830,7 +830,7 @@ var CPButtonImageKey = @"CPButtonImageKey",
/*!
Initializes the button by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPButton</objj>.
@param aCoder the coder containing the archived CPButton.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
AppKit/CPClipView.j
+4 -4
View File
@@ -27,8 +27,8 @@
/*! @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>.
CPClipView 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 CPScrollView.
*/
@implementation CPClipView : CPView
{
@@ -134,7 +134,7 @@
}
/*!
Handles a <objj>CPViewBoundsDidChangeNotification</objj>.
Handles a CPViewBoundsDidChangeNotification.
@param aNotification the notification event
*/
- (void)viewBoundsChanged:(CPNotification)aNotification
@@ -143,7 +143,7 @@
}
/*!
Handles a <objj>CPViewFrameDidChangeNotification</objj>.
Handles a CPViewFrameDidChangeNotification.
@param aNotification the notification event
*/
- (void)viewFrameChanged:(CPNotification)aNotification
AppKit/CPCollectionView.j
+2 -2
View File
@@ -57,7 +57,7 @@
Invoked to obtain the data types supported by the specified indices for placement on the pasteboard.
@param collectionView the collection view the items reside in
@param indices the indices to obtain drag types
@return an array of drag types (<objj>CPString</objj>)
@return an array of drag types (CPString)
*/
@implementation CPCollectionView : CPView
{
@@ -567,7 +567,7 @@
@end
/*!
Represents an object inside a <objj>CPCollectionView</objj>.
Represents an object inside a CPCollectionView.
*/
@implementation CPCollectionViewItem : CPObject
{
AppKit/CPColor.j
+3 -3
View File
@@ -48,7 +48,7 @@ var _hueComponent = 0,
<p>The class does not have a <code>set:</code> method
like NextStep based frameworks to change the color of
the current context. To change the color of the current
context, use <objj>CGContextSetFillColor()</objj>.
context, use CGContextSetFillColor().
*/
@implementation CPColor : CPObject
{
@@ -227,7 +227,7 @@ var _hueComponent = 0,
}
/*!
Creates a <objj>CPColor</objj> from a valid CSS RGB string. Example, "rgb(32,64,129)".
Creates a CPColor from a valid CSS RGB string. Example, "rgb(32,64,129)".
@param aString a CSS color string
@return a color initialized to the value in the css string
@@ -511,7 +511,7 @@ var CPColorComponentsKey = @"CPColorComponentsKey",
var hexCharacters = "0123456789ABCDEF";
/*!
Used for the <objj>CPColor</objj> <code>colorWithHexString:</code> implementation
Used for the CPColor <code>colorWithHexString:</code> implementation
@ignore
@class CPColor
@return an array of rgb components
AppKit/CPColorPicker.j
+1 -1
View File
@@ -25,7 +25,7 @@
/*! @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.
CPColorPicker is an abstract superclass for all color picker subclasses. If you want a particular color picker, use CPColorPanel's <code>setPickerMode:</code> method. The simplest way to implement your own color picker is to create a subclass of CPColorPicker.
*/
@implementation CPColorPicker : CPObject
{
AppKit/CPColorWell.j
+4 -4
View File
@@ -31,9 +31,9 @@ var _CPColorWellDidBecomeExclusiveNotification = @"_CPColorWellDidBecomeExclusiv
/*! @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>
CPColorWell is a CPControl for selecting and displaying a single color value. An example of a CPColorWell object (or simply color well) is found in CPColorPanel, 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.
<p>An application can have one or more active CPColorWells. You can activate multiple CPColorWells by invoking the <code>activate:</code> method with <code>NO</code> as its argument. When a mouse-down event occurs on an CPColorWell's border, it becomes the only active color well. When a color well becomes active, it brings up the color panel also.
*/
@implementation CPColorWell : CPControl
{
@@ -136,7 +136,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.
If exclusive is <code>YES</code>, deactivates any other CPColorWells. <code>NO</code>, keeps them active.
@param shouldBeExclusive whether other color wells should be deactivated.
*/
- (void)activate:(BOOL)shouldBeExclusive
@@ -262,7 +262,7 @@ var CPColorWellColorKey = "CPColorWellColorKey",
/*!
Initializes the color well by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPColorWell</objj>.
@param aCoder the coder containing the archived CPColorWell.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
AppKit/CPControl.j
+1 -1
View File
@@ -82,7 +82,7 @@ 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.
CPControl is an abstract superclass used to implement user interface elements. As a subclass of CPView and CPResponder it has the ability to handle screen drawing and handling user input.
*/
@implementation CPControl : CPView
{
AppKit/CPCookie.j
+1 -1
View File
@@ -25,7 +25,7 @@
/*! @class CPCookie
<objj>CPCookie</objj> is the Cappuccino interface to a web browser cookie. You can set the name
CPCookie is the Cappuccino interface to a web browser cookie. You can set the name
*/
@implementation CPCookie : CPObject
{
AppKit/CPDocument.j
+5 -5
View File
@@ -82,10 +82,10 @@ var CPDocumentUntitledCount = 0;
/*! @class CPDocument
<objj>CPDocument</objj> is used to represent a document/file in a Cappuccino application.
CPDocument 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
<objj>CPDocument</objj>s should be used to represent this.
CPDocuments should be used to represent this.
*/
@implementation CPDocument : CPResponder
{
@@ -543,7 +543,7 @@ var CPDocumentUntitledCount = 0;
// Working with Undo Manager
/*!
Returns <code>YES</code> if the document has a
<objj>CPUndoManager</objj>.
CPUndoManager.
*/
- (BOOL)hasUndoManager
{
@@ -551,7 +551,7 @@ var CPDocumentUntitledCount = 0;
}
/*!
Sets whether the document should have a <objj>CPUndoManager</objj>.
Sets whether the document should have a CPUndoManager.
@param aFlag <code>YES</code> makes the document have an undo manager
*/
- (void)setHasUndoManager:(BOOL)aFlag
@@ -649,7 +649,7 @@ var CPDocumentUntitledCount = 0;
}
/*
Implemented as a delegate of a <objj>CPWindow</objj>
Implemented as a delegate of a CPWindow
@ignore
*/
- (CPUndoManager)windowWillReturnUndoManager:(CPWindow)aWindow
AppKit/CPDocumentController.j
+2 -2
View File
@@ -40,7 +40,7 @@ var CPSharedDocumentController = nil;
/*!
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>
@return a CPDocumentController
*/
+ (id)sharedDocumentController
{
@@ -294,7 +294,7 @@ var CPSharedDocumentController = nil;
}
/*!
Returns the <objj>CPDocument</objj> subclass associated with <code>aType</code>.
Returns the CPDocument 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
+1 -1
View File
@@ -116,7 +116,7 @@ var CPDragServerUpdateDragging = function(anEvent)
}
/*
<objj>CPDraggingInfo</objj> is a container of information about a specific dragging session.
CPDraggingInfo is a container of information about a specific dragging session.
@ignore
*/
@implementation CPDraggingInfo : CPObject
AppKit/CPEvent.j
+11 -11
View File
@@ -180,7 +180,7 @@ var _CPEventPeriodicEventPeriod = 0,
_CPEventPeriodicEventTimer = nil;
/*! @class CPEvent
<objj>CPEvent</objj> encapsulates the details of a Cappuccino keyboard or mouse event.
CPEvent encapsulates the details of a Cappuccino keyboard or mouse event.
*/
@implementation CPEvent : CPObject
{
@@ -206,18 +206,18 @@ var _CPEventPeriodicEventPeriod = 0,
/*!
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 anEventType the event type. Must be one of CPKeyDown, CPKeyUp or CPFlagsChanged
@param aPoint the location of the cursor in the window specified by <code>aWindowNumber</code>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> globals
@param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals
@param aTimestamp the time the event occurred
@param aWindowNumber the number of the <objj>CPWindow</objj> where the event occurred
@param aWindowNumber the number of the CPWindow where the event occurred
@param aGraphicsContext the graphics context where the event occurred
@param characters the characters associated with the event
@param unmodCharacters the string of keys pressed without the presence of any modifiers other than Shift
@param repeatKey <code>YES</code> if this is caused by the system repeat as opposed to the user pressing the key again
@param code a number associated with the keyboard key of this event
@throws CPInternalInconsistencyException if <code>anEventType</code> is not a <objj>CPKeyDown</objj>,
<objj>CPKeyUp</objj> or <objj>CPFlagsChanged</objj>
@throws CPInternalInconsistencyException if <code>anEventType</code> is not a CPKeyDown,
CPKeyUp or CPFlagsChanged
@return the keyboard event
*/
+ (CPEvent)keyEventWithType:(CPEventType)anEventType location:(CGPoint)aPoint modifierFlags:(unsigned int)modifierFlags
@@ -233,9 +233,9 @@ var _CPEventPeriodicEventPeriod = 0,
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>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> globals
@param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals
@param aTimestamp the time the event occurred
@param aWindowNumber the number of the <objj>CPWindow</objj> where the event occurred
@param aWindowNumber the number of the CPWindow where the event occurred
@param aGraphicsContext the graphics context where the event occurred
@param anEventNumber a number for this event
@param aClickCount the number of clicks that caused this event
@@ -253,11 +253,11 @@ var _CPEventPeriodicEventPeriod = 0,
/*!
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 anEventType the event type. Must be one of CPAppKitDefined, CPSystemDefined, CPApplicationDefined or CPPeriodic
@param aLocation the location of the cursor in the window specified by <code>aWindowNumber</code>
@param modifierFlags a bitwise combination of the modifiers specified in the <objj>CPEvent</objj> globals
@param modifierFlags a bitwise combination of the modifiers specified in the CPEvent globals
@param aTimestamp the time the event occurred
@param aWindowNumber the number of the <objj>CPWindow</objj> where the event occurred
@param aWindowNumber the number of the CPWindow where the event occurred
@param aGraphicsContext the graphics context where the event occurred
@param aSubtype a numeric identifier to differentiate this event from other custom events
@param aData1 more data that describes the event
AppKit/CPFont.j
+1 -1
View File
@@ -27,7 +27,7 @@ var _CPFonts = {};
/*! @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>.
The CPFont 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 CPFont.
*/
@implementation CPFont : CPObject
{
AppKit/CPGeometry.j
+39 -39
View File
@@ -206,8 +206,8 @@ function CPSizeMake(width, height)
}
/*!
Returns <code>YES</code> if the <objj>CGRect</objj>, <code>aRect</code>, contains
the <objj>CGPoint</objj>, <code>aPoint</code>.
Returns <code>YES</code> if the CGRect, <code>aRect</code>, contains
the CGPoint, <code>aPoint</code>.
@param aRect the rectangle to test with
@param aPoint the point to test with
@group CGRect
@@ -222,11 +222,11 @@ function CPRectContainsPoint(aRect, aPoint)
}
/*!
Returns a <code>BOOL</code> indicating whether <objj>CGRect</objj> <code>possibleOuter</code>
contains <objj>CGRect</objj> <code>possibleInner</code>.
Returns a <code>BOOL</code> indicating whether CGRect <code>possibleOuter</code>
contains CGRect <code>possibleInner</code>.
@group CGRect
@param possibleOuter the <objj>CGRect</objj> to test if <code>possibleInner</code> is inside of
@param possibleInner the <objj>CGRect</objj> to test if it fits inside <code>possibleOuter</code>.
@param possibleOuter the CGRect to test if <code>possibleInner</code> is inside of
@param possibleInner the CGRect to test if it fits inside <code>possibleOuter</code>.
@return BOOL <code>YES</code> if <code>possibleInner</code> fits inside <code>possibleOuter</code>.
*/
function CPRectContainsRect(lhsRect, rhsRect)
@@ -235,11 +235,11 @@ function CPRectContainsRect(lhsRect, rhsRect)
}
/*!
Tests whether the two <objj>CGPoint</objj>s are equal to each other by comparing their
Tests whether the two CGPoints are equal to each other by comparing their
<code>x</code> and <code>y</code> members.
@group @CGPoint
@param lhsPoint the first <objj>CGPoint</objj> to check
@param rhsPoint the second <objj>CGPoint</objj> to check
@param lhsPoint the first CGPoint to check
@param rhsPoint the second CGPoint to check
@return BOOL <code>YES</code> if the two points have the same x's, and the same y's.
*/
function CPPointEqualToPoint(lhsPoint, rhsPoint)
@@ -248,10 +248,10 @@ function CPPointEqualToPoint(lhsPoint, rhsPoint)
}
/*!
Test whether the two <objj>CGRect</objj>s have the same origin and size
Test whether the two CGRects have the same origin and size
@group CGRect
@param lhsRect the first <objj>CGRect</objj> to compare
@param rhsRect the second <objj>CGRect</objj> to compare
@param lhsRect the first CGRect to compare
@param rhsRect the second CGRect to compare
@return BOOL <code>YES</code> if the two rectangles have the same origin and size. <code>NO</code>, otherwise.
*/
function CPRectEqualToRect(lhsRect, rhsRect)
@@ -262,7 +262,7 @@ function CPRectEqualToRect(lhsRect, rhsRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetHeight(aRect)
@@ -272,7 +272,7 @@ function CPRectGetHeight(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetMaxX(aRect)
@@ -282,7 +282,7 @@ function CPRectGetMaxX(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetMaxY(aRect)
@@ -292,7 +292,7 @@ function CPRectGetMaxY(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return float
*/
function CPRectGetMidX(aRect)
@@ -302,7 +302,7 @@ function CPRectGetMidX(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return float
*/
function CPRectGetMidY(aRect)
@@ -312,7 +312,7 @@ function CPRectGetMidY(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetMinX(aRect)
@@ -322,7 +322,7 @@ function CPRectGetMinX(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetMinY(aRect)
@@ -332,7 +332,7 @@ function CPRectGetMinY(aRect)
/*!
@group CGRect
@param aRect a <objj>CGRect</objj>
@param aRect a CGRect
@return int
*/
function CPRectGetWidth(aRect)
@@ -343,8 +343,8 @@ function CPRectGetWidth(aRect)
/*!
Returns <code>YES</code> if the two rectangles intersect
@group CGRect
@param lhsRect the first <objj>CGRect</objj>
@param rhsRect the second <objj>CGRect</objj>
@param lhsRect the first CGRect
@param rhsRect the second CGRect
@return BOOL <code>YES</code> if the two rectangles have any common spaces, and <code>NO</code>, otherwise.
*/
function CPRectIntersectsRect(lhsRect, rhsRect)
@@ -353,11 +353,11 @@ function CPRectIntersectsRect(lhsRect, rhsRect)
}
/*!
Returns <code>YES</code> if the <objj>CGRect</objj> has no area.
Returns <code>YES</code> if the CGRect has no area.
The test is performed by checking if the width and height are both zero.
@group CGRect
@param aRect the <objj>CGRect</objj> to test
@return BOOL <code>YES</code> if the <objj>CGRect</objj> has no area, and <code>NO</code>, otherwise.
@param aRect the CGRect to test
@return BOOL <code>YES</code> if the CGRect has no area, and <code>NO</code>, otherwise.
*/
function CPRectIsEmpty(aRect)
{
@@ -365,10 +365,10 @@ function CPRectIsEmpty(aRect)
}
/*!
Returns <code>YES</code> if the <objj>CGRect</objj> has no area.
Returns <code>YES</code> if the CGRect has no area.
The test is performed by checking if the width and height are both zero.
@group CGRect
@return BOOL <code>YES</code> if the <objj>CGRect</objj> has no area, and <code>NO</code>, otherwise.
@return BOOL <code>YES</code> if the CGRect has no area, and <code>NO</code>, otherwise.
*/
function CPRectIsNull(aRect)
{
@@ -376,10 +376,10 @@ function CPRectIsNull(aRect)
}
/*!
Returns <code>YES</code> if the two <objj>CGSize</objj>s are identical.
Returns <code>YES</code> if the two CGSizes are identical.
@group CGSize
@param lhsSize the first <objj>CGSize</objj> to compare
@param rhsSize the second <objj>CGSize</objj> to compare
@param lhsSize the first CGSize to compare
@param rhsSize the second CGSize to compare
@return BOOL <code>YES</code> if the two sizes are identical. <code>NO</code>, otherwise.
*/
function CPSizeEqualToSize(lhsSize, rhsSize)
@@ -388,10 +388,10 @@ function CPSizeEqualToSize(lhsSize, rhsSize)
}
/*!
Returns a human readable string of the provided <objj>CGPoint</objj>.
Returns a human readable string of the provided CGPoint.
@group CGPoint
@param aPoint the point to represent
@return CGPoint a string representation of the <objj>CGPoint</objj>
@return CGPoint a string representation of the CGPoint
*/
function CPStringFromPoint(aPoint)
{
@@ -399,10 +399,10 @@ function CPStringFromPoint(aPoint)
}
/*!
Returns a human readable string of the provided <objj>CGSize</objj>.
Returns a human readable string of the provided CGSize.
@group CGSize
@param aSize the size to represent
@return CGSize a string representation of the <objj>CGSize</objj>
@return CGSize a string representation of the CGSize
*/
function CPStringFromSize(aSize)
{
@@ -410,7 +410,7 @@ function CPStringFromSize(aSize)
}
/*!
Returns a human readable string of the provided <objj>CGRect</objj>.
Returns a human readable string of the provided CGRect.
@group CGRect
@param aRect the rectangle to represent
@return CGString the string representation of the rectangle
@@ -421,7 +421,7 @@ function CPStringFromRect(aRect)
}
/*!
Returns a <objj>CGPoint</objj> from a string with a comma separated pair of integers.
Returns a CGPoint from a string with a comma separated pair of integers.
@group CGPoint
@param aString a string containing two comma separated integers
@return CGPoint the point object created from the string
@@ -434,7 +434,7 @@ function CPPointFromString(aString)
}
/*!
Returns a <objj>CGSize</objj> from a string containing a pair of comma separated integers.
Returns a CGSize from a string containing a pair of comma separated integers.
@group CGSize
@param aString a string containing two comma separated integers
@return CGSize the size object created from the string
@@ -447,7 +447,7 @@ function CPSizeFromString(aString)
}
/*!
Returns a <objj>CGRect</objj> created from a string.
Returns a CGRect created from a string.
@group CGRect
@param aString a string in the form generated by <code>CPStringFromRect</code>
@return CGRect the rectangle created from the string
@@ -470,7 +470,7 @@ function CPPointFromEvent(anEvent)
}
/*!
Returns a zero sized <objj>CGSize</objj>.
Returns a zero sized CGSize.
@group CGSize
@return CGSize a size object with zeros for <code>width</code> and <code>height</code>
*/
AppKit/CPImage.j
+1 -1
View File
@@ -49,7 +49,7 @@ CPImageDidLoadNotification = @"CPImageDidLoadNotification";
/*! @class CPImage
<objj>CPImage</objj> is used to represent images in the Cappuccino framework. It supports loading
CPImage is used to represent images in the Cappuccino framework. It supports loading
all image types supported by the browser.
@par Delegate Methods
AppKit/CPMenu.j
+6 -6
View File
@@ -368,7 +368,7 @@ var _CPMenuBarVisible = NO,
/*!
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>
@return the item index or CPNotFound
*/
- (int)indexOfItem:(CPMenuItem)aMenuItem
{
@@ -381,7 +381,7 @@ var _CPMenuBarVisible = NO,
/*!
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>
@return the index of the item or CPNotFound
*/
- (int)indexOfItemWithTitle:(CPString)aTitle
{
@@ -398,7 +398,7 @@ var _CPMenuBarVisible = NO,
/*!
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>
@return the index of the item or CPNotFound
*/
- (int)indexOfItemWithTag:(int)aTag
{
@@ -416,7 +416,7 @@ var _CPMenuBarVisible = NO,
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
@return the index of the item or <objj>CPNotFound</objj>
@return the index of the item or CPNotFound
*/
- (int)indexOfItemWithTarget:(id)aTarget andAction:(SEL)anAction
{
@@ -437,7 +437,7 @@ var _CPMenuBarVisible = NO,
/*!
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>
@return the index of the item or CPNotFound
*/
- (int)indexOfItemWithRepresentedObject:(id)anObject
{
@@ -454,7 +454,7 @@ var _CPMenuBarVisible = NO,
/*!
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>
@return the index of the item or CPNotFound
*/
- (int)indexOfItemWithSubmenu:(CPMenu)aMenu
{
AppKit/CPMenuItem.j
+15 -15
View File
@@ -30,7 +30,7 @@
/*! @class CPMenuItem
A <objj>CPMenuItem</objj> is added to a <objj>CPMenu</objj>.
A CPMenuItem is added to a CPMenu.
It has an action and a target for that action to be sent to
whenever the item is 'activated'.
*/
@@ -284,9 +284,9 @@
/*!
Sets the state of the menu item. Possible states are:
<pre>
<objj>CPMixedState</objj>
<objj>CPOnState</objj>
<objj>CPOffState</objj>
CPMixedState
CPOnState
CPOffState
</pre>
*/
- (void)setState:(int)aState
@@ -304,9 +304,9 @@
/*!
Returns the menu item's current state. Possible states are:
<pre>
<objj>CPMixedState</objj>
<objj>CPOnState</objj>
<objj>CPOffState</objj>
CPMixedState
CPOnState
CPOffState
</pre>
*/
- (int)state
@@ -520,10 +520,10 @@
Sets the modifier mask used for the item's keyboard shortcut.
Can be a combination of:
<pre>
<objj>CPShiftKeyMask</objj>
<objj>CPAlternateKeyMask</objj>
<objj>CPCommandKeyMask</objj>
<objj>CPControlKeyMask</objj>
CPShiftKeyMask
CPAlternateKeyMask
CPCommandKeyMask
CPControlKeyMask
</pre>
*/
- (void)setKeyEquivalentModifierMask:(unsigned)aMask
@@ -535,10 +535,10 @@
Returns the item's keyboard shortcut modifier mask.
Can be a combination of:
<pre>
<objj>CPShiftKeyMask</objj>
<objj>CPAlternateKeyMask</objj>
<objj>CPCommandKeyMask</objj>
<objj>CPControlKeyMask</objj>
CPShiftKeyMask
CPAlternateKeyMask
CPCommandKeyMask
CPControlKeyMask
</pre>
*/
- (unsigned)keyEquivalentModifierMask
AppKit/CPOutlineView.j
+5 -5
View File
@@ -24,7 +24,7 @@
/*!
@ignore
This class is a subclass of <objj>CPTableView</objj> which provides the user with a way to display
This class is a subclass of CPTableView which provides the user with a way to display
tree structured data in an outline format. It is particularly useful for displaying hierarchical data
such as a class inheritance tree or any other set of relationships.
*/
@@ -52,10 +52,10 @@
@ignore
Sets the outline's data source. The data source must implement the following methods:
<pre>
- (id)outlineView:(<objj>CPOutlineView</objj>)outlineView child:(int)index ofItem:(id)item
- (BOOL)outlineView:(<objj>CPOutlineView</objj>)outlineView isItemExpandable:(id)item
- (int)outlineView:(<objj>CPOutlineView</objj>)outlineView numberOfChildrenOfItem:(id)item
- (id)outlineView:(<objj>CPOutlineView</objj>)outlineView objectValueForTableColumn:(<objj>CPTableColumn</objj>)tableColumn byItem:(id)item
- (id)outlineView:(CPOutlineView)outlineView child:(int)index ofItem:(id)item
- (BOOL)outlineView:(CPOutlineView)outlineView isItemExpandable:(id)item
- (int)outlineView:(CPOutlineView)outlineView numberOfChildrenOfItem:(id)item
- (id)outlineView:(CPOutlineView)outlineView objectValueForTableColumn:(CPTableColumn)tableColumn byItem:(id)item
</pre>
@param aDataSource the outline's data source
@throws CPInternalInconsistencyException if the data source does not implement all the required methods
AppKit/CPPanel.j
+1 -1
View File
@@ -28,7 +28,7 @@ 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>
The CPPanel 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>
AppKit/CPPasteboard.j
+1 -1
View File
@@ -44,7 +44,7 @@ var CPPasteboards = nil;
/*! @class CPPasteboard
<objj>CPPasteBoard</objj> is the object responsible for cut/copy/paste and drag&drop operations.
CPPasteBoard is the object responsible for cut/copy/paste and drag&drop operations.
*/
@implementation CPPasteboard : CPObject
{
AppKit/CPPopUpButton.j
+8 -8
View File
@@ -32,7 +32,7 @@ var CPPopUpButtonArrowsImage = nil;
/*! @class CPPopUpButton
A <objj>CPPopUpButton</objj> contains a pop-up menu of items that a user can select from.
A CPPopUpButton contains a pop-up menu of items that a user can select from.
*/
@implementation CPPopUpButton : CPButton
{
@@ -228,7 +228,7 @@ var CPPopUpButtonArrowsImage = nil;
}
/*!
Returns the index of the selected item. If no item is selected, it returns <objj>CPNotFound</objj>.
Returns the index of the selected item. If no item is selected, it returns CPNotFound.
*/
- (int)indexOfSelectedItem
{
@@ -237,7 +237,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>.
Returns the selected item's index. If no item is selected, it returns CPNotFound.
*/
- (id)objectValue
{
@@ -432,7 +432,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.
Returns the index of the specified item or CPNotFound if the item is not in the list.
@param aMenuItem the item to obtain the index for
*/
- (int)indexOfItem:(CPMenuItem)aMenuItem
@@ -441,7 +441,7 @@ var CPPopUpButtonArrowsImage = nil;
}
/*!
Returns the index of the item with the specified tag or <objj>CPNotFound</objj> if the item is not in the list.
Returns the index of the item with the specified tag or CPNotFound if the item is not in the list.
@param aTag the item's tag
*/
- (int)indexOfItemWithTag:(int)aTag
@@ -450,7 +450,7 @@ var CPPopUpButtonArrowsImage = nil;
}
/*!
Returns the index of the item with the specified title or <objj>CPNotFound</objj>.
Returns the index of the item with the specified title or CPNotFound.
@param aTitle the item's titel
*/
- (int)indexOfItemWithTitle:(CPString)aTitle
@@ -460,7 +460,7 @@ var CPPopUpButtonArrowsImage = nil;
/*!
Returns the index of the item with the specified
represented object or <objj>CPNotFound</objj>
represented object or CPNotFound
if a match does not exist.
@param anObject the item's represented object
*/
@@ -471,7 +471,7 @@ var CPPopUpButtonArrowsImage = nil;
/*!
Returns the index of the item with the specified target
and action. Returns <objj>CPNotFound</objj> if the no
and action. Returns CPNotFound if the no
such item is in the list.
@param aTarget the item's target
@param anAction the item's action
AppKit/CPProgressIndicator.j
+1 -1
View File
@@ -376,7 +376,7 @@ var CPProgressIndicatorSpinningStyleColors = nil,
/*!
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>.
is CPProgressIndicatorBarStyle, and <code>NO</code> if it's CPProgressIndicatorSpinningStyle.
@param isDisplayedWhenStopped <code>YES</code> means the indicator will be displayed when it's not animating.
*/
- (void)setDisplayedWhenStopped:(BOOL)isDisplayedWhenStopped
AppKit/CPResponder.j
+1 -1
View File
@@ -88,7 +88,7 @@ CPRightArrowKeyCode = 63235;
/*!
Called to interpret a series of key events.
@param events an array of key <objj>CPEvent</objj>s
@param events an array of key CPEvents
*/
- (void)interpretKeyEvents:(CPArray)events
{
AppKit/CPScrollView.j
+1 -1
View File
@@ -29,7 +29,7 @@
/*! @class CPScrollView
Used to display views that are too large for the viewing area. the <objj>CPScrollView</objj>
Used to display views that are too large for the viewing area. the CPScrollView
places scroll bars on the side of the view to allow the user to scroll and see the entire
contents of the view.
*/
AppKit/CPScroller.j
+2 -2
View File
@@ -211,7 +211,7 @@ var _CPScrollerClassName = nil,
// Determining CPScroller Size
/*!
Returns the <objj>CPScroller</objj>'s width for a <objj>CPRegularControlSize</objj>.
Returns the CPScroller's width for a CPRegularControlSize.
*/
+ (float)scrollerWidth
{
@@ -219,7 +219,7 @@ var _CPScrollerClassName = nil,
}
/*!
Returns the width of a <objj>CPScroller</objj> for the specified <objj>CPControlSize</objj>.
Returns the width of a CPScroller for the specified CPControlSize.
@param aControlSize the size of a controller to return the width for
*/
+ (float)scrollerWidthForControlSize:(CPControlSize)aControlSize
AppKit/CPSlider.j
+1 -1
View File
@@ -30,7 +30,7 @@ var CPSliderHorizontalKnobImage = 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>.
An CPSlider 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
{
AppKit/CPSplitView.j
+1 -1
View File
@@ -515,7 +515,7 @@ var CPSplitViewDelegateKey = "CPSplitViewDelegateKey",
/*
Initializes the split view by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPSplitView</objj>.
@param aCoder the coder containing the archived CPSplitView.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
AppKit/CPTabView.j
+8 -8
View File
@@ -71,11 +71,11 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
/*! @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.
This class represents a view that has multiple subviews (CPTabViewItem) presented as individual tabs.
Only one CPTabViewItem is shown at a time, and other CPTabViewItems can be made visible
(one at a time) by clicking on the CPTabViewItem's tab at the top of the tab view.
THe currently selected <objj>CPTabViewItem</objj> is the view that is displayed.
THe currently selected CPTabViewItem is the view that is displayed.
*/
@implementation CPTabView : CPView
{
@@ -222,7 +222,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
// Adding and Removing Tabs
/*!
Adds a <objj>CPTabViewItem</objj> to the tab view.
Adds a CPTabViewItem to the tab view.
@param aTabViewItem the item to add
*/
- (void)addTabViewItem:(CPTabViewItem)aTabViewItem
@@ -231,7 +231,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
/*!
Inserts a <objj>CPTabViewItem</objj> into the tab view
Inserts a CPTabViewItem into the tab view
at the specified index.
@param aTabViewItem the item to insert
@param anIndex the index for the item
@@ -274,7 +274,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
/*!
Returns the index of the <objj>CPTabViewItem</objj> with the specified identifier.
Returns the index of the CPTabViewItem with the specified identifier.
@param anIdentifier the identifier of the item
*/
- (int)indexOfTabViewItemWithIdentifier:(CPString)anIdentifier
@@ -298,7 +298,7 @@ var CPTabViewDidSelectTabViewItemSelector = 1,
}
/*!
Returns the <objj>CPTabViewItem</objj> at the specified index.
Returns the CPTabViewItem at the specified index.
*/
- (CPTabViewItem)tabViewItemAtIndex:(unsigned)anIndex
{
AppKit/CPTabViewItem.j
+5 -5
View File
@@ -46,8 +46,8 @@ 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>.
The class representation of an item in a CPTabView. One tab view item
can be shown at a time in a CPTabView.
*/
@implementation CPTabViewItem : CPObject
{
@@ -60,7 +60,7 @@ CPPressedTab = 2;
/*!
Initializes the tab view item with the specified identifier.
@return the initialized <objj>CPTabViewItem</objj>
@return the initialized CPTabViewItem
*/
- (id)initWithIdentifier:(id)anIdentifier
{
@@ -74,7 +74,7 @@ CPPressedTab = 2;
// Working With Labels
/*!
Sets the <objj>CPTabViewItem</objj>'s label.
Sets the CPTabViewItem's label.
@param aLabel the label for the item
*/
- (void)setLabel:(CPString)aLabel
@@ -83,7 +83,7 @@ CPPressedTab = 2;
}
/*!
Returns the <objj>CPTabViewItem</objj>'s label
Returns the CPTabViewItem's label
*/
- (CPString)label
{
AppKit/CPTableColumn.j
+2 -2
View File
@@ -45,9 +45,9 @@ 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>
An CPTableColumn 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.
<p>Each CPTableColumn object is identified by a CPString, 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.
@ignore
*/
AppKit/CPTableView.j
+4 -4
View File
@@ -27,7 +27,7 @@ import "CPTableColumn.j"
var CPTableViewCellPlaceholder = nil;
/*
<objj>CPTableView</objj> is located within the AppKit framework and is used to display tables. It uses a delegate model for getting its data i.e. you give it an object that provides it with the data it should display.
CPTableView is located within the AppKit framework and is used to display tables. It uses a delegate model for getting its data i.e. you give it an object that provides it with the data it should display.
@ignore
*/
@@ -284,7 +284,7 @@ var CPTableViewCellPlaceholder = nil;
}
/*
Returns an array containing the table's <objj>CPTableColumn</objj>s.
Returns an array containing the table's CPTableColumns.
*/
- (CPArray)tableColumns
{
@@ -323,8 +323,8 @@ var CPTableViewCellPlaceholder = nil;
Sets the object that is used to obtain the table data. The data source must implement the following
methods:
<pre>
- (int)numberOfRowsInTableView:(<objj>CPTableView</objj>)aTableView
- (id)tableView:(<objj>CPTableView</objj>)aTableView objectValueForTableColumn:(<objj>CPTableColumn</objj>)aTableColumn row:(int)rowIndex
- (int)numberOfRowsInTableView:(CPTableView)aTableView
- (id)tableView:(CPTableView)aTableView objectValueForTableColumn:(CPTableColumn)aTableColumn row:(int)rowIndex
</pre>
@param aDataSource the object with the table data
@throws CPInternalInconsistencyException if <code>aDataSource</code> doesn't implement all the required methods
AppKit/CPToolbar.j
+1 -1
View File
@@ -358,7 +358,7 @@ var CPToolbarIdentifierKey = "CPToolbarIdentifierKey",
/*
Initializes the toolbar by unarchiving data from <code>aCoder</code>.
@param aCoder the coder containing the archived <objj>CPToolbar</objj>.
@param aCoder the coder containing the archived CPToolbar.
*/
- (id)initWithCoder:(CPCoder)aCoder
{
AppKit/CPToolbarItem.j
+1 -1
View File
@@ -60,7 +60,7 @@ var _CPToolbarSeparatorItemView = nil;
/*! @class CPToolbarItem
A representation of an item in a <objj>CPToolbar</objj>.
A representation of an item in a CPToolbar.
*/
@implementation CPToolbarItem : CPObject
{
AppKit/CPView.j
+24 -24
View File
@@ -102,17 +102,17 @@ var DOMElementPrototype = nil,
/*! @class CPView
<objj>CPView</objj> is an abstract class which provides facilities for drawing
<p>CPView is a 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>
<p>In order to display itself, a view must be placed in a window (represented by an
<objj>CPWindow</objj> object). Within the window is a hierarchy of <objj>CPView</objj>s,
CPWindow object). Within the window is a hierarchy of CPViews,
headed by the window's content view. Every other view in a window is a descendant
of this view.</p>
<p>Subclasses can override <code>-drawRect:</code> in order to implement their
appearance. Other methods of <objj>CPView</objj> and <objj>CPResponder</objj> can
appearance. Other methods of CPView and CPResponder can
also be overridden to handle user generated events.
*/
@implementation CPView : CPResponder
@@ -253,7 +253,7 @@ var DOMElementPrototype = nil,
/*!
Returns an array of all the views contained as direct children of the receiver
@return an array of <objj>CPView</objj>s
@return an array of CPViews
*/
- (CPArray)subviews
{
@@ -270,7 +270,7 @@ var DOMElementPrototype = nil,
/*!
Makes the argument a subview of the receiver.
@param aSubview the <objj>CPView</objj> to make a subview
@param aSubview the CPView to make a subview
*/
- (void)addSubview:(CPView)aSubview
{
@@ -454,7 +454,7 @@ var DOMElementPrototype = nil,
}
/*!
Called when the receiver has been moved to a new <objj>CPWindow</objj>.
Called when the receiver has been moved to a new CPWindow.
*/
- (void)viewDidMoveToWindow
{
@@ -524,7 +524,7 @@ var DOMElementPrototype = nil,
/*!
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
of the superview. The method also posts an CPViewFrameDidChangeNotification 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
returns (and no notificaion is posted).
@param aFrame the rectangle specifying the new origin and size of the receiver
@@ -556,7 +556,7 @@ var DOMElementPrototype = nil,
/*!
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
The method posts a CPViewFrameDidChangeNotification 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
simply return (and no notification will be posted).
@param aPoint the new origin point
@@ -581,7 +581,7 @@ var DOMElementPrototype = nil,
/*!
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
method simply returns. The method posts a CPViewFrameDidChangeNotification to the
default notification center if the receiver is configured to do so.
@param aSize the new size for the frame
*/
@@ -654,7 +654,7 @@ var DOMElementPrototype = nil,
/*!
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.
CPViewBoundsDidChangeNotification to the default notification center if the receiver is configured to do so.
@param bounds the new bounds
*/
- (void)setBounds:(CGRect)bounds
@@ -684,7 +684,7 @@ var DOMElementPrototype = nil,
/*!
Sets the location of the receiver inside its frame. The method
posts a <objj>CPViewBoundsDidChangeNotification</objj> to the
posts a CPViewBoundsDidChangeNotification to the
default notification center if the receiver is configured to do so.
@param aPoint the new location for the receiver
*/
@@ -727,7 +727,7 @@ var DOMElementPrototype = nil,
/*!
Sets the receiver's size inside its frame. The method posts a
<objj>CPViewBoundsDidChangeNotification</objj> to the default
CPViewBoundsDidChangeNotification to the default
notification center if the receiver is configured to do so.
@param aSize the new size for the receiver
*/
@@ -1236,7 +1236,7 @@ var DOMElementPrototype = nil,
}
/*!
Sets whether the receiver posts a <objj>CPViewFrameDidChangeNotification</objj> notification
Sets whether the receiver posts a CPViewFrameDidChangeNotification 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:
<pre>
@@ -1259,7 +1259,7 @@ setFrameOrigin:
}
/*!
Returns <code>YES</code> if the receiver posts a <objj>CPViewFrameDidChangeNotification</objj> if its frame is changed.
Returns <code>YES</code> if the receiver posts a CPViewFrameDidChangeNotification if its frame is changed.
*/
- (BOOL)postsFrameChangedNotifications
{
@@ -1267,7 +1267,7 @@ setFrameOrigin:
}
/*!
Sets whether the receiver posts a <objj>CPViewBoundsDidChangeNotification</objj> notification
Sets whether the receiver posts a CPViewBoundsDidChangeNotification 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:
<pre>
@@ -1291,7 +1291,7 @@ setBoundsOrigin:
/*!
Returns <code>YES</code> if the receiver posts a
<objj>CPViewBoundsDidChangeNotification</objj> when its
CPViewBoundsDidChangeNotification when its
bounds is changed.
*/
- (BOOL)postsBoundsChangedNotifications
@@ -1331,7 +1331,7 @@ setBoundsOrigin:
/*!
Sets the receiver's list of acceptable data types for a dragging operation.
@param pasteboardTypes an array of <objj>CPPasteboard</objj>s
@param pasteboardTypes an array of CPPasteboards
*/
- (void)registerForDraggedTypes:(CPArray)pasteboardTypes
{
@@ -1340,7 +1340,7 @@ setBoundsOrigin:
/*!
Returns an array of all types the receiver accepts for dragging operations.
@return an array of <objj>CPPasteBoard</objj>s
@return an array of CPPasteBoards
*/
- (CPArray)registeredDraggedTypes
{
@@ -1559,7 +1559,7 @@ setBoundsOrigin:
}
/*!
Scrolls the nearest ancestor <objj>CPClipView</objj> a minimum amount so <code>aRect</code> can become visible.
Scrolls the nearest ancestor CPClipView 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.
*/
@@ -1627,8 +1627,8 @@ setBoundsOrigin:
}
/*!
Returns the <objj>CPScrollView</objj> containing the receiver.
@return the <objj>CPScrollView</objj> containing the receiver.
Returns the CPScrollView containing the receiver.
@return the CPScrollView containing the receiver.
*/
- (CPScrollView)enclosingScrollView
{
@@ -1652,7 +1652,7 @@ setBoundsOrigin:
}
/*!
Notifies the receiver (superview of a <objj>CPClipView</objj>)
Notifies the receiver (superview of a CPClipView)
that the clip view bounds or the document view bounds have changed.
@param aClipView the clip view of the superview being notified
*/
@@ -1714,8 +1714,8 @@ setBoundsOrigin:
}
/*!
Returns <code>YES</code> if the receiver uses a <objj>CALayer</objj>
@returns <code>YES</code> if the receiver uses a <objj>CALayer</objj>
Returns <code>YES</code> if the receiver uses a CALayer
@returns <code>YES</code> if the receiver uses a CALayer
*/
- (BOOL)wantsLayer
{
AppKit/CPWindow.j
+4 -4
View File
@@ -186,7 +186,7 @@ var CPWindowSaveImage = nil,
/*! @class CPWindow
An <objj>CPWindow</objj> instance represents a window, panel or menu on the screen.</p>
An CPWindow 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>
@@ -194,7 +194,7 @@ var CPWindowSaveImage = nil,
<p>A window always contains a content view which is the highest level view available for public (application) use. This view fills the area of the window inside any decoration/border. This is the only part of the window that application programmers are allowed to draw in directly.</p>
<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.
<p>You can convert between view coordinates and window base coordinates using the [CPView -convertPoint:fromView:], [CPView -convertPoint:toView:], [CPView -convertRect:fromView:], and [CPView -convertRect:toView:] methods with a nil view argument.
@par Delegate Methods
@@ -876,7 +876,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>
@param aDelegate an object to respond to the various delegate methods of CPWindow
*/
- (void)setDelegate:(id)aDelegate
{
@@ -1079,7 +1079,7 @@ CPTexturedBackgroundWindowMask
}
/*!
Dispatches events that are sent to it from <objj>CPApplication</objj>.
Dispatches events that are sent to it from CPApplication.
@param anEvent the event to be dispatched
*/
- (void)sendEvent:(CPEvent)anEvent
AppKit/CPWindowController.j
+4 -4
View File
@@ -32,10 +32,10 @@
/*! @class CPWindowController
An instance of a <objj>CPWindowController</objj> manages a <objj>CPWindow</objj>. It has methods
An instance of a CPWindowController manages a CPWindow. 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
considered the 'Controller' and the <objj>CPWindow</objj> the 'Model.'
Model-View-Controller method of program design, the CPWindowController would be
considered the 'Controller' and the CPWindow the 'Model.'
*/
@implementation CPWindowController : CPResponder
{
@@ -123,7 +123,7 @@
/*!
Returns <code>YES</code> if the window has been loaded. Specifically,
if <objj>loadWindow</objj> has been called.
if loadWindow has been called.
*/
- (BOOL)isWindowLoaded
{
AppKit/CoreAnimation/CAAnimation.j
+4 -4
View File
@@ -34,8 +34,8 @@
}
/*!
Creates a new <objj>CAAnimation</objj> instance
@return a new <objj>CAAnimation</objj> instance
Creates a new CAAnimation instance
@return a new CAAnimation instance
*/
+ (id)animation
{
@@ -191,8 +191,8 @@
@end
/*!
A <objj>CABasicAnimation</objj> is a simple animation that moves a
<objj>CALayer</objj> from one point to another over a specified
A CABasicAnimation is a simple animation that moves a
CALayer from one point to another over a specified
period of time.
*/
@implementation CABasicAnimation : CAPropertyAnimation
AppKit/CoreAnimation/CALayer.j
+3 -3
View File
@@ -51,11 +51,11 @@ var CALayerRegisteredRunLoopUpdates = nil;
/*! @class CALayer
A <objj>CALayer</objj> is similar to a <objj>CPView</objj>, but with the ability
A CALayer is similar to a CPView, but with the ability
to have a transform applied to it.
@delegate -(void)drawLayer:(CALayer)layer inContext:(CGContextRef)ctx;
If the delegate implements this method, the <objj>CALayer</objj> will
If the delegate implements this method, the CALayer will
call this in place of its <code>drawInContext:</code>.
@param layer the layer to draw for
@param ctx the context to draw on
@@ -418,7 +418,7 @@ var CALayerRegisteredRunLoopUpdates = nil;
// Providing Layer Content
/*!
Returns the <objj>CGImage</objj> contents of this layer.
Returns the CGImage contents of this layer.
The default contents are <code>nil</code>.
*/
- (CGImage)contents
AppKit/CoreGraphics/CGColor.j
+13 -13
View File
@@ -62,8 +62,8 @@ function CGColorRelease()
}
/*!
Creates a new <objj>CGColor</objj>.
@param aColorSpace the <objj>CGColorSpace</objj> of the color
Creates a new CGColor.
@param aColorSpace the CGColorSpace of the color
@param components the color's intensity values plus alpha
@return CGColor the new color object
@group CGColor
@@ -86,10 +86,10 @@ function CGColorCreate(aColorSpace, components)
}
/*!
Creates a copy of a color... but not really. <objj>CGColor</objj>s
Creates a copy of a color... but not really. CGColors
are immutable, so to be efficient, this function will just
return the same object that was passed in.
@param aColor the <objj>CGColor</objj> to 'copy'
@param aColor the CGColor to 'copy'
@return CGColor the color copy
@group CGColor
*/
@@ -166,7 +166,7 @@ function CGColorCreateCopyWithAlpha(aColor, anAlpha)
/*!
Creates a color using the specified pattern.
@param aColorSpace the <objj>CGColorSpace</objj>
@param aColorSpace the CGColorSpace
@param aPattern the pattern image
@param components the color components plus the alpha component
@return CGColor the patterned color
@@ -182,8 +182,8 @@ function CGColorCreateWithPattern(aColorSpace, aPattern, components)
/*!
Determines if two colors are the same.
@param lhs the first <objj>CGColor</objj>
@param rhs the second <objj>CGColor</objj>
@param lhs the first CGColor
@param rhs the second CGColor
@return <code>YES</code> if the two colors are equal.
<code>NO</code> otherwise.
*/
@@ -229,8 +229,8 @@ function CGColorGetAlpha(aColor)
}
/*!
Returns the <objj>CGColor</objj>'s color space.
@return <objj>CGColorSpace</objj>
Returns the CGColor's color space.
@return CGColorSpace
@group CGColor
*/
function CGColorGetColorSpace(aColor)
@@ -239,7 +239,7 @@ function CGColorGetColorSpace(aColor)
}
/*!
Returns the <objj>CGColor</objj>'s components
Returns the CGColor's components
including the alpha in an array.
@param aColor the color
@return CPArray the color's components
@@ -252,7 +252,7 @@ function CGColorGetComponents(aColor)
/*!
Returns the number of color components
(including alpha) in the specified color.
@param aColor the <objj>CGColor</objj>
@param aColor the CGColor
@return CPNumber the number of components
@group CGColor
*/
@@ -262,8 +262,8 @@ function CGColorGetNumberOfComponents(aColor)
}
/*!
Gets the <objj>CGColor</objj>'s pattern.
@param a <objj>CGColor</objj>
Gets the CGColor's pattern.
@param a CGColor
@return CGPatternFIXME the pattern image
@group CGColor
*/
AppKit/CoreGraphics/CGGeometry.j
+8 -8
View File
@@ -66,11 +66,11 @@ _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>.
Returns a <code>BOOL</code> indicating whether CGRect <code>lhsRect</code>
contains CGRect <code>rhsRect</code>.
@group CGRect
@param lhsRect the <objj>CGRect</objj> to test if <code>rhsRect</code> is inside of
@param rhsRect the <objj>CGRect</objj> to test if it fits inside <code>lhsRect</code>.
@param lhsRect the CGRect to test if <code>rhsRect</code> is inside of
@param rhsRect the CGRect to test if it fits inside <code>lhsRect</code>.
@return BOOL <code>YES</code> if <code>rhsRect</code> fits inside <code>lhsRect</code>.
*/
function CGRectContainsRect(lhsRect, rhsRect)
@@ -83,8 +83,8 @@ function CGRectContainsRect(lhsRect, rhsRect)
/*!
Returns <code>YES</code> if the two rectangles intersect
@group CGRect
@param lhsRect the first <objj>CGRect</objj>
@param rhsRect the second <objj>CGRect</objj>
@param lhsRect the first CGRect
@param rhsRect the second CGRect
@return BOOL <code>YES</code> if the two rectangles have any common spaces, and <code>NO</code>, otherwise.
*/
function CGRectIntersectsRect(lhsRect, rhsRect)
@@ -95,8 +95,8 @@ function CGRectIntersectsRect(lhsRect, rhsRect)
}
/*!
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).
Makes the origin and size of a CGRect all integers. Specifically, by making
the southwest corner the origin (rounded down), and the northeast corner a CGSize (rounded up).
@param aRect the rectangle to operate on
@return CGRect the modified rectangle (same as the input)
@group CGRect
Objective-J/bootstrap.js
Vendored
+1 -1
View File
@@ -21,4 +21,4 @@
*/
if (window.OBJJ_MAIN_FILE)
objj_import("main.j", YES, function() { main(); });
objj_import(OBJJ_MAIN_FILE, YES, function() { main(); });
Tools/Documentation/Cappuccino.doxygen
+1 -1
View File
@@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Cappuccino
PROJECT_NUMBER = 1.5.5
PROJECT_NUMBER = 0.6
OUTPUT_DIRECTORY = Documentation
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
Tools/READMEs/STARTER-README
+2 -2
View File
@@ -2,11 +2,11 @@ Welcome to the Cappuccino Starter Package!
Included you should find the following:
1. Frameworks
1. Documentation
2. NewApplication
3. README
NewApplication is a stand alone Cappuccino application that you can use as a template to start building your own apps. To get started, just open up NewApplication/index.html in your favorite web browser. A great place to go from there is to read the "Downloading and Getting Started" tutorial found at http://cappuccino.org/learn/tutorials/starter-tutorial.php. This will walk you through these initial steps as well as getting you to do a little coding.
NewApplication is a stand alone Cappuccino application that you can use as a template to start building your own apps. To get started, just open up NewApplication/index.html in your favorite web browser. A great place to go from there is to read the "Downloading and Getting Started" tutorial found at http://cappuccino.org/learn/tutorials/starter-tutorial.php. This will walk you through these initial steps as well as getting you to do a little coding. If you want to debug your application, try running it with index-debug.html instead, which should make it easier.
You can build your entire application right from this sample project, but if you want to dig a little deeper, you can also download the Tools package found at http://cappuccino.org/download/. This will set you up with some great additions like syntax modules for certain text editors and build tools to get extra performance.
Tools/READMEs/TOOLS-README
+3 -1
View File
@@ -6,11 +6,13 @@ This package includes syntax highlighting modes for both SubEthaEdit, Coda, Text
+ SubEthaEdit
- NOTE: SubEthaEdit now has built-in support for Objective-J, but the copy included here is probably more up to date.
- Unarchive Tools/Editors/Objective-J.mode.zip
- Double click the generated Objective-J.mode file
+ Coda
- NOTE: Coda now has built-in support for Objective-J, but the copy included here is probably more up to date.
- Unarchive Tools/Editors/Objective-J.mode.zip
- Place the generated Objective-J.mode file in ~/Library/Application Support/Coda/Modes
@@ -87,6 +89,6 @@ objjc is a static preinterpreter for Objectie-J. It will take Objective-J files
Steam is a simple tool for managing Objective-J projects. Among other things, it allows you to statically pre-interpret entire Objective-J applications so that you can deliver it without requiring client-side pre-interpretation.
steam create path - This will create a new Cappuccino application at the specified path. The resulting project contains a basic Cappuccino application as well as Objective-J and the preprocessed Cappuccino frameworks.
steam create [-l] path - This will create a new Cappuccino application at the specified path. The resulting project contains a basic Cappuccino application as well as Objective-J and the preprocessed Cappuccino frameworks.
steam build [options] - This builds an application or framework.
build.xml
+39 -4
View File
@@ -85,13 +85,45 @@
</ojtest>
</target>
<target name = "docs">
<target name = "safe-documentation" >
<exec executable = "which" outputproperty = "doxygen.location">
<arg line = "doxygen" />
</exec>
<condition property = "doxygen.target" value = "" else = "-warning">
<not>
<length string = "${doxygen.location}" length = "0" />
</not>
</condition>
<antcall target = "documentation${doxygen.target}" />
</target>
<target name = "documentation-warning">
<echo>*** WARNING: Doxygen not installed. Could not create documentation.</echo>
</target>
<target name = "documentation">
<exec executable = "doxygen" dir = ".">
<arg value = "Tools/Documentation/Cappuccino.doxygen" />
</exec>
<mkdir dir = "${Build}" />
<move file = "Documentation" todir = "${Build}" />
<mkdir dir = "${Build.Cappuccino}" />
<move file = "Documentation" todir = "${Build.Cappuccino}" />
<mkdir dir = "${Build.Cappuccino.Starter}" />
<copy todir = "${Build.Cappuccino.Starter}/Documentation" >
<fileset dir = "${Build.Cappuccino}/Documentation/html" />
</copy>
<mkdir dir = "${Build.Cappuccino.Tools}" />
<copy todir = "${Build.Cappuccino.Tools}/Documentation" >
<fileset dir = "${Build.Cappuccino}/Documentation/html" />
</copy>
</target>
<!-- Deploying -->
@@ -269,7 +301,10 @@
<include name = "AppKit/" />
</fileset>
</copy>
<!-- Documentation -->
<antcall target = "safe-documentation" />
<!-- Zip -->