Browse Source

added missing documentation in MouseHoverLogic, FoldingElementGenerator and FoldingMargin

pull/21/head
Siegfried Pammer 15 years ago
parent
commit
532364965d
  1. 6
      src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Folding/FoldingElementGenerator.cs
  2. 24
      src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Folding/FoldingMargin.cs
  3. 21
      src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Rendering/MouseHoverLogic.cs

6
src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Folding/FoldingElementGenerator.cs

@ -167,10 +167,16 @@ namespace ICSharpCode.AvalonEdit.Folding
} }
} }
/// <summary>
/// Default brush for folding element text. Value: Brushes.Gray
/// </summary>
public static readonly Brush DefaultTextBrush = Brushes.Gray; public static readonly Brush DefaultTextBrush = Brushes.Gray;
static Brush textBrush = DefaultTextBrush; static Brush textBrush = DefaultTextBrush;
/// <summary>
/// Gets/sets the brush used for folding element text.
/// </summary>
public static Brush TextBrush { public static Brush TextBrush {
get { return textBrush; } get { return textBrush; }
set { textBrush = value; } set { textBrush = value; }

24
src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Folding/FoldingMargin.cs

@ -28,39 +28,63 @@ namespace ICSharpCode.AvalonEdit.Folding
internal const double SizeFactor = Constants.PixelPerPoint; internal const double SizeFactor = Constants.PixelPerPoint;
#region Brushes #region Brushes
/// <summary>
/// FoldingMarkerBrush dependency property.
/// </summary>
public static readonly DependencyProperty FoldingMarkerBrushProperty = public static readonly DependencyProperty FoldingMarkerBrushProperty =
DependencyProperty.RegisterAttached("FoldingMarkerBrush", typeof(Brush), typeof(FoldingMargin), DependencyProperty.RegisterAttached("FoldingMarkerBrush", typeof(Brush), typeof(FoldingMargin),
new FrameworkPropertyMetadata(Brushes.Gray, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes)); new FrameworkPropertyMetadata(Brushes.Gray, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes));
/// <summary>
/// Gets/sets the Brush used for displaying the lines of folding markers.
/// </summary>
public Brush FoldingMarkerBrush { public Brush FoldingMarkerBrush {
get { return (Brush)GetValue(FoldingMarkerBrushProperty); } get { return (Brush)GetValue(FoldingMarkerBrushProperty); }
set { SetValue(FoldingMarkerBrushProperty, value); } set { SetValue(FoldingMarkerBrushProperty, value); }
} }
/// <summary>
/// FoldingMarkerBackgroundBrush dependency property.
/// </summary>
public static readonly DependencyProperty FoldingMarkerBackgroundBrushProperty = public static readonly DependencyProperty FoldingMarkerBackgroundBrushProperty =
DependencyProperty.RegisterAttached("FoldingMarkerBackgroundBrush", typeof(Brush), typeof(FoldingMargin), DependencyProperty.RegisterAttached("FoldingMarkerBackgroundBrush", typeof(Brush), typeof(FoldingMargin),
new FrameworkPropertyMetadata(Brushes.White, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes)); new FrameworkPropertyMetadata(Brushes.White, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes));
/// <summary>
/// Gets/sets the Brush used for displaying the background of folding markers.
/// </summary>
public Brush FoldingMarkerBackgroundBrush { public Brush FoldingMarkerBackgroundBrush {
get { return (Brush)GetValue(FoldingMarkerBackgroundBrushProperty); } get { return (Brush)GetValue(FoldingMarkerBackgroundBrushProperty); }
set { SetValue(FoldingMarkerBackgroundBrushProperty, value); } set { SetValue(FoldingMarkerBackgroundBrushProperty, value); }
} }
/// <summary>
/// SelectedFoldingMarkerBrush dependency property.
/// </summary>
public static readonly DependencyProperty SelectedFoldingMarkerBrushProperty = public static readonly DependencyProperty SelectedFoldingMarkerBrushProperty =
DependencyProperty.RegisterAttached("SelectedFoldingMarkerBrush", DependencyProperty.RegisterAttached("SelectedFoldingMarkerBrush",
typeof(Brush), typeof(FoldingMargin), typeof(Brush), typeof(FoldingMargin),
new FrameworkPropertyMetadata(Brushes.Black, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes)); new FrameworkPropertyMetadata(Brushes.Black, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes));
/// <summary>
/// Gets/sets the Brush used for displaying the lines of selected folding markers.
/// </summary>
public Brush SelectedFoldingMarkerBrush { public Brush SelectedFoldingMarkerBrush {
get { return (Brush)GetValue(SelectedFoldingMarkerBrushProperty); } get { return (Brush)GetValue(SelectedFoldingMarkerBrushProperty); }
set { SetValue(SelectedFoldingMarkerBrushProperty, value); } set { SetValue(SelectedFoldingMarkerBrushProperty, value); }
} }
/// <summary>
/// SelectedFoldingMarkerBackgroundBrush dependency property.
/// </summary>
public static readonly DependencyProperty SelectedFoldingMarkerBackgroundBrushProperty = public static readonly DependencyProperty SelectedFoldingMarkerBackgroundBrushProperty =
DependencyProperty.RegisterAttached("SelectedFoldingMarkerBackgroundBrush", DependencyProperty.RegisterAttached("SelectedFoldingMarkerBackgroundBrush",
typeof(Brush), typeof(FoldingMargin), typeof(Brush), typeof(FoldingMargin),
new FrameworkPropertyMetadata(Brushes.White, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes)); new FrameworkPropertyMetadata(Brushes.White, FrameworkPropertyMetadataOptions.Inherits, OnUpdateBrushes));
/// <summary>
/// Gets/sets the Brush used for displaying the background of selected folding markers.
/// </summary>
public Brush SelectedFoldingMarkerBackgroundBrush { public Brush SelectedFoldingMarkerBackgroundBrush {
get { return (Brush)GetValue(SelectedFoldingMarkerBackgroundBrushProperty); } get { return (Brush)GetValue(SelectedFoldingMarkerBackgroundBrushProperty); }
set { SetValue(SelectedFoldingMarkerBackgroundBrushProperty, value); } set { SetValue(SelectedFoldingMarkerBackgroundBrushProperty, value); }

21
src/Libraries/AvalonEdit/ICSharpCode.AvalonEdit/Rendering/MouseHoverLogic.cs

@ -8,6 +8,9 @@ using System.Windows.Threading;
namespace ICSharpCode.AvalonEdit.Rendering namespace ICSharpCode.AvalonEdit.Rendering
{ {
/// <summary>
/// Encapsulates and adds MouseHover support to UIElements.
/// </summary>
public class MouseHoverLogic : IDisposable public class MouseHoverLogic : IDisposable
{ {
UIElement target; UIElement target;
@ -17,6 +20,9 @@ namespace ICSharpCode.AvalonEdit.Rendering
MouseEventArgs mouseHoverLastEventArgs; MouseEventArgs mouseHoverLastEventArgs;
bool mouseHovering; bool mouseHovering;
/// <summary>
/// Creates a new instance and attaches itself to the <paramref name="target" /> UIElement.
/// </summary>
public MouseHoverLogic(UIElement target) public MouseHoverLogic(UIElement target)
{ {
if (target == null) if (target == null)
@ -70,8 +76,14 @@ namespace ICSharpCode.AvalonEdit.Rendering
OnMouseHover(mouseHoverLastEventArgs); OnMouseHover(mouseHoverLastEventArgs);
} }
/// <summary>
/// Occurs when the mouse starts hovering over a certain location.
/// </summary>
public event EventHandler<MouseEventArgs> MouseHover; public event EventHandler<MouseEventArgs> MouseHover;
/// <summary>
/// Raises the <see cref="MouseHover"/> event.
/// </summary>
protected virtual void OnMouseHover(MouseEventArgs e) protected virtual void OnMouseHover(MouseEventArgs e)
{ {
if (MouseHover != null) { if (MouseHover != null) {
@ -79,8 +91,14 @@ namespace ICSharpCode.AvalonEdit.Rendering
} }
} }
/// <summary>
/// Occurs when the mouse stops hovering over a certain location.
/// </summary>
public event EventHandler<MouseEventArgs> MouseHoverStopped; public event EventHandler<MouseEventArgs> MouseHoverStopped;
/// <summary>
/// Raises the <see cref="MouseHoverStopped"/> event.
/// </summary>
protected virtual void OnMouseHoverStopped(MouseEventArgs e) protected virtual void OnMouseHoverStopped(MouseEventArgs e)
{ {
if (MouseHoverStopped != null) { if (MouseHoverStopped != null) {
@ -90,6 +108,9 @@ namespace ICSharpCode.AvalonEdit.Rendering
bool disposed; bool disposed;
/// <summary>
/// Removes the MouseHover support from the target UIElement.
/// </summary>
public void Dispose() public void Dispose()
{ {
if (!disposed) { if (!disposed) {

Loading…
Cancel
Save