2 // ToolStripRenderer.cs
4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 // Copyright (c) Jonathan Pobst
26 // Jonathan Pobst (monkey@jpobst.com)
30 using System.ComponentModel;
32 using System.Drawing.Imaging;
33 using System.Drawing.Drawing2D;
35 namespace System.Windows.Forms
37 public abstract class ToolStripRenderer
39 private static ColorMatrix grayscale_matrix = new ColorMatrix (new float[][] {
40 new float[] {0.22f, 0.22f, 0.22f, 0, 0},
41 new float[] {0.27f, 0.27f, 0.27f, 0, 0},
42 new float[] {0.04f, 0.04f, 0.04f, 0, 0},
43 new float[] {0.365f, 0.365f, 0.365f, 0.7f, 0},
44 new float[] {0, 0, 0, 0, 1}
47 protected ToolStripRenderer ()
51 #region Public Methods
52 public static Image CreateDisabledImage(Image normalImage)
54 if (normalImage == null)
57 // Code adapted from ThemeWin32Classic.cs
58 ImageAttributes ia = new ImageAttributes();
59 ia.SetColorMatrix (grayscale_matrix);
61 Bitmap b = new Bitmap(normalImage.Width, normalImage.Height);
62 using (Graphics g = Graphics.FromImage(b))
63 g.DrawImage(normalImage, new Rectangle (0, 0, normalImage.Width, normalImage.Height), 0, 0, normalImage.Width, normalImage.Height, GraphicsUnit.Pixel, ia);
68 public void DrawArrow (ToolStripArrowRenderEventArgs e)
69 { this.OnRenderArrow (e); }
71 public void DrawButtonBackground (ToolStripItemRenderEventArgs e)
72 { this.OnRenderButtonBackground (e); }
74 public void DrawDropDownButtonBackground (ToolStripItemRenderEventArgs e)
75 { this.OnRenderDropDownButtonBackground (e); }
77 public void DrawGrip (ToolStripGripRenderEventArgs e)
78 { this.OnRenderGrip (e); }
80 public void DrawImageMargin (ToolStripRenderEventArgs e)
81 { this.OnRenderImageMargin (e); }
83 public void DrawItemBackground (ToolStripItemRenderEventArgs e)
84 { this.OnRenderItemBackground (e); }
86 public void DrawItemCheck (ToolStripItemImageRenderEventArgs e)
87 { this.OnRenderItemCheck (e); }
89 public void DrawItemImage (ToolStripItemImageRenderEventArgs e)
90 { this.OnRenderItemImage (e); }
92 public void DrawItemText (ToolStripItemTextRenderEventArgs e)
93 { this.OnRenderItemText (e); }
95 public void DrawLabelBackground (ToolStripItemRenderEventArgs e)
96 { this.OnRenderLabelBackground (e); }
98 public void DrawMenuItemBackground (ToolStripItemRenderEventArgs e)
99 { this.OnRenderMenuItemBackground (e); }
101 public void DrawOverflowButtonBackground (ToolStripItemRenderEventArgs e)
102 { this.OnRenderOverflowButtonBackground (e); }
104 public void DrawSeparator (ToolStripSeparatorRenderEventArgs e)
105 { this.OnRenderSeparator (e); }
107 public void DrawSplitButton (ToolStripItemRenderEventArgs e)
108 { this.OnRenderSplitButtonBackground (e); }
110 public void DrawStatusStripSizingGrip (ToolStripRenderEventArgs e)
111 { this.OnRenderStatusStripSizingGrip (e); }
113 public void DrawToolStripBackground (ToolStripRenderEventArgs e)
114 { this.OnRenderToolStripBackground (e); }
116 public void DrawToolStripBorder (ToolStripRenderEventArgs e)
117 { this.OnRenderToolStripBorder (e); }
119 public void DrawToolStripContentPanelBackground (ToolStripContentPanelRenderEventArgs e)
120 { this.OnRenderToolStripContentPanelBackground (e); }
122 public void DrawToolStripPanelBackground (ToolStripPanelRenderEventArgs e)
123 { this.OnRenderToolStripPanelBackground (e); }
125 public void DrawToolStripStatusLabelBackground (ToolStripItemRenderEventArgs e)
126 { this.OnRenderToolStripStatusLabelBackground (e); }
129 #region Protected Methods
130 protected internal virtual void Initialize (ToolStrip toolStrip) {}
131 protected internal virtual void InitializeContentPanel (ToolStripContentPanel contentPanel) {}
132 protected internal virtual void InitializeItem (ToolStripItem item) {}
133 protected internal virtual void InitializePanel (ToolStripPanel toolStripPanel) {}
135 protected virtual void OnRenderArrow (ToolStripArrowRenderEventArgs e)
137 switch (e.Direction) {
138 case ArrowDirection.Down:
139 using (Pen p = new Pen (e.ArrowColor)) {
140 int x = e.ArrowRectangle.Left + (e.ArrowRectangle.Width / 2) - 3;
141 int y = e.ArrowRectangle.Top + (e.ArrowRectangle.Height / 2) - 2;
143 DrawDownArrow (e.Graphics, p, x, y);
146 case ArrowDirection.Left:
148 case ArrowDirection.Right:
149 using (Pen p = new Pen (e.ArrowColor)) {
150 int x = e.ArrowRectangle.Left + (e.ArrowRectangle.Width / 2) - 3;
151 int y = e.ArrowRectangle.Top + (e.ArrowRectangle.Height / 2) - 4;
153 DrawRightArrow (e.Graphics, p, x, y);
156 case ArrowDirection.Up:
160 ToolStripArrowRenderEventHandler eh = (ToolStripArrowRenderEventHandler)Events[RenderArrowEvent];
165 protected virtual void OnRenderButtonBackground (ToolStripItemRenderEventArgs e)
167 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderButtonBackgroundEvent];
172 protected virtual void OnRenderDropDownButtonBackground (ToolStripItemRenderEventArgs e)
174 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderDropDownButtonBackgroundEvent];
179 protected virtual void OnRenderGrip (ToolStripGripRenderEventArgs e)
181 ToolStripGripRenderEventHandler eh = (ToolStripGripRenderEventHandler)Events [RenderGripEvent];
186 protected virtual void OnRenderImageMargin (ToolStripRenderEventArgs e)
188 ToolStripRenderEventHandler eh = (ToolStripRenderEventHandler)Events [RenderImageMarginEvent];
193 protected virtual void OnRenderItemBackground (ToolStripItemRenderEventArgs e)
195 if (e.Item.BackColor != Control.DefaultBackColor) {
196 // Only paint the BackColor if it's not the default one,
197 // to avoid painting a solid background color over the parent ToolStrip gradient.
198 Rectangle item_bounds = new Rectangle (0, 0, e.Item.Width, e.Item.Height);
199 e.Graphics.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (e.Item.BackColor), item_bounds);
202 if (e.Item.BackgroundImage != null) {
203 Rectangle item_bounds = new Rectangle (0, 0, e.Item.Width, e.Item.Height);
204 DrawBackground (e.Graphics, item_bounds, e.Item.BackgroundImage, e.Item.BackgroundImageLayout);
207 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderItemBackgroundEvent];
212 protected virtual void OnRenderItemCheck (ToolStripItemImageRenderEventArgs e)
214 ToolStripItemImageRenderEventHandler eh = (ToolStripItemImageRenderEventHandler)Events [RenderItemCheckEvent];
219 protected virtual void OnRenderItemImage (ToolStripItemImageRenderEventArgs e)
221 bool need_dispose = false;
224 if (e.Item.RightToLeft == RightToLeft.Yes && e.Item.RightToLeftAutoMirrorImage == true) {
225 i = CreateMirrorImage (i);
229 if (e.Item.ImageTransparentColor != Color.Empty) {
230 ImageAttributes ia = new ImageAttributes ();
231 ia.SetColorKey (e.Item.ImageTransparentColor, e.Item.ImageTransparentColor);
232 e.Graphics.DrawImage (i, e.ImageRectangle, 0, 0, i.Width, i.Height, GraphicsUnit.Pixel, ia);
236 e.Graphics.DrawImage (i, e.ImageRectangle);
241 ToolStripItemImageRenderEventHandler eh = (ToolStripItemImageRenderEventHandler)Events [RenderItemImageEvent];
246 protected virtual void OnRenderItemText (ToolStripItemTextRenderEventArgs e)
248 if (e.TextDirection == ToolStripTextDirection.Vertical90) {
249 GraphicsState gs = e.Graphics.Save ();
250 PointF p = new PointF (e.Graphics.Transform.OffsetX, e.Graphics.Transform.OffsetY);
252 e.Graphics.ResetTransform ();
253 e.Graphics.RotateTransform (90);
255 RectangleF r = new RectangleF ((e.Item.Height - e.TextRectangle.Height) / 2, (e.TextRectangle.Width + p.X) * -1 - 18, e.TextRectangle.Height, e.TextRectangle.Width);
257 StringFormat sf = new StringFormat ();
258 sf.Alignment = StringAlignment.Center;
260 e.Graphics.DrawString (e.Text, e.TextFont, ThemeEngine.Current.ResPool.GetSolidBrush (e.TextColor), r, sf);
262 e.Graphics.Restore (gs);
263 } else if (e.TextDirection == ToolStripTextDirection.Vertical270) {
264 GraphicsState gs = e.Graphics.Save ();
265 PointF p = new PointF (e.Graphics.Transform.OffsetX, e.Graphics.Transform.OffsetY);
267 e.Graphics.ResetTransform ();
268 e.Graphics.RotateTransform (270);
270 RectangleF r = new RectangleF (-e.TextRectangle.Height - (e.Item.Height - e.TextRectangle.Height) / 2, (e.TextRectangle.Width + p.X) + 4, e.TextRectangle.Height, e.TextRectangle.Width);
272 StringFormat sf = new StringFormat ();
273 sf.Alignment = StringAlignment.Center;
275 e.Graphics.DrawString (e.Text, e.TextFont, ThemeEngine.Current.ResPool.GetSolidBrush (e.TextColor), r, sf);
277 e.Graphics.Restore (gs);
279 TextRenderer.DrawText (e.Graphics, e.Text, e.TextFont, e.TextRectangle, e.TextColor, e.TextFormat);
281 ToolStripItemTextRenderEventHandler eh = (ToolStripItemTextRenderEventHandler)Events[RenderItemTextEvent];
286 protected virtual void OnRenderLabelBackground (ToolStripItemRenderEventArgs e)
288 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderLabelBackgroundEvent];
293 protected virtual void OnRenderMenuItemBackground (ToolStripItemRenderEventArgs e)
295 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderMenuItemBackgroundEvent];
300 protected virtual void OnRenderOverflowButtonBackground (ToolStripItemRenderEventArgs e)
302 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderOverflowButtonBackgroundEvent];
307 protected virtual void OnRenderSeparator (ToolStripSeparatorRenderEventArgs e)
309 ToolStripSeparatorRenderEventHandler eh = (ToolStripSeparatorRenderEventHandler)Events [RenderSeparatorEvent];
314 protected virtual void OnRenderSplitButtonBackground (ToolStripItemRenderEventArgs e)
316 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderSplitButtonBackgroundEvent];
321 protected virtual void OnRenderStatusStripSizingGrip (ToolStripRenderEventArgs e)
323 StatusStrip ss = (StatusStrip)e.ToolStrip;
325 if (ss.SizingGrip == true)
326 DrawSizingGrip (e.Graphics, ss.SizeGripBounds);
328 ToolStripRenderEventHandler eh = (ToolStripRenderEventHandler)Events [RenderStatusStripSizingGripEvent];
333 protected virtual void OnRenderToolStripBackground (ToolStripRenderEventArgs e)
335 ToolStripRenderEventHandler eh = (ToolStripRenderEventHandler)Events [RenderToolStripBackgroundEvent];
340 protected virtual void OnRenderToolStripBorder (ToolStripRenderEventArgs e)
342 ToolStripRenderEventHandler eh = (ToolStripRenderEventHandler)Events [RenderToolStripBorderEvent];
347 protected virtual void OnRenderToolStripContentPanelBackground (ToolStripContentPanelRenderEventArgs e)
349 ToolStripContentPanelRenderEventHandler eh = (ToolStripContentPanelRenderEventHandler)Events [RenderToolStripContentPanelBackgroundEvent];
354 protected virtual void OnRenderToolStripPanelBackground (ToolStripPanelRenderEventArgs e)
356 ToolStripPanelRenderEventHandler eh = (ToolStripPanelRenderEventHandler)Events [RenderToolStripPanelBackgroundEvent];
361 protected virtual void OnRenderToolStripStatusLabelBackground (ToolStripItemRenderEventArgs e)
363 ToolStripItemRenderEventHandler eh = (ToolStripItemRenderEventHandler)Events [RenderToolStripStatusLabelBackgroundEvent];
369 #region Public Events
370 EventHandlerList events;
372 EventHandlerList Events {
375 events = new EventHandlerList ();
380 static object RenderArrowEvent = new object ();
381 static object RenderButtonBackgroundEvent = new object ();
382 static object RenderDropDownButtonBackgroundEvent = new object ();
383 static object RenderGripEvent = new object ();
384 static object RenderImageMarginEvent = new object ();
385 static object RenderItemBackgroundEvent = new object ();
386 static object RenderItemCheckEvent = new object ();
387 static object RenderItemImageEvent = new object ();
388 static object RenderItemTextEvent = new object ();
389 static object RenderLabelBackgroundEvent = new object ();
390 static object RenderMenuItemBackgroundEvent = new object ();
391 static object RenderOverflowButtonBackgroundEvent = new object ();
392 static object RenderSeparatorEvent = new object ();
393 static object RenderSplitButtonBackgroundEvent = new object ();
394 static object RenderStatusStripSizingGripEvent = new object ();
395 static object RenderToolStripBackgroundEvent = new object ();
396 static object RenderToolStripBorderEvent = new object ();
397 static object RenderToolStripContentPanelBackgroundEvent = new object ();
398 static object RenderToolStripPanelBackgroundEvent = new object ();
399 static object RenderToolStripStatusLabelBackgroundEvent = new object ();
401 public event ToolStripArrowRenderEventHandler RenderArrow {
402 add { Events.AddHandler (RenderArrowEvent, value); }
403 remove {Events.RemoveHandler (RenderArrowEvent, value); }
405 public event ToolStripItemRenderEventHandler RenderButtonBackground {
406 add { Events.AddHandler (RenderButtonBackgroundEvent, value); }
407 remove {Events.RemoveHandler (RenderButtonBackgroundEvent, value); }
409 public event ToolStripItemRenderEventHandler RenderDropDownButtonBackground {
410 add { Events.AddHandler (RenderDropDownButtonBackgroundEvent, value); }
411 remove {Events.RemoveHandler (RenderDropDownButtonBackgroundEvent, value); }
413 public event ToolStripGripRenderEventHandler RenderGrip {
414 add { Events.AddHandler (RenderGripEvent, value); }
415 remove {Events.RemoveHandler (RenderGripEvent, value); }
417 public event ToolStripRenderEventHandler RenderImageMargin {
418 add { Events.AddHandler (RenderImageMarginEvent, value); }
419 remove {Events.RemoveHandler (RenderImageMarginEvent, value); }
421 public event ToolStripItemRenderEventHandler RenderItemBackground {
422 add { Events.AddHandler (RenderItemBackgroundEvent, value); }
423 remove {Events.RemoveHandler (RenderItemBackgroundEvent, value); }
425 public event ToolStripItemImageRenderEventHandler RenderItemCheck {
426 add { Events.AddHandler (RenderItemCheckEvent, value); }
427 remove {Events.RemoveHandler (RenderItemCheckEvent, value); }
429 public event ToolStripItemImageRenderEventHandler RenderItemImage {
430 add { Events.AddHandler (RenderItemImageEvent, value); }
431 remove {Events.RemoveHandler (RenderItemImageEvent, value); }
433 public event ToolStripItemTextRenderEventHandler RenderItemText {
434 add { Events.AddHandler (RenderItemTextEvent, value); }
435 remove {Events.RemoveHandler (RenderItemTextEvent, value); }
437 public event ToolStripItemRenderEventHandler RenderLabelBackground {
438 add { Events.AddHandler (RenderLabelBackgroundEvent, value); }
439 remove {Events.RemoveHandler (RenderLabelBackgroundEvent, value); }
441 public event ToolStripItemRenderEventHandler RenderMenuItemBackground {
442 add { Events.AddHandler (RenderMenuItemBackgroundEvent, value); }
443 remove {Events.RemoveHandler (RenderMenuItemBackgroundEvent, value); }
445 public event ToolStripItemRenderEventHandler RenderOverflowButtonBackground {
446 add { Events.AddHandler (RenderOverflowButtonBackgroundEvent, value); }
447 remove {Events.RemoveHandler (RenderOverflowButtonBackgroundEvent, value); }
449 public event ToolStripSeparatorRenderEventHandler RenderSeparator {
450 add { Events.AddHandler (RenderSeparatorEvent, value); }
451 remove {Events.RemoveHandler (RenderSeparatorEvent, value); }
453 public event ToolStripItemRenderEventHandler RenderSplitButtonBackground {
454 add { Events.AddHandler (RenderSplitButtonBackgroundEvent, value); }
455 remove {Events.RemoveHandler (RenderSplitButtonBackgroundEvent, value); }
457 public event ToolStripRenderEventHandler RenderStatusStripSizingGrip {
458 add { Events.AddHandler (RenderStatusStripSizingGripEvent, value); }
459 remove {Events.RemoveHandler (RenderStatusStripSizingGripEvent, value); }
461 public event ToolStripRenderEventHandler RenderToolStripBackground {
462 add { Events.AddHandler (RenderToolStripBackgroundEvent, value); }
463 remove {Events.RemoveHandler (RenderToolStripBackgroundEvent, value); }
465 public event ToolStripRenderEventHandler RenderToolStripBorder {
466 add { Events.AddHandler (RenderToolStripBorderEvent, value); }
467 remove {Events.RemoveHandler (RenderToolStripBorderEvent, value); }
469 public event ToolStripContentPanelRenderEventHandler RenderToolStripContentPanelBackground {
470 add { Events.AddHandler (RenderToolStripContentPanelBackgroundEvent, value); }
471 remove {Events.RemoveHandler (RenderToolStripContentPanelBackgroundEvent, value); }
473 public event ToolStripPanelRenderEventHandler RenderToolStripPanelBackground {
474 add { Events.AddHandler (RenderToolStripPanelBackgroundEvent, value); }
475 remove {Events.RemoveHandler (RenderToolStripPanelBackgroundEvent, value); }
477 public event ToolStripItemRenderEventHandler RenderToolStripStatusLabelBackground {
478 add { Events.AddHandler (RenderToolStripStatusLabelBackgroundEvent, value); }
479 remove {Events.RemoveHandler (RenderToolStripStatusLabelBackgroundEvent, value); }
483 #region Private Methods
484 internal static Image CreateMirrorImage (Image normalImage)
486 if (normalImage == null)
489 Bitmap b = new Bitmap (normalImage);
490 b.RotateFlip (RotateFlipType.RotateNoneFlipX);
495 private void DrawBackground (Graphics g, Rectangle bounds, Image image, ImageLayout layout)
497 // Center and Tile don't matter if the image is larger than the control
498 if (layout == ImageLayout.Center || layout == ImageLayout.Tile)
499 if (image.Size.Width >= bounds.Size.Width && image.Size.Height >= bounds.Size.Height)
500 layout = ImageLayout.None;
503 case ImageLayout.None:
504 g.DrawImageUnscaledAndClipped (image, bounds);
506 case ImageLayout.Tile:
510 while (y < bounds.Height) {
511 while (x < bounds.Width) {
512 g.DrawImageUnscaledAndClipped (image, bounds);
519 case ImageLayout.Center:
520 Rectangle r = new Rectangle ((bounds.Size.Width - image.Size.Width) / 2, (bounds.Size.Height - image.Size.Height) / 2, image.Width, image.Height);
521 g.DrawImageUnscaledAndClipped (image, r);
523 case ImageLayout.Stretch:
524 g.DrawImage (image, bounds);
526 case ImageLayout.Zoom:
527 if (((float)image.Height / (float)image.Width) < ((float)bounds.Height / (float)bounds.Width)) {
528 Rectangle rzoom = new Rectangle (0, 0, bounds.Width, (int)((float)bounds.Width * ((float)image.Height / (float)image.Width)));
529 rzoom.Y = (bounds.Height - rzoom.Height)/ 2;
530 g.DrawImage (image, rzoom);
532 Rectangle rzoom = new Rectangle (0, 0, (int)((float)bounds.Height * ((float)image.Width / (float)image.Height)), bounds.Height);
533 rzoom.X = (bounds.Width - rzoom.Width) / 2;
534 g.DrawImage (image, rzoom);
540 internal static void DrawRightArrow (Graphics g, Pen p, int x, int y)
542 g.DrawLine (p, x, y, x, y + 6);
543 g.DrawLine (p, x + 1, y + 1, x + 1, y + 5);
544 g.DrawLine (p, x + 2, y + 2, x + 2, y + 4);
545 g.DrawLine (p, x + 2, y + 3, x + 3, y + 3);
548 internal static void DrawDownArrow (Graphics g, Pen p, int x, int y)
550 g.DrawLine (p, x + 1, y, x + 5, y);
551 g.DrawLine (p, x + 2, y + 1, x + 4, y + 1);
552 g.DrawLine (p, x + 3, y + 1, x + 3, y + 2);
555 private void DrawSizingGrip (Graphics g, Rectangle rect)
557 DrawGripBox (g, rect.Right - 5, rect.Bottom - 5);
558 DrawGripBox (g, rect.Right - 9, rect.Bottom - 5);
559 DrawGripBox (g, rect.Right - 5, rect.Bottom - 9);
560 DrawGripBox (g, rect.Right - 13, rect.Bottom - 5);
561 DrawGripBox (g, rect.Right - 5, rect.Bottom - 13);
562 DrawGripBox (g, rect.Right - 9, rect.Bottom - 9);
565 private void DrawGripBox (Graphics g, int x, int y)
567 g.DrawRectangle (Pens.White, x + 1, y + 1, 1, 1);
568 g.DrawRectangle (ThemeEngine.Current.ResPool.GetPen (Color.FromArgb (172, 168, 153)), x, y, 1, 1);