gnustep/apps-gorm
0
0
Fork 0
mirror of https://github.com/gnustep/apps-gorm.git synced 2025-04-22 22:20:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Completed documentation.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/apps/gorm/trunk@20510 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Gregory John Casamento 2005-01-01 14:56:11 +00:00
parent 49c7adba2b
commit a7690ef937
8 changed files with 181 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ChangeLog
View file

@ -1,3 +1,14 @@
2005-01-01 09:59 Gregory John Casamento <greg_casamento@yahoo.com>
* GormLib/IBApplicationAdditions.h
* GormLib/IBCellProtocol.h
* GormLib/IBConnectors.h
* GormLib/IBInspector.h
* GormLib/IBObjectProtocol.h
* GormLib/IBSystem.h
* GormLib/IBViewProtocol.h: Completed all documentation
for existing IntefaceBuilder classes.
2005-01-01 02:39 Gregory John Casamento <greg_casamento@yahoo.com>
* GormLib/GNUmakefile: Added new headers and new .m file.

23
GormLib/IBApplicationAdditions.h
View file

@ -35,14 +35,37 @@ IB_EXTERN NSString *IBWillEndTestingInterfaceNotification;
IB_EXTERN NSString *IBDidEndTestingInterfaceNotification;
@protocol IB <NSObject>
/**
* Returns the document which is currently being edited.
*/
- (id<IBDocuments>) activeDocument;
/**
* Returns YES, if the reciever is in testing mode.
*/
- (BOOL) isTestingInterface;
/**
* Returns the current selection owner.
*/
- (id<IBSelectionOwners>) selectionOwner;
/**
* Returns the current selection from the current selection
* owner.
*/
- (id) selectedObject;
@end
@interface NSApplication (GormSpecific)
/**
* Image to be displayed with making a link.
*/
- (NSImage *) linkImage;
/**
* Start the connection process.
*/
- (void) startConnecting;
@end

11
GormLib/IBCellProtocol.h
View file

@ -29,9 +29,20 @@
#include <InterfaceBuilder/IBDefines.h>
@protocol IBCellProtocol
/**
* Called when the cell is about to be alt-dragged.
*/
- (void) cellWillAltDragWithSize: (NSSize)size;
/**
* Maximum size for the cell.
*/
- (NSSize) maximumSizeForCellSize: (NSSize)size
knobPosition: (IBKnobPosition)position;
/**
* Minimum size for the cell.
*/
- (NSSize) minimumSizeForCellSize: (NSSize)size
knobPosition: (IBKnobPosition)position;
@end

41
GormLib/IBConnectors.h
View file

@ -42,14 +42,52 @@ IB_EXTERN NSString *IBDidRemoveConnectorNotification;
* Connector objects are used to record connections between nib objects.
*/
@protocol IBConnectors <NSObject>
/**
* Destination for the receiver.
*/
- (id) destination;
/**
* Establish the connection.
*/
- (void) establishConnection;
/**
* The method to which the receiver will be connected.
*/
- (NSString*) label;
/**
* Replace anObject with anotherObject. This method looks at
* the receiver's source and destination and replaces whichever
* one matches anObject with anotherObject.
*/
- (void) replaceObject: (id)anObject withObject: (id)anotherObject;
/**
* The source of the receiver.
*/
- (id) source;
/**
* Set the receiver's destination to anObject.
*/
- (void) setDestination: (id)anObject;
/**
* Set the receiver's label.
*/
- (void) setLabel: (NSString*)label;
/**
* Set the receiver's source to anObject.
*/
- (void) setSource: (id)anObject;
/**
* Called after the document is loaded on connections.
*/
- (id) nibInstantiate;
@end
@ -57,6 +95,9 @@ IB_EXTERN NSString *IBDidRemoveConnectorNotification;
@end
@interface NSObject (IBNibInstantiation)
/**
* Invoked after loading.
*/
- (id) nibInstantiate;
@end

3
GormLib/IBInspector.h
View file

@ -54,6 +54,9 @@
*/
- (void) dealloc;
/**
* The first view to be selected in the inspector.
*/
- (NSView*) initialFirstResponder;
/**

52
GormLib/IBObjectProtocol.h
View file

@ -28,30 +28,68 @@
#include <InterfaceBuilder/IBDocuments.h>
@protocol IBObjectProtocol
// custom class support
/**
* Returns YES, if receiver can be displayed in
* the custom custom class inspector as a potential
* class which can be switched to by the receiver.
*/
+ (BOOL)canSubstituteForClass: (Class)origClass;
/**
* Called immediate after loading the document into
* the interface editor application.
*/
- (void)awakeFromDocument: (id <IBDocuments>)doc;
// editor
/**
* Returns the NSImage to be used to represent an object
* of the receiver's class in the editor.
*/
- (NSImage *)imageForViewer;
// object labels
/**
* Name in nameTable for object.
*/
- (NSString *)nibLabel: (NSString *)objectName;
// title to display in the inspector
/**
* Title to display in the inspector.
*/
- (NSString *)objectNameForInspectorTitle;
// names of inspectors for any given class...
/**
* Name of attributes inspector class.
*/
- (NSString*) inspectorClassName;
/**
* Name of connection inspector class.
*/
- (NSString*) connectInspectorClassName;
/**
* Name of size inspector.
*/
- (NSString*) sizeInspectorClassName;
/**
* Name of help inspector.
*/
- (NSString*) helpInspectorClassName;
/**
* Name of class inspector.
*/
- (NSString*) classInspectorClassName;
// name of the editor for the current class.
/**
* Name of the editor for the receiver.
*/
- (NSString*) editorClassName;
// list of properties not compatible with IB.
/**
* List of properties not compatible with interface app.
*/
- (NSArray*) ibIncompatibleProperties;
@end

46
GormLib/IBSystem.h
View file

@ -1,26 +1,28 @@
/* Plateform specific definitions for externs
Copyright (C) 2001 Free Software Foundation, Inc.
/**
Platform specific definitions for externs
Copyright (C) 2001 Free Software Foundation, Inc.
Written by: Gregory John Casamento <greg_casamento@yahoo.com>
Based on AppKitDefines.h by: Adam Fedor <fedor@gnu.org>
Date: Dec, 2004
This file is part of GNUstep.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
*/
Written by: Gregory John Casamento <greg_casamento@yahoo.com>
Based on AppKitDefines.h by: Adam Fedor <fedor@gnu.org>
Date: Dec, 2004
This file is part of GNUstep.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111 USA.
*/
#ifndef IBSystem_INCLUDE
#define IBSystem_INCLUDE

23
GormLib/IBViewProtocol.h
View file

@ -32,11 +32,34 @@
@class NSColor;
@protocol IBViewProtocol
/**
* Returns YES, if color can be set at the given point in the view.
*/
- (BOOL) acceptsColor: (NSColor*)color atPoint: (NSPoint)point;
/**
* Returns YES if receiver can be alt-dragged.
*/
- (BOOL) allowsAltDragging;
/**
* Sets color at point in the receiver.
*/
- (void) depositColor: (NSColor*)color atPoint: (NSPoint)point;
/**
* The maximum size for a knob surrounding the receiver.
*/
- (NSSize) maximumSizeFromKnobPosition: (IBKnobPosition)knobPosition;
/**
* The minimum size for a knob surrounding the receiver.
*/
- (NSSize) minimumSizeFromKnobPosition: (IBKnobPosition)position;
/**
* Places and resizes the receiver using newFrame.
*/
- (void) placeView: (NSRect)newFrame;
@end