Added makefile and tidied

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@6443 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2000-04-10 05:22:48 +00:00
parent 689482814c
commit d8b3b7f84a
4 changed files with 193 additions and 106 deletions

View file

@ -0,0 +1,142 @@
#
# doc makefile for the GNUstep Gui Library
# Copyright (C) 2000 Free Software Foundation, Inc.
#
# Written by: Richard Frith-Macdonald <rfm@gnu.org>
#
# This file is part of the GNUstep Base Library.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Library General Public License for more details.
#
# You should have received a copy of the GNU Library General Public
# License along with this library; if not, write to the Free
# Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
# Install into the system root by default
GNUSTEP_INSTALLATION_DIR = $(GNUSTEP_SYSTEM_ROOT)
GNUSTEP_MAKEFILES = $(GNUSTEP_SYSTEM_ROOT)/Makefiles
include $(GNUSTEP_MAKEFILES)/common.make
# The documents to be generated
DOCUMENT_NAME = Gui
Gui_GSDOC_FILES = Gui.gsdoc \
Introduction.gsdoc \
NSActionCell.gsdoc \
NSAffineTransform.gsdoc \
NSApplication.gsdoc \
NSAttributedStrngAdds.gsdoc \
NSBezierPath.gsdoc \
NSBitmapImageRep.gsdoc \
NSBox.gsdoc \
NSBrowser.gsdoc \
NSBrowserCell.gsdoc \
NSBundleAdditions.gsdoc \
NSButton.gsdoc \
NSButtonCell.gsdoc \
NSCachedImageRep.gsdoc \
NSCell.gsdoc \
NSClipView.gsdoc \
NSCoderAdditions.gsdoc \
NSColor.gsdoc \
NSColorList.gsdoc \
NSColorPanel.gsdoc \
NSColorPicker.gsdoc \
NSColorWell.gsdoc \
NSComboBox.gsdoc \
NSComboBoxCell.gsdoc \
NSControl.gsdoc \
NSCursor.gsdoc \
NSCustomImageRep.gsdoc \
NSDPSContext.gsdoc \
NSDocument.gsdoc \
NSDocumentController.gsdoc \
NSEPSImageRep.gsdoc \
NSEvent.gsdoc \
NSFileWrapper.gsdoc \
NSFont.gsdoc \
NSFontManager.gsdoc \
NSFontPanel.gsdoc \
NSForm.gsdoc \
NSFormCell.gsdoc \
NSGraphicsContext.gsdoc \
NSHelpManager.gsdoc \
NSImage.gsdoc \
NSImageCell.gsdoc \
NSImageRep.gsdoc \
NSImageView.gsdoc \
NSInputManager.gsdoc \
NSInputServer.gsdoc \
NSLayoutManager.gsdoc \
NSMatrix.gsdoc \
NSMenu.gsdoc \
NSMenuItem.gsdoc \
NSMenuItemCell.gsdoc \
NSMenuView.gsdoc \
NSMutableAttributedStringAdditions.gsdoc \
NSMutableParagraphStyle.gsdoc \
NSOpenPanel.gsdoc \
NSPICTImageRep.gsdoc \
NSPageLayout.gsdoc \
NSPanel.gsdoc \
NSParagraphStyle.gsdoc \
NSPasteboard.gsdoc \
NSPopUpButton.gsdoc \
NSPopUpButtonCell.gsdoc \
NSPrintInfo.gsdoc \
NSPrintOperation.gsdoc \
NSPrintPanel.gsdoc \
NSPrinter.gsdoc \
NSProgressIndicator.gsdoc \
NSResponder.gsdoc \
NSRulerMarker.gsdoc \
NSRulerView.gsdoc \
NSSavePanel.gsdoc \
NSScreen.gsdoc \
NSScrollView.gsdoc \
NSScroller.gsdoc \
NSSecureTextField.gsdoc \
NSSecureTextFieldCell.gsdoc \
NSSlider.gsdoc \
NSSliderCell.gsdoc \
NSSpellChecker.gsdoc \
NSSpellServer.gsdoc \
NSSplitView.gsdoc \
NSStringAdditions.gsdoc \
NSTabView.gsdoc \
NSTabViewItem.gsdoc \
NSTableColumn.gsdoc \
NSTableHeaderCell.gsdoc \
NSTableHeaderView.gsdoc \
NSTableView.gsdoc \
NSText.gsdoc \
NSTextAttachment.gsdoc \
NSTextAttachmentCell.gsdoc \
NSTextContainer.gsdoc \
NSTextField.gsdoc \
NSTextFieldCell.gsdoc \
NSTextStorage.gsdoc \
NSTextTab.gsdoc \
NSTextView.gsdoc \
NSView.gsdoc \
NSWindow.gsdoc \
NSWindowController.gsdoc \
NSWorkspace.gsdoc
-include Makefile.preamble
-include GNUmakefile.local
include $(GNUSTEP_MAKEFILES)/documentation.make
-include Makefile.postamble

View file

@ -1,8 +1,8 @@
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.5//EN" "http://www.gnustep.org/gsdoc-0_6_5.xml">
<gsdoc base="AppKit">
<gsdoc base="Gui">
<head>
<title>AppKit</title>
<title>Gui</title>
<author name="Richard Frith-Macdonald">
<email address="rfm@gnu.org"/>
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
@ -12,11 +12,12 @@
</head>
<body>
<chapter>
<heading>AppKit</heading>
<heading>Gui</heading>
<p>
Nicola Pero has begun work on writing an
<uref url="Introduction.html">introduction</uref>
to the basic concepts and use of the GNUstep GUI library (AppKit).
to the basic concepts and use of the GNUstep GUI library - a free
software library compatible with the OpenStep Application Kit (tm).
</p>
<p>
We also have reference documentation for the classes, though this is

View file

@ -1,8 +1,8 @@
<html><head>
<title>AppKit</title>
<title>Gui</title>
</head>
<body>
<h1>AppKit</h1>
<h1>Gui</h1>
<h3>Authors</h3>
<dl>
<dt><a href="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
@ -10,12 +10,13 @@
</dl>
<p>Version: 0.1</p>
<p>Date: 5 March, 2000</p>
<h2><a name="cont-0">AppKit</a></h2>
<h2><a name="cont-0">Gui</a></h2>
<p>
Nicola Pero has begun work on writing an
<a href="Introduction.html">introduction</a>
to the basic concepts and use of the GNUstep GUI library (AppKit).
to the basic concepts and use of the GNUstep GUI library - a free
software library compatible with the OpenStep Application Kit (tm).
</p>
<p>

View file

@ -23,17 +23,13 @@
</p>
<hr>
<p>
<p>
An NSSliderCell controls the behaviour and appearance of an associated NSSlider,
or a single slider in an NSMatrix. Tick marks are defined in the official
standard, but are not implemented in GNUstep.</p>
<p>
<p>
An NSSliderCell can be customized through its <code>set...</code> methods.
If these do not provide enough customization, a subclass can be created, which
overrides any of the follwing methods: <code>knobRectFlipped:</code>,
@ -80,17 +76,13 @@ An NSSliderCell can be customized through its <code>set...</code> methods.
<h2><a name="method-0">prefersTrackingUntilMouseUp</a></h2>
+ (BOOL) <b>prefersTrackingUntilMouseUp</b><br>
<p>
<p>
The default implementation returns <code>YES</code>, so that the slider
continues to track the user's movement even if the cursor leaves the slider's
track.</p>
<p>
<p>
Do not call this method directly. Override it in subclasses where the tracking
behaviour needs to be different.</p>
@ -99,8 +91,7 @@ Do not call this method directly. Override it in subclasses where the tracking
<h2><a name="method-1">allowsTickMarkValuesOnly</a></h2>
- (BOOL) <b>allowsTickMarkValuesOnly</b><br>
<p>
<p>
As of yet, unimplemented.</p>
@ -108,8 +99,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-2">altIncrementValue</a></h2>
- (double) <b>altIncrementValue</b><br>
<p>
<p>
Returns the value by which the slider is incremented when the user holds down
the ALT key.</p>
@ -118,8 +108,7 @@ Returns the value by which the slider is incremented when the user holds down
<h2><a name="method-3">closestTickMarkValueToValue:</a></h2>
- (double) <b>closestTickMarkValueToValue:</b> (double)aValue<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -127,25 +116,16 @@ As of yet, unimplemented.</p>
<h2><a name="method-4">drawBarInside:flipped:</a></h2>
- (void) <b>drawBarInside:</b> (NSRect)aRect <b>flipped:</b> (BOOL)flipped<br>
<p>
<p>
Draws the slider's track, not including the bezel, in <var>aRect</var></p>
<p>
<p>
<var>flipped</var> indicates whether the control view has a flipped
coordinate system.</p>
<p>
<p>
Do not call this method directly, it is provided for subclassing only.</p>
@ -153,17 +133,13 @@ Do not call this method directly, it is provided for subclassing only.</p>
<h2><a name="method-5">drawKnob</a></h2>
- (void) <b>drawKnob</b><br>
<p>
<p>
Calculates the rect in which to draw the knob, then calls <code>drawKnob</code>
Before calling this method, a <code>lockFocus</code> message must be sent to the
cell's control view.</p>
<p>
<p>
When subclassing NSSliderCell, do not override this method. Override
<code>drawKnob:</code> instead.</p>
@ -172,16 +148,12 @@ When subclassing NSSliderCell, do not override this method. Override
<h2><a name="method-6">drawKnob:</a></h2>
- (void) <b>drawKnob:</b> (NSRect)knobRect<br>
<p>
<p>
Draws the knob in <var>knobRect</var>. Before calling this method, a
<code>lockFocus</code> message must be sent to the cell's control view.</p>
<p>
<p>
Do not call this method directly. It is included for subclassing only.</p>
@ -189,8 +161,7 @@ Do not call this method directly. It is included for subclassing only.</p>
<h2><a name="method-7">indexOfTickMarkAtPoint:</a></h2>
- (int) <b>indexOfTickMarkAtPoint:</b> (NSPoint)point<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -198,8 +169,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-8">isVertical</a></h2>
- (int) <b>isVertical</b><br>
<p>
<p>
Returns whether or not the slider is vertical. If, for some reason, this cannot
be determined, for such reasons as the slider is not yet displayed, this method
returns -1. Generally, a slider is considered vertical if its height is greater
@ -210,10 +180,7 @@ Returns whether or not the slider is vertical. If, for some reason, this cannot
<h2><a name="method-9">knobRectFlipped:</a></h2>
- (NSRect) <b>knobRectFlipped:</b> (BOOL)flipped<br>
<p>
<p>
Returns the rect in which to draw the knob, based on the coordinate system
of the NSSlider or NSMatrix this NSSliderCell is associated with.
<var>flipped</var> indicates whether or not that coordinate system is flipped,
@ -221,8 +188,7 @@ Returns the rect in which to draw the knob, based on the coordinate system
associated NSSlider or NSMatrix.</p>
<p>
<p>
Do not call this method directly. It is included for subclassing only.</p>
@ -230,8 +196,7 @@ Do not call this method directly. It is included for subclassing only.</p>
<h2><a name="method-10">knobThickness</a></h2>
- (float) <b>knobThickness</b><br>
<p>
<p>
Returns the thickness of the slider's knob. This value is in pixels, and is the
size of the knob along the slider's track.</p>
@ -240,8 +205,7 @@ Returns the thickness of the slider's knob. This value is in pixels, and is the
<h2><a name="method-11">maxValue</a></h2>
- (double) <b>maxValue</b><br>
<p>
<p>
Returns the maximum value that the slider represents.</p>
@ -249,8 +213,7 @@ Returns the maximum value that the slider represents.</p>
<h2><a name="method-12">minValue</a></h2>
- (double) <b>minValue</b><br>
<p>
<p>
Returns the minimum value that the slider represents.</p>
@ -258,8 +221,7 @@ Returns the minimum value that the slider represents.</p>
<h2><a name="method-13">numberOfTickMarks</a></h2>
- (int) <b>numberOfTickMarks</b><br>
<p>
<p>
As of yet, unimplemented.</p>
@ -267,8 +229,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-14">rectOfTickMarkAtIndex:</a></h2>
- (NSRect) <b>rectOfTickMarkAtIndex:</b> (int)index<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -276,8 +237,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-15">setAllowsTickMarkValuesOnly:</a></h2>
- (void) <b>setAllowsTickMarkValuesOnly:</b> (BOOL)flag<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -285,8 +245,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-16">setAltIncrementValue:</a></h2>
- (void) <b>setAltIncrementValue:</b> (double)increment<br>
<p>
<p>
Sets the value by which the slider will be be incremented when with the
ALT key down to <var>increment</var>.</p>
@ -295,8 +254,7 @@ Sets the value by which the slider will be be incremented when with the
<h2><a name="method-17">setKnobThickness:</a></h2>
- (void) <b>setKnobThickness:</b> (float)thickness<br>
<p>
<p>
Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
sets the amount of space which the knob takes up in the slider's track.</p>
@ -305,8 +263,7 @@ Sets the thickness of the knob to <var>thickness</var>, in pixels. This value
<h2><a name="method-18">setMaxValue:</a></h2>
- (void) <b>setMaxValue:</b> (double)aDouble<br>
<p>
<p>
Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
@ -314,8 +271,7 @@ Sets the maximum value that the sliders represents to <var>maxValue</var>.</p>
<h2><a name="method-19">setMinValue:</a></h2>
- (void) <b>setMinValue:</b> (double)aDouble<br>
<p>
<p>
Sets the minimum value that the sliders represents to <var>maxValue</var>.</p>
@ -323,8 +279,7 @@ Sets the minimum value that the sliders represents to <var>maxValue</var>.</p>
<h2><a name="method-20">setNumberOfTickMarks:</a></h2>
- (void) <b>setNumberOfTickMarks:</b> (int)numberOfTickMarks<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -332,8 +287,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-21">setTickMarkPosition:</a></h2>
- (void) <b>setTickMarkPosition:</b> (NSTickMarkPosition)position<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -341,8 +295,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-22">setTitle:</a></h2>
- (void) <b>setTitle:</b> (NSString*)title<br>
<p>
<p>
Sets the title of the slider to <var>barTitle</var>. This title is displayed
on the slider's track, behind the knob.</p>
@ -351,8 +304,7 @@ Sets the title of the slider to <var>barTitle</var>. This title is displayed
<h2><a name="method-23">setTitleCell:</a></h2>
- (void) <b>setTitleCell:</b> (NSCell*)aCell<br>
<p>
<p>
Sets the cell used to draw the title to <var>titleCell</var>.</p>
@ -360,8 +312,7 @@ Sets the cell used to draw the title to <var>titleCell</var>.</p>
<h2><a name="method-24">setTitleColor:</a></h2>
- (void) <b>setTitleColor:</b> (NSColor*)color<br>
<p>
<p>
Sets the colour with which the title will be drawn to <var>color</var>.</p>
@ -369,8 +320,7 @@ Sets the colour with which the title will be drawn to <var>color</var>.</p>
<h2><a name="method-25">setTitleFont:</a></h2>
- (void) <b>setTitleFont:</b> (NSFont*)font<br>
<p>
<p>
Sets the font with which the title will be drawm to <var>font</var>.</p>
@ -378,8 +328,7 @@ Sets the font with which the title will be drawm to <var>font</var>.</p>
<h2><a name="method-26">tickMarkPosition</a></h2>
- (NSTickMarkPosition) <b>tickMarkPosition</b><br>
<p>
<p>
As of yet, unimplemented.</p>
@ -387,8 +336,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-27">tickMarkValueAtIndex:</a></h2>
- (double) <b>tickMarkValueAtIndex:</b> (int)index<br>
<p>
<p>
As of yet, unimplemented.</p>
@ -396,8 +344,7 @@ As of yet, unimplemented.</p>
<h2><a name="method-28">title</a></h2>
- (NSString*) <b>title</b><br>
<p>
<p>
Returns the title of the slider as an <code>NSString</code>.</p>
@ -405,8 +352,7 @@ Returns the title of the slider as an <code>NSString</code>.</p>
<h2><a name="method-29">titleCell</a></h2>
- (id) <b>titleCell</b><br>
<p>
<p>
Returns the cell used to draw the title.</p>
@ -414,8 +360,7 @@ Returns the cell used to draw the title.</p>
<h2><a name="method-30">titleColor</a></h2>
- (NSColor*) <b>titleColor</b><br>
<p>
<p>
Returns the colour used to draw the title.</p>
@ -423,8 +368,7 @@ Returns the colour used to draw the title.</p>
<h2><a name="method-31">titleFont</a></h2>
- (NSFont*) <b>titleFont</b><br>
<p>
<p>
Returns the font used to draw the title.</p>
@ -432,8 +376,7 @@ Returns the font used to draw the title.</p>
<h2><a name="method-32">trackRect</a></h2>
- (NSRect) <b>trackRect</b><br>
<p>
<p>
Returns the rect of the track, minus the bezel.</p>