Source/BSSourceView.h

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2011, Blue Static <http://www.bluestatic.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
  10  * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16
  17 #import <Cocoa/Cocoa.h>
  18
  19 @class BSLineNumberRulerView;
  20 @protocol BSSourceViewDelegate;
  21 @class BSSourceViewTextView;
  22
  23 // A BSSourceView is a view that contains an NSTextView that also has a line
  24 // number ruler. This class wraps synchronization management between the text
  25 // field and the line numbmering and marker drawing.
  26 //
  27 // Rather than setting the string of the text view directly, use the provided
  28 // methods to load from a file path or to load a string as a virtual file.
  29 @interface BSSourceView : NSView {
  30  @private
  31   BSSourceViewTextView* textView_;
  32   BSLineNumberRulerView* ruler_;
  33   NSScrollView* scrollView_;
  34
  35   // Set of Breakpoint objects.
  36   NSSet* markers_;
  37
  38   NSString* file_;
  39   NSUInteger markedLine_;
  40
  41   id<BSSourceViewDelegate> delegate_;
  42 }
  43
  44 @property (readonly) NSTextView* textView;
  45 @property (readonly) NSScrollView* scrollView;
  46 @property (retain) NSSet* markers;
  47 @property (nonatomic, assign) NSString* file;
  48 @property (assign) NSUInteger markedLine;
  49 @property (assign) id delegate;
  50
  51 - (void)setFile:(NSString*)f;
  52 - (void)setString:(NSString*)source asFile:(NSString*)path;
  53 - (void)scrollToLine:(NSUInteger)line;
  54
  55 @end
  56
  57 // Delegate ////////////////////////////////////////////////////////////////////
  58
  59 @protocol BSSourceViewDelegate <NSObject>
  60 @optional
  61
  62 // Notifies the delegate that the gutter was clicked at a certain line.
  63 - (void)gutterClickedAtLine:(NSUInteger)line forFile:(NSString*)file;
  64
  65 // Whether to accept a file drop.
  66 - (BOOL)sourceView:(BSSourceView*)sv acceptsDropOfFile:(NSString*)fileName;
  67 @end