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
  31 @property (nonatomic, readonly) NSTextView* textView;
  32 @property (nonatomic, readonly) NSScrollView* scrollView;
  33 @property (nonatomic, copy) NSSet<NSNumber*>* markers;
  34 @property (nonatomic, copy) NSString* file;
  35 @property (nonatomic, assign) NSUInteger markedLine;
  36 @property (nonatomic, weak) id delegate;
  37
  38 - (void)setFile:(NSString*)f;
  39 - (void)setString:(NSString*)source asFile:(NSString*)path;
  40 - (void)scrollToLine:(NSUInteger)line;
  41
  42 + (NSFont*)sourceFont;
  43
  44 @end
  45
  46 // Delegate ////////////////////////////////////////////////////////////////////
  47
  48 @protocol BSSourceViewDelegate <NSObject>
  49 @optional
  50
  51 // Notifies the delegate that the gutter was clicked at a certain line.
  52 - (void)gutterClickedAtLine:(NSUInteger)line forFile:(NSString*)file;
  53
  54 // An error occurrerd while attempting to read or highlight the file.
  55 - (void)error:(NSError*)error whileHighlightingFile:(NSString*)file;
  56
  57 @end