gnustep/libs-gui
0
0
Fork 0
mirror of https://github.com/gnustep/libs-gui.git synced 2025-06-04 18:30:40 +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@22036 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Fabien_ 2005-11-18 14:10:02 +00:00
parent f04b285fe9
commit 3b59ac43ce
2 changed files with 24 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

1
ChangeLog
View file

@ -5,6 +5,7 @@
* Source/NSTextFieldCell.m: Improved documentation * Source/NSTextFieldCell.m: Improved documentation
* Source/NSSavePanel.m: Improved documentation * Source/NSSavePanel.m: Improved documentation
* Source/NSOpenPanel.m: Improved documentation * Source/NSOpenPanel.m: Improved documentation
* Source/NSApplication.m: Improved documentation
2005-11-17 fabien <fabien@sonappart.net> 2005-11-17 fabien <fabien@sonappart.net>

45
Source/NSApplication.m
View file

@ -1461,7 +1461,7 @@ static NSSize scaledIconSizeForSize(NSSize imageSize)
/** /**
* Starts modal event loop for given window, after calling * Starts modal event loop for given window, after calling
* -beginModalSessionForWindow:. Loop is broken only by stopModal: , * -beginModalSessionForWindow:. Loop is broken only by -stopModal ,
* -stopModalWithCode: , or -abortModal , at which time -endModalSession: * -stopModalWithCode: , or -abortModal , at which time -endModalSession:
* is called automatically. * is called automatically.
*/ */
@ -1660,10 +1660,10 @@ See -runModalForWindow:
} }
} }
/** /**<p> Stops a running modal session causing -runModalForWindow: or
* Stops a running modal session causing -runModalForWindow: or
* -runModalSession: to return <code>NSRunStoppedResponse</code>. Use this * -runModalSession: to return <code>NSRunStoppedResponse</code>. Use this
* or -stopModalWithCode: to end a modal session in response to user input. * or -stopModalWithCode: to end a modal session in response to user input.</p>
* <p>See Also: -stopModalWithCode:</p>
*/ */
- (void) stopModal - (void) stopModal
{ {
@ -2101,10 +2101,9 @@ IF_NO_GC(NSAssert([event retainCount] > 0, NSInternalInconsistencyException));
return NO; return NO;
} }
/** /**<p>Sets the application's icon. Any windows that use the old application
Sets the application's icon. Any windows that use the old application
icon image as their mini window image will be updated to use the new icon image as their mini window image will be updated to use the new
image. image.</p><p>See Also: -applicationIconImage</p>
*/ */
- (void) setApplicationIconImage: (NSImage*)anImage - (void) setApplicationIconImage: (NSImage*)anImage
{ {
@ -2132,8 +2131,8 @@ image.
DESTROY(old_app_icon); DESTROY(old_app_icon);
} }
/** /**<p>Returns the current icon be used for the application.</p>
* Returns the current icon be used for the application. <p>See Also: -setApplicationIconImage:</p>
*/ */
- (NSImage*) applicationIconImage - (NSImage*) applicationIconImage
{ {
@ -2153,13 +2152,12 @@ image.
* Hiding and arranging windows * Hiding and arranging windows
*/ */
/** /**<p> Request this application to "hide" (unmap all windows from the screen
* Request this application to "hide" (unmap all windows from the screen
* except the icon window). Posts * except the icon window). Posts
* <code>NSApplicationWillHideNotification</code> and * <code>NSApplicationWillHideNotification</code> and
* <code>NSApplicationDidHideNotification</code>. On OS X this activates * <code>NSApplicationDidHideNotification</code>. On OS X this activates
* the next app that is running, however on GNUstep this is up to the window * the next app that is running, however on GNUstep this is up to the window
* manager. * manager.</p><p>See Also: -unhide: -isHidden</p>
*/ */
- (void) hide: (id)sender - (void) hide: (id)sender
{ {
@ -2211,16 +2209,16 @@ image.
} }
} }
/** /**<p>Returns whether app is currently in hidden state.</p>
* Returns whether app is currently in hidden state. <p>See Also: -hide: -unhide:</p>
*/ */
- (BOOL) isHidden - (BOOL) isHidden
{ {
return _app_is_hidden; return _app_is_hidden;
} }
/** /**<p>Unhides and activates this application.</p>
* Unhides and activates this application. <p>See Also: -unhideWithoutActivation -hide: -isHidden</p>
*/ */
- (void) unhide: (id)sender - (void) unhide: (id)sender
{ {
@ -2932,27 +2930,26 @@ image.
returnTypes: returnTypes]; returnTypes: returnTypes];
} }
/** /** <p>Returns the services menu of the receiver.</p>
* Return the services menu of the receiver. <p>See Also: -setServicesMenu:</p>
*/ */
- (NSMenu *) servicesMenu - (NSMenu *) servicesMenu
{ {
return [_listener servicesMenu]; return [_listener servicesMenu];
} }
/** /**<p> Returns the services provided previously registered using the
* Returns the services provided previously registered using the * -setServicesProvider: method.</p><p>See Also: -setServicesProvider:</p>
* -setServicesProvider: method.
*/ */
- (id) servicesProvider - (id) servicesProvider
{ {
return [_listener servicesProvider]; return [_listener servicesProvider];
} }
/** /**<p>ets the services menu for the receiver. This should be called, otherwise
* Sets the services menu for the receiver. This should be called, otherwise
* warnings will be generated by the main event loop, which is in charge of * warnings will be generated by the main event loop, which is in charge of
* updating all menus, including the Services menu. * updating all menus, including the Services menu.</p>
* <p>See Also: -servicesMenu</p>
*/ */
- (void) setServicesMenu: (NSMenu *)aMenu - (void) setServicesMenu: (NSMenu *)aMenu
{ {