apps-gorm/GormLib/IBInspector.h
Gregory John Casamento a7690ef937 Completed documentation.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/apps/gorm/trunk@20510 72102866-910b-0410-8b05-ffd578937521
2005-01-01 14:56:11 +00:00

119 lines
2.9 KiB
Objective-C

/* IBInspector.h
*
* Copyright (C) 2003 Free Software Foundation, Inc.
*
* Author: Gregory John Casamento <greg_casamento@yahoo.com>
* Date: 2003
*
* This file is part of GNUstep.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef INCLUDED_IBINSPECTOR_H
#define INCLUDED_IBINSPECTOR_H
#include <Foundation/NSObject.h>
#include <InterfaceBuilder/IBObjectProtocol.h>
#define IVH 388 /* Standard height of inspector view. */
#define IVW 272 /* Standard width of inspector view. */
#define IVB 40 /* Standard height of buttons area. */
// forward references
@class NSWindow;
@class NSButton;
@class NSString;
@class NSView;
@class NSNotification;
@interface IBInspector : NSObject
{
id object;
NSWindow *window;
NSButton *okButton;
NSButton *revertButton;
}
/**
* Releases all the instance variables (apart from the window, which is
* presumed to release itself when closed) and removes self as an observer
* of notifications before destroying self.
*/
- (void) dealloc;
/**
* The first view to be selected in the inspector.
*/
- (NSView*) initialFirstResponder;
/**
* The object being inspected.
*/
- (id) object;
/**
* Action to take when user clicks the OK button
*/
- (void) ok: (id)sender;
/**
* Inspector supplied button - the inspectors manager will position this
* button for you.
*/
- (NSButton*) okButton;
/**
* Action to take when user clicks the revert button
*/
- (void) revert: (id)sender;
/**
* Inspector supplied button - the inspectors manager will position this
* button for you.
*/
- (NSButton*) revertButton;
/**
* 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.
*/
- (void) setObject: (id)anObject;
/**
* Used to take notice of textfields in inspector being updated.
*/
- (void) textDidBeginEditing: (NSNotification*)aNotification;
/**
* Method to mark the inspector as needing saving (ok or revert).
*/
- (void) touch: (id)sender;
/**
* If this method returns YES, the manager will partition off a section of
* the inspector panel for display of 'ok' and 'revert' buttons, which
* your inspector must supply.
*/
- (BOOL) wantsButtons;
/**
* The window that the UI of the inspector exists in.
*/
- (NSWindow*) window;
@end
#endif