gnustep/libs-gui
0
0
Fork 0
mirror of https://github.com/gnustep/libs-gui.git synced 2025-04-23 09:51:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improved documentation

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22104 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Fabien Vallon 2005-11-25 17:39:23 +00:00
parent 4cc3b3e31c
commit 6963d7b729
2 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ChangeLog
View file

@ -4,6 +4,7 @@
* Source/NSCell.m: Documentation : closed the ref tag for -setType:
* Source/NSBrowser.m: Improved documentation, various cleanups.
* Source/NSBrowserCell.m: Improved documentation.
* Source/NSButton.m: Improved documentation.
2005-11-24 12:33 Gregory John Casamento <greg_casamento@yahoo.com>

35
Source/NSButton.m
View file

@ -39,7 +39,7 @@
static id buttonCellClass = nil;
/**
NSButton implementation
TODO Description
*/
@implementation NSButton
@ -156,9 +156,9 @@ static id buttonCellClass = nil;
/** <p>Gets the NSButtonCell's <var>delay</var> and the <var>interval</var>
parameters used when NSButton sends continouly action messages.
By default <var>delay</var> is 0.4 and <var>interval</var> is 0.075</p>
By default <var>delay</var> is 0.4 and <var>interval</var> is 0.075.</p>
<p>See Also: [NSButtonCell-getPeriodicDelay:interval:]
-setPeriodicDelay:interval:
-setPeriodicDelay:interval:
[NSCell-trackMouse:inRect:ofView:untilMouseUp:]</p>
*/
- (void) getPeriodicDelay: (float *)delay
@ -169,7 +169,7 @@ static id buttonCellClass = nil;
/** <p>Sets the NSButtonCell's <var>delay</var> and <var>interval</var>
parameters used when NSButton sends continouly action messages.
By default <var>delay</var> is 0.4 and <var>interval</var> is 0.075</p>
By default <var>delay</var> is 0.4 and <var>interval</var> is 0.075.</p>
<p>See Also: [NSButtonCell-setPeriodicDelay:interval:]
-getPeriodicDelay:interval:
[NSCell-trackMouse:inRect:ofView:untilMouseUp:]</p>
@ -181,7 +181,7 @@ static id buttonCellClass = nil;
}
/**<p>Returns the NSButtonCell's alternate title.</p>
<p>See Also: -setAlternateTitle:</p>
<p>See Also: -setAlternateTitle: [NSButtonCell-alternateTitle]</p>
*/
- (NSString *) alternateTitle
{
@ -189,7 +189,7 @@ static id buttonCellClass = nil;
}
/**<p>Sets the NSButtonCell's alternateTitle to <var>aString</var> and marks
self for display</p><p>See Also: -alternateTitle</p>
self for display.</p><p>See Also: -alternateTitle</p>
*/
- (void) setAlternateTitle: (NSString *)aString
{
@ -198,7 +198,7 @@ static id buttonCellClass = nil;
}
/**<p>Sets the NSButtonCell's title to <var>aString</var> and marks self for
display</p><p>See Also: -title</p>
display.</p><p>See Also: -title</p>
*/
- (void) setTitle: (NSString *)aString
{
@ -206,7 +206,7 @@ static id buttonCellClass = nil;
[self setNeedsDisplay: YES];
}
/** <p>Returns the NSButtonCell's title</p>
/** <p>Returns the NSButtonCell's title.</p>
<p>See Also: [NSButtonCell-title] -setTitle:</p>
*/
- (NSString *) title
@ -253,8 +253,8 @@ static id buttonCellClass = nil;
return [_cell alternateImage];
}
/** <p>Returns the NSButtonCell's image</p>
<p>See Also: -setImage:</p>
/** <p>Returns the NSButtonCell's image.</p>
<p>See Also: -setImage: [NSButtonCell-image]</p>
*/
- (NSImage *) image
{
@ -263,7 +263,7 @@ static id buttonCellClass = nil;
/** <p>Returns the position of the NSButtonCell's image. See
<ref type="type" id="NSCellImagePosition">NSCellImagePosition</ref>
for more informations</p>
for more information.</p>
<p>See Also: -setImagePosition: [NSButtonCell-imagePosition]</p>
*/
- (NSCellImagePosition) imagePosition
@ -292,7 +292,7 @@ static id buttonCellClass = nil;
/** <p>Sets the postion of the NSButtonCell's image to <var>aPosition</var>
and marks self for display. See <ref type="type" id="NSCellImagePosition">
NSCellImagePosition</ref>for more informations.</p>
NSCellImagePosition</ref>for more information.</p>
<p>See Also: -imagePosition [NSButtonCell-setImagePosition:] </p>
*/
- (void) setImagePosition: (NSCellImagePosition)aPosition
@ -372,7 +372,7 @@ static id buttonCellClass = nil;
//
// Displaying
//
/** <p>(Un)Highlights the NSButtonCell</p>
/** <p>(Un)Highlights the NSButtonCell.</p>
<p>See Also: [NSButtonCell-highlight:withFrame:inView:]</p>
*/
- (void) highlight: (BOOL)flag
@ -492,7 +492,14 @@ static id buttonCellClass = nil;
//
// Handling Events and Action Messages
//
/** TODO
/**<p>Simulates the click of the button if the key equivalent and
its modifier mask match the event <var>anEvent</var>.
By default the key modifier mask is NSCommandKeyMask and there is no
key equivalent</p>
<p>See Also: -keyEquivalent -keyEquivalentModifierMask
[NSControl-performClick:]
[NSEvent-charactersIgnoringModifiers] [NSEvent-modifierFlags]</p>
*/
- (BOOL) performKeyEquivalent: (NSEvent *)anEvent
{