mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-23 13:10:52 +00:00
Document some typedefs
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@24351 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald
parent
88facd444e
commit
bc34ad5f62
6 changed files with 93 additions and 18 deletions
|
|
@ -1,3 +1,12 @@
|
|||
2007-01-14 Stefan Bidigaray
|
||||
|
||||
* Source/NSWindow.m:
|
||||
* Source/NSBitmapImageRep.m:
|
||||
* Headers/AppKit/NSBitmapImageRep.h:
|
||||
* Headers/AppKit/NSApplication.h:
|
||||
* Headers/AppKit/NSView.h:
|
||||
Document various bits and pieces, mostly typedefs.
|
||||
|
||||
2007-01-13 Matt Rice <ratmice@gmail.com>
|
||||
|
||||
* Source/NSMatrix.m (_selectCell:atRow:column:): Call setNextState
|
||||
|
|
|
|||
|
|
@ -72,12 +72,28 @@ enum {
|
|||
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
|
||||
#define NSUpdateWindowsRunLoopOrdering 600000
|
||||
|
||||
/**
|
||||
* Returned by -applicationShouldTerminate: when -terminate: is called.
|
||||
* Possible types include:
|
||||
* <example>
|
||||
* NSTerminateCancel;
|
||||
* NSTerminateNow;
|
||||
* NSTerminateLater.
|
||||
* </example>
|
||||
*/
|
||||
typedef enum {
|
||||
NSTerminateCancel = NO,
|
||||
NSTerminateNow = YES,
|
||||
NSTerminateLater
|
||||
} NSApplicationTerminateReply;
|
||||
|
||||
/**
|
||||
* Type used by -requestUserAttention: when an applications opened. Possible values are:
|
||||
* <example>
|
||||
* NSCriticalRequest;
|
||||
* NSInformationalRequest;
|
||||
* </example>
|
||||
*/
|
||||
typedef enum {
|
||||
NSCriticalRequest,
|
||||
NSInformationalRequest
|
||||
|
|
|
|||
|
|
@ -40,6 +40,18 @@
|
|||
@class NSMutableData;
|
||||
@class NSColor;
|
||||
|
||||
/** Describes the type of compression used on an image. Possible compressions:
|
||||
<list>
|
||||
<item> NSTIFFCompressionNone; </item>
|
||||
<item> NSTIFFCompressionCCITTFAX3; </item>
|
||||
<item> NSTIFFCompressionCCITFAX4; </item>
|
||||
<item> NSTIFFCompressionLZW; </item>
|
||||
<item> NSTIFFCompressionOldJPEG; </item>
|
||||
<item> NSTIFFCompressionJPEG; </item>
|
||||
<item> NSTIFFCompressionNEXT; </item>
|
||||
<item> NSTIFFCompressionPackBits. </item>
|
||||
</list>
|
||||
*/
|
||||
typedef enum _NSTIFFCompression {
|
||||
NSTIFFCompressionNone = 1,
|
||||
NSTIFFCompressionCCITTFAX3,
|
||||
|
|
@ -52,6 +64,16 @@ typedef enum _NSTIFFCompression {
|
|||
} NSTIFFCompression;
|
||||
|
||||
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
|
||||
/** Type of image
|
||||
<list>
|
||||
<item> NSTIFFFileType; </item>
|
||||
<item> NSBMPFileType; Not implemented </item>
|
||||
<item> NSGIFFileType; </item>
|
||||
<item> NSJPEGFileType; </item>
|
||||
<item> NSPNGFileType; </item>
|
||||
<item> NSJPEG2000FileType. Not implemented </item>
|
||||
</list>
|
||||
*/
|
||||
typedef enum _NSBitmapImageFileType {
|
||||
NSTIFFFileType = 0,
|
||||
NSBMPFileType = 1,
|
||||
|
|
|
|||
|
|
@ -53,10 +53,14 @@
|
|||
typedef int NSTrackingRectTag;
|
||||
typedef int NSToolTipTag;
|
||||
|
||||
/*
|
||||
* constants representing the four types of borders that
|
||||
* can appear around an NSView
|
||||
*/
|
||||
/** Describes the type of border used by an NSView.
|
||||
<list>
|
||||
<item>NSNoBorder</item>
|
||||
<item>NSLineBorder</item>
|
||||
<item>NSBezelBorder</item>
|
||||
<item>NSGrooveBorder</item>
|
||||
</list>
|
||||
*/
|
||||
typedef enum _NSBorderType {
|
||||
NSNoBorder,
|
||||
NSLineBorder,
|
||||
|
|
|
|||
|
|
@ -784,9 +784,8 @@
|
|||
return [NSData dataWithBytesNoCopy: bytes length: length];
|
||||
}
|
||||
|
||||
/** <p> Returns a data object in the selected format with multiple images. See Also:
|
||||
-representationUsingType:properties: for a list of supported file types. See Also:
|
||||
-setProperty:withValue: for the options supported in the properties.</p>
|
||||
/** <p> Returns a data object in the selected format with multiple images.</p>
|
||||
<p> See Also: -setProperty:withValue: for the options supported in the properties.</p>
|
||||
<p> FIXME: returns only the first image in the array, and only works for
|
||||
NSBitmapImageRep or subclasses thereof. </p>
|
||||
*/
|
||||
|
|
@ -814,17 +813,8 @@
|
|||
|
||||
/** <p> Returns a data object in one of the supported bitmap graphics file types.
|
||||
A limited set of options may be passed via the properties. If the passed in properties is nil,
|
||||
it falls back to the options set with -setProperty:withValue:. Some file types are not
|
||||
implemented yet; they return nil and log an error message.</p>
|
||||
<p> NSBitmapImageFileType </p>
|
||||
<list>
|
||||
<item> NSTIFFFileType = 0; TIFF is supported </item>
|
||||
<item> NSBMPFileType = 1; BMP is not implemented </item>
|
||||
<item> NSGIFFileType = 2; GIF is supported </item>
|
||||
<item> NSJPEGFileType = 3; JPEG is supported </item>
|
||||
<item> NSPNGFileType = 4; PNG is supported </item>
|
||||
<item> NSJPEG2000FileType = 5; JPEG-2000 is not implemented </item>
|
||||
</list>
|
||||
it falls back to the options set with -setProperty:withValue:. File types not yet
|
||||
implemented return nil and log an error message.</p>
|
||||
<p> See Also: -setProperty:withValue: for supported options in the properties. </p>
|
||||
*/
|
||||
- (NSData *)representationUsingType:(NSBitmapImageFileType)storageType
|
||||
|
|
|
|||
|
|
@ -3799,6 +3799,9 @@ resetCursorRectsForView(NSView *theView)
|
|||
return NO;
|
||||
}
|
||||
|
||||
/** If aView responds to -nextValidKeyView with a new NSView, call
|
||||
-makeFirstResponder: for the returned view.
|
||||
*/
|
||||
- (void) selectKeyViewFollowingView: (NSView*)aView
|
||||
{
|
||||
NSView *theView = nil;
|
||||
|
|
@ -3817,6 +3820,9 @@ resetCursorRectsForView(NSView *theView)
|
|||
}
|
||||
}
|
||||
|
||||
/** If aView responds to -previousValidKeyView with a new NSView, call
|
||||
-makeFirstResponder: for this view.
|
||||
*/
|
||||
- (void) selectKeyViewPrecedingView: (NSView*)aView
|
||||
{
|
||||
NSView *theView = nil;
|
||||
|
|
@ -3835,6 +3841,15 @@ resetCursorRectsForView(NSView *theView)
|
|||
}
|
||||
}
|
||||
|
||||
/** This method checks if:
|
||||
<list>
|
||||
<item>_firstResponder answers to -nextValidKeyView</item>
|
||||
<item>_initialFirstResponder answers to -acceptsFirstResponder</item>
|
||||
<item>_initialFirstResponder answers to -previousValidKeyView</item>
|
||||
</list>
|
||||
If any of these checks return a NSView, call -makeFirstResponder: on
|
||||
this NSView.
|
||||
*/
|
||||
- (void) selectNextKeyView: (id)sender
|
||||
{
|
||||
NSView *theView = nil;
|
||||
|
|
@ -3862,6 +3877,15 @@ resetCursorRectsForView(NSView *theView)
|
|||
}
|
||||
}
|
||||
|
||||
/** This method checks if:
|
||||
<list>
|
||||
<item>_firstResponder answers to -previousValidKeyView</item>
|
||||
<item>_initialFirstResponder answers to -acceptsFirstResponder</item>
|
||||
<item>_initialFirstResponder answers to -previousValidKeyView</item>
|
||||
</list>
|
||||
If any of these checks return a NSView, call -makeFirstResponder: on
|
||||
this NSView.
|
||||
*/
|
||||
- (void) selectPreviousKeyView: (id)sender
|
||||
{
|
||||
NSView *theView = nil;
|
||||
|
|
@ -3893,6 +3917,16 @@ resetCursorRectsForView(NSView *theView)
|
|||
// to know whether they have received it from the window, and
|
||||
// if so, in which direction is the selection moving (so that they know
|
||||
// if they should select the last or the first editable cell).
|
||||
/** Returns the value of _selectionDirection, the direction of the
|
||||
current key view.<br />
|
||||
See Also:
|
||||
<list>
|
||||
<item>-selectKeyViewFollowingView:</item>
|
||||
<item>-selectKeyViewPrecedingView:</item>
|
||||
<item>-selectNextKeyView:</item>
|
||||
<item>-selectPreviousKeyView:</item>
|
||||
</list>
|
||||
*/
|
||||
- (NSSelectionDirection) keyViewSelectionDirection
|
||||
{
|
||||
return _selectionDirection;
|
||||
|
|
|
|||
Loading…
Reference in a new issue