libs-gui/Documentation/gsdoc/NSControl.gsdoc
Adam Fedor 05bdcda840 Updated docs
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@12233 72102866-910b-0410-8b05-ffd578937521
2002-01-28 04:50:14 +00:00

688 lines
20 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.7//EN" "http://www.gnustep.org/gsdoc-0_6_7.xml">
<gsdoc base="NSControl" up="Gui">
<head>
<title>NSControl</title>
<author name="Scott Christley">
<email address="scottc@net-community.com">
scottc@net-community.com
</email>
</author>
<author name="Richard Frith-Macdonald">
<email address="richard@brainstorm.co.uk">
richard@brainstorm.co.uk
</email>
</author>
<abstract>The abstract control class</abstract>
<copy>1996 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the NSControl class
</heading>
<class name="NSControl" super="NSView">
<declared>AppKit/NSControl.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<method type="Class" factory="yes">
<sel>cellClass</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void" factory="yes">
<sel>setCellClass:</sel>
<arg type="Class">factoryId</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>abortEditing</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="SEL">
<sel>action</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSTextAlignment">
<sel>alignment</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>calcSize</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="id">
<sel>cell</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSText*">
<sel>currentEditor</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="double">
<sel>doubleValue</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>drawCell:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>drawCellInside:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="float">
<sel>floatValue</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSFont*">
<sel>font</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>ignoresMultiClick</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="id">
<sel>initWithFrame:</sel>
<arg type="NSRect">frameRect</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>intValue</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>isContinuous</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>isEnabled</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>mouseDown:</sel>
<arg type="NSEvent*">theEvent</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="id">
<sel>objectValue</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>performClick:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>refusesFirstResponder</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<NotOpenStep /> <GNUstep /> <MacOS-X />
</standards>
</method>
<method type="void">
<sel>selectCell:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="id">
<sel>selectedCell</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>selectedTag</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>sendAction:</sel>
<arg type="SEL">theAction</arg>
<sel>to:</sel>
<arg type="id">theTarget</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>sendActionOn:</sel>
<arg type="int">mask</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setAction:</sel>
<arg type="SEL">aSelector</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setAlignment:</sel>
<arg type="NSTextAlignment">mode</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setCell:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setContinuous:</sel>
<arg type="BOOL">flag</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setDoubleValue:</sel>
<arg type="double">aDouble</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setEnabled:</sel>
<arg type="BOOL">flag</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setFloatValue:</sel>
<arg type="float">aFloat</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setFloatingPointFormat:</sel>
<arg type="BOOL">autoRange</arg>
<sel>left:</sel>
<arg type="unsigned">leftDigits</arg>
<sel>right:</sel>
<arg type="unsigned">rightDigits</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setFont:</sel>
<arg type="NSFont*">fontObject</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setIgnoresMultiClick:</sel>
<arg type="BOOL">flag</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setIntValue:</sel>
<arg type="int">anInt</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setNeedsDisplay</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setObjectValue:</sel>
<arg type="id">anObject</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setRefusesFirstResponder:</sel>
<arg type="BOOL">flag</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<NotOpenStep /> <GNUstep /> <MacOS-X />
</standards>
</method>
<method type="void">
<sel>setStringValue:</sel>
<arg type="NSString*">aString</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setTag:</sel>
<arg type="int">anInt</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>setTarget:</sel>
<arg type="id">anObject</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>sizeToFit</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="NSString*">
<sel>stringValue</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="int">
<sel>tag</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>takeDoubleValueFrom:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>takeFloatValueFrom:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>takeIntValueFrom:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>takeObjectValueFrom:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>takeStringValueFrom:</sel>
<arg type="id">sender</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="id">
<sel>target</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>updateCell:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>updateCellInside:</sel>
<arg type="NSCell*">aCell</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>validateEditing</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the
NSObject(NSControlDelegate)
category
</heading>
<category name="NSControlDelegate" class="NSObject">
<declared>AppKit/NSControl.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<method type="BOOL">
<sel>control:</sel>
<arg type="NSControl*">control</arg>
<sel>didFailToFormatString:</sel>
<arg type="NSString*">string</arg>
<sel>errorDescription:</sel>
<arg type="NSString*">error</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>control:</sel>
<arg type="NSControl*">control</arg>
<sel>didFailToValidatePartialString:</sel>
<arg type="NSString*">string</arg>
<sel>errorDescription:</sel>
<arg type="NSString*">error</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>control:</sel>
<arg type="NSControl*">control</arg>
<sel>isValidObject:</sel>
<arg type="id">object</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>control:</sel>
<arg type="NSControl*">control</arg>
<sel>textShouldBeginEditing:</sel>
<arg type="NSText*">fieldEditor</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="BOOL">
<sel>control:</sel>
<arg type="NSControl*">control</arg>
<sel>textShouldEndEditing:</sel>
<arg type="NSText*">fieldEditor</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>controlTextDidBeginEditing:</sel>
<arg type="NSNotification*">aNotification</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>controlTextDidChange:</sel>
<arg type="NSNotification*">aNotification</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<method type="void">
<sel>controlTextDidEndEditing:</sel>
<arg type="NSNotification*">aNotification</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</method>
<standards>
<GNUstep /> <MacOS-X /> <OpenStep />
</standards>
</category>
</chapter>
</body>
</gsdoc>