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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
//
// MarginMarker.cs
//
// Author:
// Mike Krüger <mkrueger@xamarin.com>
//
// Copyright (c) 2013 Xamarin Inc. (http://xamarin.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System;
using Gdk;
using Mono.TextEditor.Highlighting;
namespace Mono.TextEditor
{
/// <summary>
/// Contains all information about a margin draw event. This class is used inside <see cref="MarginMarker"/>.
/// </summary>
public class MarginDrawMetrics
{
/// <summary>
/// The margin that should be drawn.
/// </summary>
public Margin Margin { get; private set; }
/// <summary>
/// The area that needs to be redrawn.
/// </summary>
public Cairo.Rectangle Area { get; private set; }
/// <summary>
/// The line segment the margin should draw (can be null).
/// </summary>
public DocumentLine LineSegment { get; private set; }
/// <summary>
/// The line number of the line segment (can be negative, if the line segment is null).
/// </summary>
public long LineNumber { get; private set; }
/// <summary>
/// The X position of the margin.
/// </summary>
public double X { get; private set; }
/// <summary>
/// The Y postion of the margin draw event.
/// </summary>
public double Y { get; private set; }
/// <summary>
/// The Width of the margin.
/// </summary>
public double Width { get { return Margin.Width; } }
/// <summary>
/// The height of the current line.
/// </summary>
public double Height { get; private set; }
/// <summary>
/// X + Width
/// </summary>
public double Right { get { return X + Width; } }
/// <summary>
/// Y + Height
/// </summary>
public double Bottom { get { return Y + Height; } }
internal MarginDrawMetrics (Margin margin, Cairo.Rectangle area, DocumentLine lineSegment, long lineNumber, double x, double y, double height)
{
this.Margin = margin;
this.Area = area;
this.LineSegment = lineSegment;
this.LineNumber = lineNumber;
this.X = x;
this.Y = y;
this.Height = height;
}
}
/// <summary>
/// The margin marker is a specialized text line marker used to change how a margins of a line are drawn.
/// (If the margin supports custom drawing plugins)
/// Note: This is not used for the text view margin, which is handled by the basic TextLineMarker class.
/// </summary>
public class MarginMarker : TextLineMarker
{
/// <summary>
/// Determines whether this margin marker can draw the background of the specified margin.
/// </summary>
public virtual bool CanDrawBackground (Margin margin)
{
return false;
}
/// <summary>
/// Determines whether this margin marker can draw the foreground of the specified margin.
/// </summary>
public virtual bool CanDrawForeground (Margin margin)
{
return false;
}
internal bool CanDraw (Margin margin)
{
return CanDrawForeground (margin) || CanDrawBackground (margin);
}
/// <summary>
/// Draws the foreground of the specified margin.
/// </summary>
public virtual void DrawForeground (TextEditor editor, Cairo.Context cr, MarginDrawMetrics metrics)
{
}
/// <summary>
/// Draws the background of the specified margin.
/// </summary>
/// <returns>true, if the background is drawn. false if the margin should fallback to the default background renderer. </returns>
public virtual bool DrawBackground (TextEditor editor, Cairo.Context cr, MarginDrawMetrics metrics)
{
return false;
}
/// <summary>
/// Informs the margin marker of a mouse press event.
/// </summary>
/// <param name="editor">The text editor in which the event press occured.</param>
/// <param name="margin">The margin in which the event occured.</param>
/// <param name="args">The event arguments.</param>
public virtual void InformMousePress (TextEditor editor, Margin margin, MarginMouseEventArgs args)
{
}
/// <summary>
/// Informs the margin marker of a mouse release event.
/// </summary>
/// <param name="editor">The text editor in which the event press occured.</param>
/// <param name="margin">The margin in which the event occured.</param>
/// <param name="args">The event arguments.</param>
public virtual void InformMouseRelease (TextEditor editor, Margin margin, MarginMouseEventArgs args)
{
}
/// <summary>
/// Informs the margin marker of a mouse hover event.
/// </summary>
/// <param name="editor">The text editor in which the event press occured.</param>
/// <param name="margin">The margin in which the event occured.</param>
/// <param name="args">The event arguments.</param>
public virtual void InformMouseHover (TextEditor editor, Margin margin, MarginMouseEventArgs args)
{
}
}
}
|
