diff --git a/Source/NSButton.m b/Source/NSButton.m index edb867438..f92cc70b0 100644 --- a/Source/NSButton.m +++ b/Source/NSButton.m @@ -82,7 +82,7 @@ static id buttonCellClass = nil; /**
Sets the NSButtonCell's type to aType and marks self for display.See NSButtonType for more - informations.
+ information.See Also: [NSButtonCell-setButtonType:]
*/ - (void) setButtonType: (NSButtonType)aType { @@ -119,7 +119,7 @@ static id buttonCellClass = nil; } /**Sets the NSButtonCell's state to value and marks - self for display.
See Also: -state
+ self for display.See Also: -state [NSButtonCell-setState:]
*/ - (void) setState: (int)value { @@ -127,8 +127,9 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -/**Returns the NSButtonCell's state
-See Also: -setState:
*/ +/**Returns the NSButtonCell's state.
+See Also: -setState: [NSButtonCell-state]
+*/ - (int) state { return [_cell state]; @@ -153,22 +154,33 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -// -// Setting the Repeat Interval -// +/**Gets the NSButtonCell's delay and the interval + parameters used when NSButton sends continouly action messages. + By default delay is 0.4 and interval is 0.075
+See Also: [NSButtonCell-getPeriodicDelay:interval:] + -setPeriodicDelay:interval: + [NSCell-trackMouse:inRect:ofView:untilMouseUp:]
+ */ - (void) getPeriodicDelay: (float *)delay interval: (float *)interval { [_cell getPeriodicDelay: delay interval: interval]; } +/**Sets the NSButtonCell's delay and interval + parameters used when NSButton sends continouly action messages. + By default delay is 0.4 and interval is 0.075
+See Also: [NSButtonCell-setPeriodicDelay:interval:] + -getPeriodicDelay:interval: + [NSCell-trackMouse:inRect:ofView:untilMouseUp:]
+ */ - (void) setPeriodicDelay: (float)delay interval: (float)interval { [_cell setPeriodicDelay: delay interval: interval]; } -/**Returns the NSButtonCell's alternate title
+/**Returns the NSButtonCell's alternate title.
See Also: -setAlternateTitle:
*/ - (NSString *) alternateTitle @@ -176,8 +188,8 @@ static id buttonCellClass = nil; return [_cell alternateTitle]; } -/**Sets the NSButtonCell's alternateTitle to aString and marks self - for display
See Also: -alternateTitle
+/**Sets the NSButtonCell's alternateTitle to aString and marks + self for display
See Also: -alternateTitle
*/ - (void) setAlternateTitle: (NSString *)aString { @@ -185,8 +197,8 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -/**Sets the NSButtonCell's title to aString and marks self for display -
See Also: -title
+/**Sets the NSButtonCell's title to aString and marks self for + display
See Also: -title
*/ - (void) setTitle: (NSString *)aString { @@ -194,7 +206,8 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -/**Returns the NSButtonCell's title
See Also: -setTitle:
+/**Returns the NSButtonCell's title
+See Also: [NSButtonCell-title] -setTitle:
*/ - (NSString *) title { @@ -233,7 +246,7 @@ static id buttonCellClass = nil; // Setting the Images // /**Returns the NSButtonCell's alternate image.
-See Also: -setAlternateImage:
+See Also: -setAlternateImage: [NSButtonCell-alternateImage]
*/ - (NSImage *) alternateImage { @@ -250,16 +263,17 @@ static id buttonCellClass = nil; /**Returns the position of the NSButtonCell's image. See NSCellImagePosition - for more informations.
-See Also: -setImagePosition:
+ for more informations +See Also: -setImagePosition: [NSButtonCell-imagePosition]
*/ - (NSCellImagePosition) imagePosition { return [_cell imagePosition]; } -/**Sets the NSButtonCell's alternate image to anImage and marks self - for display
See Also: -alternateImage
+/**Sets the NSButtonCell's alternate image to anImage and marks + self for display.
+See Also: -alternateImage [NSButtonCell-setAlternateImage:]
*/ - (void) setAlternateImage: (NSImage *)anImage { @@ -267,8 +281,8 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -/**Sets the NSButtonCell's image to anImage and marks self - for display.
See Also: -image
+/**Sets the NSButtonCell's image to anImage and marks self + for display.
See Also: -image [NSButtonCell-setImage:]
*/ - (void) setImage: (NSImage *)anImage { @@ -276,10 +290,10 @@ static id buttonCellClass = nil; [self setNeedsDisplay: YES]; } -/**Sets the postion of the NSButtonCell's image to aPosition +/**
Sets the postion of the NSButtonCell's image to aPosition and marks self for display. See NSCellImagePositionfor more informations.
-See Also: -imagePosition
+See Also: -imagePosition [NSButtonCell-setImagePosition:]
*/ - (void) setImagePosition: (NSCellImagePosition)aPosition { @@ -290,16 +304,16 @@ static id buttonCellClass = nil; // // Modifying Graphic Attributes // -/**Returns whether the NSButton's cell has border. -
See Also: -setBordered:
+/**Returns whether the NSButton's cell has border.
+See Also: -setBordered: [NSButtonCell-isBordered]
*/ - (BOOL) isBordered { return [_cell isBordered]; } -/**Returns whether the NSButton's cell is transparent
-See Also: -setTransparent:
+/**Returns whether the NSButton's cell is transparent.
+See Also: -setTransparent: [NSButtonCell-isTransparent]
*/ - (BOOL) isTransparent { @@ -307,8 +321,7 @@ static id buttonCellClass = nil; } /**Sets whether the NSButton's cell has border and marks self for - display.
-See Also: -isBordered
+ display.See Also: -isBordered [NSButtonCell-setBordered:]
*/ - (void) setBordered: (BOOL)flag { @@ -317,7 +330,7 @@ static id buttonCellClass = nil; } /**Sets whether the NSButton's cell is transparent and marks self for - display
See Also: -isTransparent
+ display.See Also: -isTransparent [NSButtonCell-setTransparent:]
*/ - (void) setTransparent: (BOOL)flag { @@ -327,7 +340,7 @@ static id buttonCellClass = nil; /**Returns the style of the NSButtonCell's bezeled border. See NSBezelStyle for more - informations
See Also: -setBezelStyle:
+ information.See Also: -setBezelStyle: [NSButtonCell-bezelStyle]
*/ - (NSBezelStyle)bezelStyle { @@ -336,7 +349,8 @@ static id buttonCellClass = nil; /**Sets the style of the NSButtonCell's bezeled border and marks self for display. See NSBezelStyle - for more informations
See Also: -bezelStyle
+ for more information. +See Also: -bezelStyle [NSButtonCell-setBezelStyle:]
*/ - (void)setBezelStyle:(NSBezelStyle)bezelStyle { @@ -358,7 +372,8 @@ static id buttonCellClass = nil; // // Displaying // -/** TODO +/**(Un)Highlights the NSButtonCell
+See Also: [NSButtonCell-highlight:withFrame:inView:]
*/ - (void) highlight: (BOOL)flag { @@ -368,8 +383,12 @@ static id buttonCellClass = nil; // // Setting the Key Equivalent // -/**Returns the NSButtonCell's key equivalent. This is used in - -performKeyEquivalent: ... TODO
See Also: -setKeyEquivalent:
+/**Returns the NSButtonCell's key equivalent. The key equivalent and its + modifier mask are used to simulate the click of the button in + -performKeyEquivalent:. Returns an empty string if no key equivalent is + defined. By default NSButton hasn't key equivalent.
+See Also: -setKeyEquivalent: -performKeyEquivalent: + -keyEquivalentModifierMask [NSButtonCell-keyEquivalent]
*/ - (NSString*) keyEquivalent { @@ -377,25 +396,34 @@ static id buttonCellClass = nil; } /**Returns the modifier mask of the NSButtonCell's key equivalent. - This is used in -performKeyEquivalent: ... TODO
-See Also: -setKeyEquivalentModifierMask:
+ The key equivalent and its modifier mask are used to simulate the click + of the button in -performKeyEquivalent: . The default mask is + NSCommandKeyMask.See Also: -setKeyEquivalentModifierMask: + -keyEquivalent [NSButtonCell-setKeyEquivalentModifierMask:]
*/ - (unsigned int) keyEquivalentModifierMask { return [_cell keyEquivalentModifierMask]; } -/**Sets the NSButtonCell's key equivalent.This is used in - -performKeyEquivalent:
See Also: -keyEquivalent
+/**Sets the NSButtonCell's key equivalent to aKeyEquivalent. + The key equivalent and its modifier mask are used to simulate the click + of the button in -performKeyEquivalent:. By default NSButton hasn't + key equivalent.
See Also: -keyEquivalent + -setKeyEquivalentModifierMask: -performKeyEquivalent: + [NSButtonCell-setKeyEquivalent:]
*/ - (void) setKeyEquivalent: (NSString*)aKeyEquivalent { [_cell setKeyEquivalent: aKeyEquivalent]; } -/**Sets the modifier mask of the NSButtonCell's key equivalent. - This is used in -performKeyEquivalent:
-See Also: -keyEquivalentModifierMask
+/**Sets the modifier mask of the NSButtonCell's key equivalent to + mask. The key equivalent and its modifier mask are used to + simulate the click of the button in -performKeyEquivalent:. By default + the mask is NSCommandKeyMask.
See Also: -keyEquivalentModifierMask + -setKeyEquivalent: -performKeyEquivalent: + [NSButtonCell-setKeyEquivalentModifierMask:]
*/ - (void) setKeyEquivalentModifierMask: (unsigned int)mask {