Archived
1

Added Lots of Documentation

Added some nice to haves
Improved and Unified General Code Layout
This commit is contained in:
Kim Wittenburg
2015-01-04 02:54:27 +01:00
parent 152b981e24
commit 7438fd1f95
83 changed files with 2282 additions and 416 deletions

View File

@@ -7,19 +7,74 @@
//
/*!
@header
This file contains the <code>MPFunctionsViewController</code> class.
*/
@class MPFunctionsViewController, MPFunctionsCollectionView;
/*!
@class MPFunctionsViewController
@abstract Controls a view from which the user can select function to be
inserted into a <code>@link
//apple_ref/occ/cl/MPExpressionView@/link</code>.
@discussion The view contain a <code>NSCollectionView</code> displaying the
prototypes an a <code>NSTextField</code> displaying a description
of the currently selected prototype.
*/
@interface MPFunctionsViewController : NSViewController
- (id)init;
/*!
@property collectionView
@abstract The <code>NSCollectionView</code> that displays the function
prototypes.
*/
@property (weak) IBOutlet NSCollectionView *collectionView;
@property (weak) IBOutlet MPFunctionsCollectionView *collectionView;
/*!
@property functionPrototypes
@abstract Contains the <code>@link
//apple_ref/occ/cl/MPFunction@/link</code> objects that get
inserted into an expression if selected.
@discussion Every object in the array must be an <code>@link
//apple_ref/occ/cl/MPFunction@/link</code> instance.
*/
@property (nonatomic, strong) NSArray *functionPrototypes;
/*!
@property currentDescription
@abstract The string that describes the function prototype that is
currently selected.
@discussion If this string is empty a placeholder value will be displayed.
*/
@property (nonatomic, strong) NSString *currentDescription;
/*!
@property target
@abstract The target object to receive action messages from the receiver.
*/
@property (nonatomic, weak) id target;
@property (nonatomic) SEL action; // 1 argument: The function to insert
/*!
@property action
@abstract The receiver's action method to the specified selector.
@discussion The action method is invoked when the user selects one of the
function prototypes in the collection view. The prototype that
was selected is passed as the one and only argument to
the specified selector.
*/
@property (nonatomic) SEL action;
@end