aboutsummaryrefslogtreecommitdiffhomepage
path: root/cocoa/InfoBarCommunicator.h
blob: 5a91dcb59dc132d4b509bbeae3c517649c4d87ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/*
 * InfoBarCommunicator.h - Definitions of a communication protocol and other data types used for
 *                         the info bar implementation.
 *
 * Mike Lischke <mlischke@sun.com>
 *
 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
 * This file is dual licensed under LGPL v2.1 and the Scintilla license (http://www.scintilla.org/License.txt).
 */

typedef NS_OPTIONS(NSUInteger, IBDisplay) {
	IBShowZoom          = 0x01,
	IBShowCaretPosition = 0x02,
	IBShowStatusText    = 0x04,
	IBShowAll           = 0xFF
};

/**
 * The info bar communicator protocol is used for communication between ScintillaView and its
 * information bar component. Using this protocol decouples any potential info target from the main
 * ScintillaView implementation. The protocol is used two-way.
 */

typedef NS_ENUM(NSInteger, NotificationType) {
	IBNZoomChanged,    // The user selected another zoom value.
	IBNCaretChanged,   // The caret in the editor changed.
	IBNStatusChanged,  // The application set a new status message.
};

@protocol InfoBarCommunicator
- (void) notify: (NotificationType) type message: (NSString *) message location: (NSPoint) location
	  value: (float) value;
- (void) setCallback: (id <InfoBarCommunicator>) callback;
@end