-
Notifications
You must be signed in to change notification settings - Fork 1
/
MarginCollection.cs
195 lines (183 loc) · 7.16 KB
/
MarginCollection.cs
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
// ***********************************************************************
// Assembly : Zeroit.Framework.CodeBox
// Author : ZEROIT
// Created : 03-19-2019
//
// Last Modified By : ZEROIT
// Last Modified On : 01-05-2019
// ***********************************************************************
// <copyright file="MarginCollection.cs" company="Zeroit Dev">
// This program is for creating a Code Editor control.
// Copyright © 2017 Zeroit Dev Technologies
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//
// You can contact me at zeroitdevnet@gmail.com or zeroitdev@outlook.com
// </copyright>
// <summary></summary>
// ***********************************************************************
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
namespace Zeroit.Framework.CodeBox
{
/// <summary>
/// An immutable collection of margins in a <see cref="Scintilla" /> control.
/// </summary>
public class MarginCollection : IEnumerable<Margin>
{
private readonly ZeroitCodeExplorer Scintilla;
/// <summary>
/// Removes all text displayed in every <see cref="MarginType.Text" /> and <see cref="MarginType.RightText" /> margins.
/// </summary>
public void ClearAllText()
{
Scintilla.DirectMessage(NativeMethods.SCI_MARGINTEXTCLEARALL);
}
/// <summary>
/// Provides an enumerator that iterates through the collection.
/// </summary>
/// <returns>An object that contains all <see cref="Margin" /> objects within the <see cref="MarginCollection" />.</returns>
public IEnumerator<Margin> GetEnumerator()
{
int count = Count;
for (int i = 0; i < count; i++)
yield return this[i];
yield break;
}
IEnumerator IEnumerable.GetEnumerator()
{
return this.GetEnumerator();
}
/// <summary>
/// Gets or sets the number of margins in the <see cref="MarginCollection" />.
/// </summary>
/// <returns>The number of margins in the collection. The default is 5.</returns>
[DefaultValue(NativeMethods.SC_MAX_MARGIN + 1)]
[Description("The maximum number of margins.")]
public int Capacity
{
get
{
return Scintilla.DirectMessage(NativeMethods.SCI_GETMARGINS).ToInt32();
}
set
{
value = Helpers.ClampMin(value, 0);
Scintilla.DirectMessage(NativeMethods.SCI_SETMARGINS, new IntPtr(value));
}
}
/// <summary>
/// Gets the number of margins in the <see cref="MarginCollection" />.
/// </summary>
/// <returns>The number of margins in the collection.</returns>
/// <remarks>This property is kept for convenience. The return value will always be equal to <see cref="Capacity" />.</remarks>
/// <seealso cref="Capacity" />
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public int Count
{
get
{
return Capacity;
}
}
/// <summary>
/// Gets or sets the width in pixels of the left margin padding.
/// </summary>
/// <returns>The left margin padding measured in pixels. The default is 1.</returns>
[DefaultValue(1)]
[Description("The left margin padding in pixels.")]
public int Left
{
get
{
return Scintilla.DirectMessage(NativeMethods.SCI_GETMARGINLEFT).ToInt32();
}
set
{
value = Helpers.ClampMin(value, 0);
Scintilla.DirectMessage(NativeMethods.SCI_SETMARGINLEFT, IntPtr.Zero, new IntPtr(value));
}
}
// TODO Why is this commented out?
/*
/// <summary>
/// Gets or sets the margin options.
/// </summary>
/// <returns>
/// A <see cref="Zeroit.Framework.CodeBox.MarginOptions" /> that represents the margin options.
/// The default is <see cref="Zeroit.Framework.CodeBox.MarginOptions.None" />.
/// </returns>
[DefaultValue(MarginOptions.None)]
[Description("Margin options flags.")]
[TypeConverter(typeof(FlagsEnumTypeConverter.FlagsEnumConverter))]
public MarginOptions Options
{
get
{
return (MarginOptions)Scintilla.DirectMessage(NativeMethods.SCI_GETMARGINOPTIONS);
}
set
{
var options = (int)value;
Scintilla.DirectMessage(NativeMethods.SCI_SETMARGINOPTIONS, new IntPtr(options));
}
}
*/
/// <summary>
/// Gets or sets the width in pixels of the right margin padding.
/// </summary>
/// <returns>The right margin padding measured in pixels. The default is 1.</returns>
[DefaultValue(1)]
[Description("The right margin padding in pixels.")]
public int Right
{
get
{
return Scintilla.DirectMessage(NativeMethods.SCI_GETMARGINRIGHT).ToInt32();
}
set
{
value = Helpers.ClampMin(value, 0);
Scintilla.DirectMessage(NativeMethods.SCI_SETMARGINRIGHT, IntPtr.Zero, new IntPtr(value));
}
}
/// <summary>
/// Gets a <see cref="Margin" /> object at the specified index.
/// </summary>
/// <param name="index">The margin index.</param>
/// <returns>An object representing the margin at the specified <paramref name="index" />.</returns>
/// <remarks>By convention margin 0 is used for line numbers and the two following for symbols.</remarks>
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public Margin this[int index]
{
get
{
index = Helpers.Clamp(index, 0, Count - 1);
return new Margin(Scintilla, index);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="MarginCollection" /> class.
/// </summary>
/// <param name="Scintilla">The <see cref="Scintilla" /> control that created this collection.</param>
public MarginCollection(ZeroitCodeExplorer Scintilla)
{
this.Scintilla = Scintilla;
}
}
}