libs-gui/Headers/AppKit/NSRulerView.h
Richard Frith-Macdonald ba2eea830f Fix for behavior dependent on bug in base library exception raising.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@21388 72102866-910b-0410-8b05-ffd578937521
2005-07-01 06:43:25 +00:00

174 lines
5.1 KiB
Objective-C

/* -*-objc-*-
NSRulerView.h
The NSRulerView class.
Copyright (C) 1999-2002 Free Software Foundation, Inc.
Author: Michael Hanni <mhanni@sprintmail.com>
Date: Feb 1999
Author: Fred Kiefer <FredKiefer@gmx.de>
Date: Sept 2001
Author: Diego Kreutz (kreutz@inf.ufsm.br)
Date: January 2002
This file is part of the GNUstep GUI 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; see the file COPYING.LIB.
If not, write to the Free Software Foundation,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef _GNUstep_H_NSRulerView
#define _GNUstep_H_NSRulerView
#include <AppKit/NSView.h>
/* Declaring classes, rather than #including the full class header,
* results in much faster compilations. */
@class NSScrollView;
@class NSString;
@class NSArray;
@class NSRulerMarker;
@class NSCoder;
@class NSEvent;
typedef enum {
NSHorizontalRuler,
NSVerticalRuler
} NSRulerOrientation;
@class GSRulerUnit;
@interface NSRulerView : NSView
{
GSRulerUnit *_unit;
NSScrollView *_scrollView;
NSView *_clientView; // Not retained
NSView *_accessoryView;
float _originOffset;
NSMutableArray *_markers;
NSRulerOrientation _orientation;
float _ruleThickness;
float _reservedThicknessForAccessoryView;
float _reservedThicknessForMarkers;
/* Cached values. It's a little expensive to calculate them and they
* change only when the unit or the originOffset is changed or when
* clientView changes it's size or zooming factor. This cache is
* invalidated by -invalidateHashMarks method. */
BOOL _cacheIsValid;
float _markDistance;
float _labelDistance;
int _marksToBigMark;
int _marksToMidMark;
int _marksToLabel;
float _UNUSED;
float _unitToRuler;
NSString *_labelFormat;
}
- (id) initWithScrollView: (NSScrollView *)aScrollView
orientation: (NSRulerOrientation)o;
+ (void) registerUnitWithName: (NSString *)uName
abbreviation:(NSString *)abbreviation
unitToPointsConversionFactor:(float)conversionFactor
stepUpCycle:(NSArray *)stepUpCycle
stepDownCycle:(NSArray *)stepDownCycle;
- (void) setMeasurementUnits: (NSString *)uName;
- (NSString *) measurementUnits;
- (void) setClientView: (NSView *)aView;
- (NSView *) clientView;
- (void) setAccessoryView: (NSView *)aView;
- (NSView *) accessoryView;
- (void) setOriginOffset: (float)offset;
- (float) originOffset;
- (void) setMarkers: (NSArray *)newMarkers;
- (NSArray *) markers;
- (void) addMarker: (NSRulerMarker *)aMarker;
- (void) removeMarker: (NSRulerMarker *)aMarker;
- (BOOL) trackMarker: (NSRulerMarker *)aMarker
withMouseEvent: (NSEvent *)theEvent;
- (void) moveRulerlineFromLocation: (float)oldLoc toLocation: (float)newLoc;
- (void) drawHashMarksAndLabelsInRect: (NSRect)aRect;
- (void) drawMarkersInRect: (NSRect)aRect;
- (void) invalidateHashMarks;
- (void) setScrollView:(NSScrollView *) scrollView;
- (NSScrollView *) scrollView;
- (void) setOrientation: (NSRulerOrientation)o;
- (NSRulerOrientation) orientation;
- (void) setReservedThicknessForAccessoryView: (float)thickness;
- (float) reservedThicknessForAccessoryView;
- (void) setReservedThicknessForMarkers: (float)thickness;
- (float) reservedThicknessForMarkers;
- (void) setRuleThickness: (float)thickness;
- (float) ruleThickness;
- (float) requiredThickness;
- (float) baselineLocation;
- (BOOL) isFlipped;
@end
/*
* Methods Implemented by the client view ... FIXME/TODO: we currently
* do not send all these messages to the client view ... while we
* should!
*/
@interface NSObject (NSRulerViewClientView)
- (void)rulerView: (NSRulerView *)aRulerView
didAddMarker: (NSRulerMarker *)aMarker;
- (void)rulerView: (NSRulerView *)aRulerView
didMoveMarker: (NSRulerMarker *)aMarker;
- (void)rulerView: (NSRulerView *)aRulerView
didRemoveMarker: (NSRulerMarker *)aMarker;
- (void)rulerView: (NSRulerView *)aRulerView
handleMouseDown: (NSEvent *)theEvent;
- (BOOL)rulerView: (NSRulerView *)aRulerView
shouldAddMarker: (NSRulerMarker *)aMarker;
- (BOOL)rulerView: (NSRulerView *)aRulerView
shouldMoveMarker: (NSRulerMarker *)aMarker;
- (BOOL)rulerView: (NSRulerView *)aRulerView
shouldRemoveMarker: (NSRulerMarker *)aMarker;
- (float)rulerView: (NSRulerView *)aRulerView
willAddMarker: (NSRulerMarker *)aMarker
atLocation: (float)location;
- (float)rulerView: (NSRulerView *)aRulerView
willMoveMarker: (NSRulerMarker *)aMarker
toLocation: (float)location;
- (void)rulerView: (NSRulerView *)aRulerView
willSetClientView: (NSView *)newClient;
@end
#endif /* _GNUstep_H_NSRulerView */