Improved documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@22066 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Fabien Vallon 2005-11-21 16:19:41 +00:00
parent f54ae1349b
commit dde5ad9a25
2 changed files with 19 additions and 6 deletions

View file

@ -6,6 +6,7 @@
* Source/NSCell.m : Improved documentation * Source/NSCell.m : Improved documentation
* Source/NSClipView.m : Improved documentation * Source/NSClipView.m : Improved documentation
* Source/NSColor.m : Improved documentation * Source/NSColor.m : Improved documentation
* Source/NSColorPanel.m : Improved documentation
2005-11-21 Fred Kiefer <FredKiefer@gmx.de> 2005-11-21 Fred Kiefer <FredKiefer@gmx.de>

View file

@ -380,7 +380,7 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
} }
} }
/**<p>Creates ( if needed ) and returns the shared NSColorPanel</p> /**<p>Creates ( if needed ) and returns the shared NSColorPanel.</p>
*/ */
+ (NSColorPanel *)sharedColorPanel + (NSColorPanel *)sharedColorPanel
{ {
@ -399,7 +399,7 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
return _gs_gui_color_panel; return _gs_gui_color_panel;
} }
/** <p>Returns whether the NSColorPanel has been already created</p> /** <p>Returns whether the NSColorPanel has been already created.</p>
*/ */
+ (BOOL) sharedColorPanelExists + (BOOL) sharedColorPanelExists
{ {
@ -485,16 +485,15 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
} }
/** <p>Returns the NSColorPanel's accessory view if it exists, /** <p>Returns the NSColorPanel's accessory view if it exists,
nil otherwise</p><p>See Also: -setAccessoryView:</p> nil otherwise.</p><p>See Also: -setAccessoryView:</p>
*/ */
- (NSView *) accessoryView - (NSView *) accessoryView
{ {
return _accessoryView; return _accessoryView;
} }
/** <p> Returns whether the NSColorPanel continuously sends the action message. /** <p> Returns whether the NSColorPanel continuously sends its action message.
The default is ... </p><p>See Also: -setContinuous:-setAction: -setTarget: </p><p>See Also: -setContinuous:-setAction: -setTarget: </p>
</p>
*/ */
- (BOOL) isContinuous - (BOOL) isContinuous
{ {
@ -528,6 +527,11 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
[_splitView addSubview: _accessoryView]; [_splitView addSubview: _accessoryView];
} }
/**<p>Sets the NSColorPanl action method to <var>aSelector</var> The
action message is usally send in -setColor:, when the picker is updated,
when a new picker is show, when the alpha is changed or when one of the
color well at the bottom is selected</p>
*/
- (void) setAction: (SEL)aSelector - (void) setAction: (SEL)aSelector
{ {
_action = aSelector; _action = aSelector;
@ -564,6 +568,9 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
} }
} }
/** <p>Sets whether the NSColorPanel shows alpha values and the alpha
slider</p><p>See Also: -showsAlpha</p>
*/
- (void) setShowsAlpha: (BOOL)flag - (void) setShowsAlpha: (BOOL)flag
{ {
if (flag == _showsAlpha) if (flag == _showsAlpha)
@ -596,11 +603,16 @@ static int _gs_gui_color_picker_mode = NSRGBModeColorPanel;
[_topView setNeedsDisplay: YES]; [_topView setNeedsDisplay: YES];
} }
/** <p>Sets the target object to <var>anObject</var></p>
*/
- (void) setTarget: (id)anObject - (void) setTarget: (id)anObject
{ {
_target = anObject; _target = anObject;
} }
/** <p>Returns whether the NSColorPanel shows alpha values and the alpha
slider</p><p>See Also: -setShowsAlpha:</p>
*/
- (BOOL) showsAlpha - (BOOL) showsAlpha
{ {
return _showsAlpha; return _showsAlpha;