Add some comments

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/apps/gorm/trunk@13021 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2002-03-06 11:49:16 +00:00
parent ee033590b1
commit dc24d79035

40
Gorm.h
View file

@ -326,7 +326,7 @@ extern NSString *IBClassNameChangedNotification;
+ (id) objectForView: (NSView*)aView; + (id) objectForView: (NSView*)aView;
+ (NSString*) typeForView: (NSView*)aView; + (NSString*) typeForView: (NSView*)aView;
/* /**
* Associate a particular object and DnD type with a view - so that * Associate a particular object and DnD type with a view - so that
* Gorm knows to initiate a DnD session with the specified object * Gorm knows to initiate a DnD session with the specified object
* and type rather than an archived copy of the view itsself and * and type rather than an archived copy of the view itsself and
@ -336,18 +336,24 @@ extern NSString *IBClassNameChangedNotification;
type: (NSString*)aType type: (NSString*)aType
with: (NSView*)aView; with: (NSView*)aView;
/* /**
* Releases all the instance variables and removes self as an observer
* of notifications before destroying self.
*/
- (void) dealloc;
/**
* Method called by Gorm when a new palette has been created and its nib * Method called by Gorm when a new palette has been created and its nib
* (if any) has been loaded. Any palette initialisation should be done here. * (if any) has been loaded. Any palette initialisation should be done here.
*/ */
- (void) finishInstantiate; - (void) finishInstantiate;
/* /**
* Return the icon representing the palette. * Return the icon representing the palette.
*/ */
- (NSImage*) paletteIcon; - (NSImage*) paletteIcon;
/* /**
* Return the window containing the views that may be dragged from the * Return the window containing the views that may be dragged from the
* palette. * palette.
*/ */
@ -379,59 +385,65 @@ extern NSString *IBClassNameChangedNotification;
NSButton *revertButton; NSButton *revertButton;
} }
/**
* Releases all the instance variables and removes self as an observer
* of notifications before destroying self.
*/
- (void) dealloc;
- (NSView*) initialFirstResponder; - (NSView*) initialFirstResponder;
/* /**
* The object being inspected. * The object being inspected.
*/ */
- (id) object; - (id) object;
/* /**
* Action to take when user clicks the OK button * Action to take when user clicks the OK button
*/ */
- (void) ok: (id)sender; - (void) ok: (id)sender;
/* /**
* Inspector supplied button - the inspectors manager will position this * Inspector supplied button - the inspectors manager will position this
* button for you. * button for you.
*/ */
- (NSButton*) okButton; - (NSButton*) okButton;
/* /**
* Action to take when user clicks the revert button * Action to take when user clicks the revert button
*/ */
- (void) revert: (id)sender; - (void) revert: (id)sender;
/* /**
* Inspector supplied button - the inspectors manager will position this * Inspector supplied button - the inspectors manager will position this
* button for you. * button for you.
*/ */
- (NSButton*) revertButton; - (NSButton*) revertButton;
/* /**
* Extension - not in NeXTstep - this message is sent to your inspector to * Extension - not in NeXTstep - this message is sent to your inspector to
* tell it to set its edited object and make any changes to its UI needed. * tell it to set its edited object and make any changes to its UI needed.
*/ */
- (void) setObject: (id)anObject; - (void) setObject: (id)anObject;
/* /**
* Used to take notice of textfields in inspector being updated. * Used to take notice of textfields in inspector being updated.
*/ */
- (void) textDidBeginEditing: (NSNotification*)aNotification; - (void) textDidBeginEditing: (NSNotification*)aNotification;
/* /**
* Method to mark the inspector as needing saving (ok or revert). * Method to mark the inspector as needing saving (ok or revert).
*/ */
- (void) touch: (id)sender; - (void) touch: (id)sender;
/* /**
* If this method returns YES, the manager will partition off a section of * If this method returns YES, the manager will partition off a section of
* the inspector panel for display of 'ok' and 'revert' buttons, which * the inspector panel for display of 'ok' and 'revert' buttons, which
* your inspector must supply. * your inspector must supply.
*/ */
- (BOOL) wantsButtons; - (BOOL) wantsButtons;
/* /**
* The window that the UI of the inspector exists in. * The window that the UI of the inspector exists in.
*/ */
- (NSWindow*) window; - (NSWindow*) window;