openpdn /src/Tool.cs

Language C# Lines 1468
MD5 Hash 8458711e64769e4410807d52ff44c4ab Estimated Cost $28,893 (why?)
Repository https://bitbucket.org/tuldok89/openpdn View Raw File View Project SPDX
   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
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
/////////////////////////////////////////////////////////////////////////////////
// Paint.NET                                                                   //
// Copyright (C) dotPDN LLC, Rick Brewster, Tom Jackson, and contributors.     //
// Portions Copyright (C) Microsoft Corporation. All Rights Reserved.          //
// See src/Resources/Files/License.txt for full licensing and attribution      //
// details.                                                                    //
// .                                                                           //
/////////////////////////////////////////////////////////////////////////////////

using PaintDotNet.Base;
using PaintDotNet.HistoryFunctions;
using PaintDotNet.SystemLayer;
using System;
using System.Collections;
using System.Diagnostics;
using System.Drawing;
using System.Windows.Forms;

namespace PaintDotNet
{
    /// <summary>
    /// Encapsulates the functionality for a tool that goes in the main window's toolbar
    /// and that affects the Document.
    /// A Tool should only emit a HistoryMemento when it actually modifies the canvas.
    /// So, for instance, if the user draws a line but that line doesn't fall within
    /// the canvas (like if the seleciton region excludes it), then since the user
    /// hasn't really done anything there should be no HistoryMemento emitted.
    /// </summary>
    /// <remarks>
    /// A bit about the eventing model:
    /// * Perform[Event]() methods are ALWAYS used to trigger the events. This can be called by
    ///   either instance methods or outside (client) callers.
    /// * [Event]() methods are called first by Perform[Event](). This gives the base Tool class a
    ///   first chance at handling the event. These methods are private and non-overridable.
    /// * On[Event]() methods are then called by [Event]() if necessary, and should be overrided 
    ///   as necessary by derived classes. Always call the base implementation unless the
    ///   documentation says otherwise. The base implementation gives the Tool a chance to provide
    ///   default, overridable behavior for an event.
    /// </remarks>
    internal class Tool
        : IDisposable,
          IHotKeyTarget
    {
        public static readonly Type DefaultToolType = typeof(Tools.PaintBrushTool);

        private readonly ImageResource _toolBarImage;
        private Cursor _cursor;
        private readonly ToolInfo _toolInfo;
        private int _mouseDown; // incremented for every MouseDown, decremented for every MouseUp
        private int _ignoreMouseMove; // when >0, MouseMove is ignored and then this is decremented

        protected Cursor HandCursor;
        protected Cursor HandCursorMouseDown;
        protected Cursor HandCursorInvalid;
        private Cursor _panOldCursor;
        private Point _lastMouseXY;
        private Point _lastPanMouseXY;
        private bool _panMode; // 'true' when the user is holding down the spacebar
        private bool _panTracking; // 'true' when panMode is true, and when the mouse is down (which is when MouseMove should do panning)
        private MoveNubRenderer _trackingNub; // when we are in pan-tracking mode, we draw this in the center of the screen

        private readonly DocumentWorkspace _documentWorkspace;

        protected bool AutoScroll = true;
        private readonly Hashtable _keysThatAreDown = new Hashtable();
        private MouseButtons _lastButton = MouseButtons.None;
        private PdnRegion _saveRegion;
#if DEBUG
        private bool haveClearedScratch = false;
#endif

        private int _mouseEnter; // increments on MouseEnter, decrements on MouseLeave. The MouseLeave event is ONLY raised when this value decrements to 0, and MouseEnter is ONLY raised when this value increments to 1

        protected Surface ScratchSurface { get; private set; }

        protected Document Document
        {
            get
            {
                return DocumentWorkspace.Document;
            }
        }

        public DocumentWorkspace DocumentWorkspace
        {
            get
            {
                return _documentWorkspace;
            }
        }

        public AppWorkspace AppWorkspace
        {
            get
            {
                return DocumentWorkspace.AppWorkspace;
            }
        }

        protected HistoryStack HistoryStack
        {
            get
            {
                return DocumentWorkspace.History;
            }
        }

        protected AppEnvironment AppEnvironment
        {
            get
            {
                return _documentWorkspace.AppWorkspace.AppEnvironment;
            }
        }

        protected Selection Selection
        {
            get
            {
                return DocumentWorkspace.Selection;
            }
        }

        protected Layer ActiveLayer
        {
            get
            {
                return DocumentWorkspace.ActiveLayer;
            }
        }

        protected int ActiveLayerIndex
        {
            get
            {
                return DocumentWorkspace.ActiveLayerIndex;
            }

            set
            {
                DocumentWorkspace.ActiveLayerIndex = value;
            }
        }

        public void ClearSavedMemory()
        {
            _savedTiles = null;
        }

        public void ClearSavedRegion()
        {
            if (_saveRegion == null) return;
            _saveRegion.Dispose();
            _saveRegion = null;
        }

        public void RestoreRegion(PdnRegion region)
        {
            if (region == null) return;
            var activeLayer = (BitmapLayer)ActiveLayer;
            activeLayer.Surface.CopySurface(ScratchSurface, region);
            activeLayer.Invalidate(region);
        }

        public void RestoreSavedRegion()
        {
            if (_saveRegion == null) return;
            var activeLayer = (BitmapLayer)ActiveLayer;
            activeLayer.Surface.CopySurface(ScratchSurface, _saveRegion);
            activeLayer.Invalidate(_saveRegion);
            _saveRegion.Dispose();
            _saveRegion = null;
        }

        private const int SaveTileGranularity = 32;
        private BitVector2D _savedTiles;

        public void SaveRegion(PdnRegion saveMeRegion, Rectangle saveMeBounds)
        {
            var activeLayer = (BitmapLayer)ActiveLayer;

            if (_savedTiles == null)
            {
                _savedTiles = new BitVector2D(
                    (activeLayer.Width + SaveTileGranularity - 1) / SaveTileGranularity,
                    (activeLayer.Height + SaveTileGranularity - 1) / SaveTileGranularity);

                _savedTiles.Clear(false);
            }

            Rectangle regionBounds = saveMeRegion == null ? saveMeBounds : saveMeRegion.GetBoundsInt();

            Rectangle bounds = Rectangle.Union(regionBounds, saveMeBounds);
            bounds.Intersect(activeLayer.Bounds);

            int leftTile = bounds.Left / SaveTileGranularity;
            int topTile = bounds.Top / SaveTileGranularity;
            int rightTile = (bounds.Right - 1) / SaveTileGranularity;
            int bottomTile = (bounds.Bottom - 1) / SaveTileGranularity;

            for (int tileY = topTile; tileY <= bottomTile; ++tileY)
            {
                Rectangle rowAccumBounds = Rectangle.Empty;

                for (int tileX = leftTile; tileX <= rightTile; ++tileX)
                {
                    if (!_savedTiles.Get(tileX, tileY))
                    {
                        var tileBounds = new Rectangle(tileX * SaveTileGranularity, tileY * SaveTileGranularity,
                            SaveTileGranularity, SaveTileGranularity);

                        tileBounds.Intersect(activeLayer.Bounds);

                        rowAccumBounds = rowAccumBounds == Rectangle.Empty ? tileBounds : Rectangle.Union(rowAccumBounds, tileBounds);

                        _savedTiles.Set(tileX, tileY, true);
                    }
                    else
                    {
                        if (rowAccumBounds != Rectangle.Empty)
                        {
                            using (Surface dst = ScratchSurface.CreateWindow(rowAccumBounds),
                                           src = activeLayer.Surface.CreateWindow(rowAccumBounds))
                            {
                                dst.CopySurface(src);
                            }

                            rowAccumBounds = Rectangle.Empty;
                        }
                    }
                }

                if (rowAccumBounds == Rectangle.Empty) continue;
                using (Surface dst = ScratchSurface.CreateWindow(rowAccumBounds),
                               src = activeLayer.Surface.CreateWindow(rowAccumBounds))
                {
                    dst.CopySurface(src);
                }

                rowAccumBounds = Rectangle.Empty;
            }

            if (_saveRegion != null)
            {
                _saveRegion.Dispose();
                _saveRegion = null;
            }

            if (saveMeRegion != null)
            {
                _saveRegion = saveMeRegion.Clone();
            }
        }

        private sealed class KeyTimeInfo
        {
            private readonly DateTime _keyDownTime;
            private DateTime _lastKeyPressPulse;

            private int Repeats { get; set; }

            public KeyTimeInfo()
            {
                Repeats = 0;
                _keyDownTime = DateTime.Now;
                _lastKeyPressPulse = _keyDownTime;
            }
        }

        /// <summary>
        /// Tells you whether the tool is "active" or not. If the tool is not active
        /// it is not safe to call any other method besides PerformActivate. All
        /// properties are safe to get values from.
        /// </summary>
        public bool Active { get; private set; }

        /// <summary>
        /// Returns true if the Tool has the input focus, or false if it does not.
        /// </summary>
        /// <remarks>
        /// This is used, for instanced, by the Text Tool so that it doesn't blink the
        /// cursor unless it's actually going to do something in response to your
        /// keyboard input!
        /// </remarks>
        public bool Focused
        {
            get
            {
                return DocumentWorkspace.Focused;
            }
        }

        public bool IsMouseDown
        {
            get
            {
                return _mouseDown > 0;
            }
        }

        /// <summary>
        /// Gets a flag that determines whether the Tool is deactivated while the current
        /// layer is changing, and then reactivated afterwards.
        /// </summary>
        /// <remarks>
        /// This property is queried every time the ActiveLayer property of DocumentWorkspace
        /// is changed. If false is returned, then the tool is not deactivated during the
        /// layer change and must manually maintain coherency.
        /// </remarks>
        public virtual bool DeactivateOnLayerChange
        {
            get
            {
                return true;
            }
        }

        /// <summary>
        /// Tells you which keys are pressed
        /// </summary>
        public Keys ModifierKeys
        {
            get
            {
                return Control.ModifierKeys;
            }
        }

        /// <summary>
        /// Represents the Image that is displayed in the toolbar.
        /// </summary>
        public ImageResource Image
        {
            get
            {
                return _toolBarImage;
            }
        }

        public event EventHandler CursorChanging;
        protected virtual void OnCursorChanging()
        {
            if (CursorChanging != null)
            {
                CursorChanging(this, EventArgs.Empty);
            }
        }

        public event EventHandler CursorChanged;
        protected virtual void OnCursorChanged()
        {
            if (CursorChanged != null)
            {
                CursorChanged(this, EventArgs.Empty);
            }
        }

        /// <summary>
        /// The Cursor that is displayed when this Tool is active and the
        /// mouse cursor is inside the document view.
        /// </summary>
        public Cursor Cursor
        {
            get
            {
                return _cursor;
            }

            set
            {
                OnCursorChanging();
                _cursor = value;
                OnCursorChanged();
            }
        }

        /// <summary>
        /// The name of the Tool. For instance, "Pencil". This name should *not* end in "Tool", e.g. "Pencil Tool"
        /// </summary>
        public string Name
        {
            get
            {
                return _toolInfo.Name;
            }
        }

        /// <summary>
        /// A short description of how to use the tool.
        /// </summary>
        public string HelpText
        {
            get
            {
                return _toolInfo.HelpText;
            }
        }

        public ToolInfo Info
        {
            get
            {
                return _toolInfo;
            }
        }

        public ToolBarConfigItems ToolBarConfigItems
        {
            get
            {
                return _toolInfo.ToolBarConfigItems;
            }
        }

        /// <summary>
        /// Specifies whether or not an inherited tool should take Ink commands
        /// </summary>
        protected virtual bool SupportsInk 
        {
            get
            {
                return false;
            }
        }

        public char HotKey
        {
            get
            {
                return _toolInfo.HotKey;
            }
        }

        // Methods to send messages to this class
        public void PerformActivate()
        {
            Activate();
        }

        public void PerformDeactivate()
        {
            Deactivate();
        }

        private bool IsOverflow(MouseEventArgs e) 
        {
            PointF clientPt = DocumentWorkspace.DocumentToClient(new PointF(e.X, e.Y));
            return clientPt.X < -16384 || clientPt.Y < -16384;
        }

        public bool IsMouseEntered
        {
            get
            {
                return _mouseEnter > 0;
            }
        }

        public void PerformMouseEnter()
        {
            MouseEnter();
        }

        private void MouseEnter()
        {
            ++_mouseEnter;

            if (_mouseEnter == 1)
            {
                OnMouseEnter();
            }
        }

        protected virtual void OnMouseEnter()
        {
        }

        public void PerformMouseLeave()
        {
            MouseLeave();
        }

        private void MouseLeave()
        {
            if (_mouseEnter == 1)
            {
                _mouseEnter = 0;
                OnMouseLeave();
            }
            else
            {
                _mouseEnter = Math.Max(0, _mouseEnter - 1);
            }
        }

        protected virtual void OnMouseLeave()
        {
        }

        public void PerformMouseMove(MouseEventArgs e)
        {
            if (IsOverflow(e)) 
            {
                return;
            }

            if (e is StylusEventArgs)
            {
                if (SupportsInk) 
                {
                    StylusMove(e as StylusEventArgs);
                }

                // if the tool does not claim ink support, discard
            }
            else
            {
                MouseMove(e);
            }
        }

        public void PerformMouseDown(MouseEventArgs e)
        {
            if (IsOverflow(e)) 
            {
                return;
            }

            if (e is StylusEventArgs) 
            {
                if (SupportsInk) 
                {
                    StylusDown(e as StylusEventArgs);
                }

                // if the tool does not claim ink support, discard
            }
            else
            {
                if (SupportsInk) 
                {
                    DocumentWorkspace.Focus();
                } 

                MouseDown(e);
            }
        }

        public void PerformMouseUp(MouseEventArgs e)
        {
            if (IsOverflow(e)) 
            {
                return;
            }

            if (e is StylusEventArgs) 
            {
                if (SupportsInk) 
                {
                    StylusUp(e as StylusEventArgs);
                }

                // if the tool does not claim ink support, discard
            }
            else
            {
                MouseUp(e);
            }
        }

        public void PerformKeyPress(KeyPressEventArgs e)
        {
            KeyPress(e);
        }

        public void PerformKeyPress(Keys key)
        {
            KeyPress(key);
        }

        public void PerformKeyUp(KeyEventArgs e)
        {
            KeyUp(e);
        }

        public void PerformKeyDown(KeyEventArgs e)
        {
            KeyDown(e);
        }

        public void PerformClick()
        {
            Click();
        }

        public void PerformPulse()
        {
            Pulse();
        }

        public void PerformPaste(IDataObject data, out bool handled)
        {
            Paste(data, out handled);
        }

        public void PerformPasteQuery(IDataObject data, out bool canHandle)
        {
            PasteQuery(data, out canHandle);
        }

        private void Activate()
        {
            Debug.Assert(Active != true, "already active!");
            Active = true;

            HandCursor = new Cursor(PdnResources.GetResourceStream("Cursors.PanToolCursor.cur"));
            HandCursorMouseDown = new Cursor(PdnResources.GetResourceStream("Cursors.PanToolCursorMouseDown.cur"));
            HandCursorInvalid = new Cursor(PdnResources.GetResourceStream("Cursors.PanToolCursorInvalid.cur"));

            _panTracking = false;
            _panMode = false;
            _mouseDown = 0;
            _savedTiles = null;
            _saveRegion = null;

            ScratchSurface = DocumentWorkspace.BorrowScratchSurface(GetType().Name + ": Tool.Activate()");
#if DEBUG
            haveClearedScratch = false;
#endif

            Selection.Changing += SelectionChangingHandler;
            Selection.Changed += SelectionChangedHandler;
            HistoryStack.ExecutingHistoryMemento += ExecutingHistoryMemento;
            HistoryStack.ExecutedHistoryMemento += ExecutedHistoryMemento;
            HistoryStack.FinishedStepGroup += FinishedHistoryStepGroup;

            _trackingNub = new MoveNubRenderer(RendererList)
                               {
                                   Visible = false,
                                   Size = new SizeF(10, 10),
                                   Shape = MoveNubShape.Compass
                               };
            RendererList.Add(_trackingNub, false);

            OnActivate();
        }

        void FinishedHistoryStepGroup(object sender, EventArgs e)
        {
            OnFinishedHistoryStepGroup();
        }

        protected virtual void OnFinishedHistoryStepGroup()
        {
        }

        /// <summary>
        /// This method is called when the tool is being activated; that is, when the
        /// user has chosen to use this tool by clicking on it on a toolbar.
        /// </summary>
        protected virtual void OnActivate()
        {
        }

        private void Deactivate()
        {
            Debug.Assert(this.Active != false, "not active!");

            Active = false;

            Selection.Changing -= SelectionChangingHandler;
            Selection.Changed -= SelectionChangedHandler;

            HistoryStack.ExecutingHistoryMemento -= ExecutingHistoryMemento;
            HistoryStack.ExecutedHistoryMemento -= ExecutedHistoryMemento;
            HistoryStack.FinishedStepGroup -= FinishedHistoryStepGroup;

            OnDeactivate();

            RendererList.Remove(_trackingNub);
            _trackingNub.Dispose();
            _trackingNub = null;

            DocumentWorkspace.ReturnScratchSurface(ScratchSurface);
            ScratchSurface = null;

            if (_saveRegion != null)
            {
                _saveRegion.Dispose();
                _saveRegion = null;
            }

            _savedTiles = null;

            if (HandCursor != null)
            {
                HandCursor.Dispose();
                HandCursor = null;
            }

            if (HandCursorMouseDown != null)
            {
                HandCursorMouseDown.Dispose();
                HandCursorMouseDown = null;
            }

            if (HandCursorInvalid == null) return;
            HandCursorInvalid.Dispose();
            HandCursorInvalid = null;
        }

        /// <summary>
        /// This method is called when the tool is being deactivated; that is, when the
        /// user has chosen to use another tool by clicking on another tool on a
        /// toolbar.
        /// </summary>
        protected virtual void OnDeactivate()
        {
        }

        private void StylusDown(StylusEventArgs e)
        {
            if (!_panMode)
            {
                OnStylusDown(e);
            }
        }

        protected virtual void OnStylusDown(StylusEventArgs e)
        {
        }

        private void StylusMove(StylusEventArgs e)
        {
            if (!_panMode)
            {
                OnStylusMove(e);
            }
        }

        protected virtual void OnStylusMove(StylusEventArgs e)
        {
            if (_mouseDown > 0)
            {
                ScrollIfNecessary(new PointF(e.X, e.Y));
            }
        }

        private void StylusUp(StylusEventArgs e)
        {
            if (_panTracking)
            {
                _trackingNub.Visible = false;
                _panTracking = false;
                Cursor = HandCursor;
            }
            else
            {
                OnStylusUp(e);
            }
        }

        protected virtual void OnStylusUp(StylusEventArgs e)
        {
        }

        private void MouseMove(MouseEventArgs e)
        {
            if (_ignoreMouseMove > 0)
            {
                --_ignoreMouseMove;
            }
            else if (_panTracking && e.Button == MouseButtons.Left)
            {
                // Pan the document, using Stylus coordinates. This is done in
                // MouseMove instead of StylusMove because StylusMove is
                // asynchronous, and would not 'feel' right (pan motions would
                // stack up)

                var position = new Point(e.X, e.Y);
                RectangleF visibleRect = DocumentWorkspace.VisibleDocumentRectangleF;
                PointF visibleCenterPt = Utility.GetRectangleCenter(visibleRect);
                var delta = new PointF(e.X - _lastPanMouseXY.X, e.Y - _lastPanMouseXY.Y);
                PointF newScroll = DocumentWorkspace.DocumentScrollPositionF;

                if (delta.X != 0 || delta.Y != 0)
                {
                    newScroll.X -= delta.X;
                    newScroll.Y -= delta.Y;

                    _lastPanMouseXY = new Point(e.X, e.Y);
                    _lastPanMouseXY.X -= (int)Math.Truncate(delta.X);
                    _lastPanMouseXY.Y -= (int)Math.Truncate(delta.Y);

                    ++_ignoreMouseMove; // setting DocumentScrollPosition incurs a MouseMove event. ignore it prevents 'jittering' at non-integral zoom levels (like, say, 743%)
                    DocumentWorkspace.DocumentScrollPositionF = newScroll;
                    Update();
                }

            }
            else if (!_panMode)
            {
                OnMouseMove(e);
            }

            _lastMouseXY = new Point(e.X, e.Y);
            _lastButton = e.Button;
        }

        /// <summary>
        /// This method is called when the Tool is active and the mouse is moving within
        /// the document canvas area.
        /// </summary>
        /// <param name="e">Contains information about where the mouse cursor is, in document coordinates.</param>
        protected virtual void OnMouseMove(MouseEventArgs e)
        {
            if (_panMode || _mouseDown > 0)
            {
                ScrollIfNecessary(new PointF(e.X, e.Y));
            }
        }

        private void MouseDown(MouseEventArgs e)
        {
            ++_mouseDown;
            
            if (_panMode)
            {
                _panTracking = true;
                _lastPanMouseXY = new Point(e.X, e.Y);

                if (CanPan())
                {
                    Cursor = HandCursorMouseDown;
                }
            }
            else
            {
                OnMouseDown(e);
            }

            _lastMouseXY = new Point(e.X, e.Y);
        }

        /// <summary>
        /// This method is called when the Tool is active and a mouse button has been
        /// pressed within the document area.
        /// </summary>
        /// <param name="e">Contains information about where the mouse cursor is, in document coordinates, and which mouse buttons were pressed.</param>
        protected virtual void OnMouseDown(MouseEventArgs e)
        {
            _lastButton = e.Button;
        }

        private void MouseUp(MouseEventArgs e)
        {
            --_mouseDown;

            if (!_panMode)
            {
                OnMouseUp(e);
            }

            _lastMouseXY = new Point(e.X, e.Y);
        }

        /// <summary>
        /// This method is called when the Tool is active and a mouse button has been
        /// released within the document area.
        /// </summary>
        /// <param name="e">Contains information about where the mouse cursor is, in document coordinates, and which mouse buttons were released.</param>
        protected virtual void OnMouseUp(MouseEventArgs e)
        {
            _lastButton = e.Button;
        }

        private void Click()
        {
            OnClick();
        }

        /// <summary>
        /// This method is called when the Tool is active and a mouse button has been
        /// clicked within the document area. If you need more specific information,
        /// such as where the mouse was clicked and which button was used, respond to
        /// the MouseDown/MouseUp events.
        /// </summary>
        protected virtual void OnClick()
        {
        }

        private void KeyPress(KeyPressEventArgs e)
        {
            OnKeyPress(e);
        }

        private static DateTime _lastToolSwitch = DateTime.MinValue;

        // if we are pressing 'S' to switch to the selection tools, then consecutive
        // presses of 'S' should switch to the next selection tol in the list. however,
        // if we wait awhile then pressing 'S' should go to the *first* selection
        // tool. 'awhile' is defined by this variable.
        private static readonly TimeSpan ToolSwitchReset = new TimeSpan(0, 0, 0, 2, 0);

        private const char DecPenSizeShortcut = '[';
        private const char DecPenSizeBy5Shortcut = (char)27; // Ctrl [ but must also test that Ctrl is down
        private const char IncPenSizeShortcut = ']';
        private const char IncPenSizeBy5Shortcut = (char)29; // Ctrl ] but must also test that Ctrl is down
        private const char SwapColorsShortcut = 'x';
        private const char SwapPrimarySecondaryChoice = 'c';
        private readonly char[] _wildShortcuts = new[] { ',', '.', '/' };

        // Return true if the key is handled, false if not.
        protected virtual bool OnWildShortcutKey(int ordinal)
        {
            return false;
        }

        /// <summary>
        /// This method is called when the tool is active and a keyboard key is pressed
        /// and released. If you respond to the keyboard key, set e.Handled to true.
        /// </summary>
        protected virtual void OnKeyPress(KeyPressEventArgs e)
        {
            if (e.Handled || !DocumentWorkspace.Focused) return;
            int wsIndex = Array.IndexOf(_wildShortcuts, e.KeyChar);

            if (wsIndex != -1)
            {
                e.Handled = OnWildShortcutKey(wsIndex);
            }
            else switch (e.KeyChar)
            {
                case SwapColorsShortcut:
                    AppWorkspace.Widgets.ColorsForm.SwapUserColors();
                    e.Handled = true;
                    break;
                case SwapPrimarySecondaryChoice:
                    AppWorkspace.Widgets.ColorsForm.ToggleWhichUserColor();
                    e.Handled = true;
                    break;
                case DecPenSizeShortcut:
                    AppWorkspace.Widgets.ToolConfigStrip.AddToPenSize(-1.0f);
                    e.Handled = true;
                    break;
                default:
                    if (e.KeyChar == DecPenSizeBy5Shortcut && (ModifierKeys & Keys.Control) != 0)
                    {
                        AppWorkspace.Widgets.ToolConfigStrip.AddToPenSize(-5.0f);
                        e.Handled = true;
                    }
                    else if (e.KeyChar == IncPenSizeShortcut)
                    {
                        AppWorkspace.Widgets.ToolConfigStrip.AddToPenSize(+1.0f);
                        e.Handled = true;
                    }
                    else if (e.KeyChar == IncPenSizeBy5Shortcut && (ModifierKeys & Keys.Control) != 0)
                    {
                        AppWorkspace.Widgets.ToolConfigStrip.AddToPenSize(+5.0f);
                        e.Handled = true;
                    }
                    else
                    {
                        ToolInfo[] toolInfos = DocumentWorkspace.ToolInfos;
                        Type currentToolType = DocumentWorkspace.GetToolType();
                        int currentTool = 0;

                        if (0 != (ModifierKeys & Keys.Shift))
                        {
                            Array.Reverse(toolInfos);
                        }

                        if (char.ToLower(HotKey) != char.ToLower(e.KeyChar) ||
                            (DateTime.Now - _lastToolSwitch) > ToolSwitchReset)
                        {
                            // If it's been a short time since they pressed a tool switching hotkey,
                            // we will start from the beginning of this list. This helps to enable two things:
                            // 1) If multiple tools have the same hotkey, the user may press that hotkey
                            //    to cycle through them
                            // 2) After a period of time, pressing the hotkey will revert to always
                            //    choosing the first tool in that list of tools which have the same hotkey.
                            currentTool = -1;
                        }
                        else
                        {
                            for (int t = 0; t < toolInfos.Length; ++t)
                            {
                                if (toolInfos[t].ToolType != currentToolType) continue;
                                currentTool = t;
                                break;
                            }
                        }

                        for (int t = 0; t < toolInfos.Length; ++t)
                        {
                            int newTool = (t + currentTool + 1) % toolInfos.Length;
                            ToolInfo localToolInfo = toolInfos[newTool];

                            if (localToolInfo.ToolType == DocumentWorkspace.GetToolType() &&
                                localToolInfo.SkipIfActiveOnHotKey)
                            {
                                continue;
                            }

                            if (char.ToLower(localToolInfo.HotKey) != char.ToLower(e.KeyChar)) continue;
                            if (!IsMouseDown)
                            {
                                AppWorkspace.Widgets.ToolsControl.SelectTool(localToolInfo.ToolType);
                            }

                            e.Handled = true;
                            _lastToolSwitch = DateTime.Now;
                            break;
                        }

                        // If the keypress is still not handled ...
                        if (!e.Handled)
                        {
                            switch (e.KeyChar)
                            {
                                    // By default, Esc/Enter clear the current selection if there is any
                                case (char)13: // Enter
                                case (char)27: // Escape
                                    if (_mouseDown == 0 && !Selection.IsEmpty)
                                    {
                                        e.Handled = true;
                                        DocumentWorkspace.ExecuteFunction(new DeselectFunction());
                                    }

                                    break;
                            }
                        }
                    }
                    break;
            }
        }

        private DateTime _lastKeyboardMove = DateTime.MinValue;
        private Keys _lastKey;
        private int _keyboardMoveSpeed = 1;
        private int _keyboardMoveRepeats = 0;

        private void KeyPress(Keys key)
        {
            OnKeyPress(key);
        }

        /// <summary>
        /// This method is called when the tool is active and a keyboard key is pressed
        /// and released that is not representable with a regular Unicode chararacter.
        /// An example would be the arrow keys.
        /// </summary>
        protected virtual void OnKeyPress(Keys key)
        {
            Point dir = Point.Empty;

            if (key != _lastKey) 
            {
                _lastKeyboardMove = DateTime.MinValue;
            }

            _lastKey = key;

            switch (key) 
            {
                case Keys.Left:
                    --dir.X;
                    break;

                case Keys.Right:
                    ++dir.X;
                    break;

                case Keys.Up:
                    --dir.Y;
                    break;

                case Keys.Down:
                    ++dir.Y;
                    break;              
            }

            if (dir.Equals(Point.Empty)) return;
            long span = DateTime.Now.Ticks - _lastKeyboardMove.Ticks;
                
            if ((span * 4) > TimeSpan.TicksPerSecond) 
            {
                _keyboardMoveRepeats = 0;
                _keyboardMoveSpeed = 1;
            }
            else
            {
                _keyboardMoveRepeats++;

                if (_keyboardMoveRepeats > 15 && (_keyboardMoveRepeats % 4) == 0)
                {
                    _keyboardMoveSpeed++;
                }
            }

            _lastKeyboardMove = DateTime.Now;
                
            var offset = (int)(Math.Ceiling(DocumentWorkspace.ScaleFactor.Ratio) * _keyboardMoveSpeed);
            Cursor.Position = new Point(Cursor.Position.X + offset * dir.X, Cursor.Position.Y + offset * dir.Y);
                
            Point location = DocumentWorkspace.PointToScreen(Point.Truncate(DocumentWorkspace.DocumentToClient(PointF.Empty)));

            var stylusLocF = new PointF((float)Cursor.Position.X - (float)location.X, (float)Cursor.Position.Y - (float)location.Y);
            var stylusLoc = new Point(Cursor.Position.X - location.X, Cursor.Position.Y - location.Y);

            stylusLoc = DocumentWorkspace.ScaleFactor.UnscalePoint(stylusLoc);
            stylusLocF = DocumentWorkspace.ScaleFactor.UnscalePoint(stylusLocF);

            DocumentWorkspace.PerformDocumentMouseMove(new StylusEventArgs(_lastButton, 1, stylusLocF.X, stylusLocF.Y, 0, 1.0f));
            DocumentWorkspace.PerformDocumentMouseMove(new MouseEventArgs(_lastButton, 1, stylusLoc.X, stylusLoc.Y, 0));
        }

        private bool CanPan()
        {
            Rectangle vis = Utility.RoundRectangle(DocumentWorkspace.VisibleDocumentRectangleF);
            vis.Intersect(Document.Bounds);

            return vis != Document.Bounds;
        }

        private void KeyUp(KeyEventArgs e)
        {
            if (_panMode)
            {
                _panMode = false;
                _panTracking = false;
                _trackingNub.Visible = false;
                Cursor = _panOldCursor;
                _panOldCursor = null;
                e.Handled = true;
            }

            OnKeyUp(e);
        }

        /// <summary>
        /// This method is called when the tool is active and a keyboard key is pressed.
        /// If you respond to the keyboard key, set e.Handled to true.
        /// </summary>
        protected virtual void OnKeyUp(KeyEventArgs e)
        {
            _keysThatAreDown.Clear();
        }

        private void KeyDown(KeyEventArgs e)
        {
            OnKeyDown(e);
        }

        /// <summary>
        /// This method is called when the tool is active and a keyboard key is released
        /// Before responding, check that e.Handled is false, and if you then respond to 
        /// the keyboard key, set e.Handled to true.
        /// </summary>
        protected virtual void OnKeyDown(KeyEventArgs e)
        {
            if (e.Handled) return;
            if (!_keysThatAreDown.Contains(e.KeyData))
            {
                _keysThatAreDown.Add(e.KeyData, new KeyTimeInfo());
            }

            if (!IsMouseDown && 
                !_panMode && 
                e.KeyCode == Keys.Space)
            {
                _panMode = true;
                _panOldCursor = Cursor;

                Cursor = CanPan() ? HandCursor : HandCursorInvalid;
            }

            // arrow keys are processed in another way
            // we get their KeyDown but no KeyUp, so they can not be handled
            // by our normal methods
            OnKeyPress(e.KeyData);
        }

        private void SelectionChanging()
        {
            OnSelectionChanging();
        }

        /// <summary>
        /// This method is called when the Tool is active and the selection area is
        /// about to be changed.
        /// </summary>
        protected virtual void OnSelectionChanging()
        {
        }

        private void SelectionChanged()
        {
            OnSelectionChanged();
        }

        /// <summary>
        /// This method is called when the Tool is active and the selection area has
        /// been changed.
        /// </summary>
        protected virtual void OnSelectionChanged()
        {
        }

        private void ExecutingHistoryMemento(object sender, ExecutingHistoryMementoEventArgs e)
        {
            OnExecutingHistoryMemento(e);
        }

        protected virtual void OnExecutingHistoryMemento(ExecutingHistoryMementoEventArgs e)
        {
        }

        private void ExecutedHistoryMemento(object sender, ExecutedHistoryMementoEventArgs e)
        {
            OnExecutedHistoryMemento(e);
        }

        protected virtual void OnExecutedHistoryMemento(ExecutedHistoryMementoEventArgs e)
        {
        }

        private void PasteQuery(IDataObject data, out bool canHandle)
        {
            OnPasteQuery(data, out canHandle);
        }

        /// <summary>
        /// This method is called when the system is querying a tool as to whether
        /// it can handle a pasted object.
        /// </summary>
        /// <param name="data">
        /// The clipboard data that was pasted by the user that should be inspected.
        /// </param>
        /// <param name="canHandle">
        /// <b>true</b> if the data can be handled by the tool, <b>false</b> if not.
        /// </param>
        /// <remarks>
        /// If you do not set canHandle to <b>true</b> then the tool will not be
        /// able to respond to the Edit menu's Paste item.
        /// </remarks>
        protected virtual void OnPasteQuery(IDataObject data, out bool canHandle)
        {
            canHandle = false;
        }

        private void Paste(IDataObject data, out bool handled)
        {
            OnPaste(data, out handled);
        }

        /// <summary>
        /// This method is called when the user invokes a paste operation. Tools get
        /// the first chance to handle this data.
        /// </summary>
        /// <param name="data">
        /// The data that was pasted by the user.
        /// </param>
        /// <param name="handled">
        /// <b>true</b> if the data was handled and pasted, <b>false</b> if not.
        /// </param>
        /// <remarks>
        /// If you do not set handled to <b>true</b> the event will be passed to the 
        /// global paste handler.
        /// </remarks>
        protected virtual void OnPaste(IDataObject data, out bool handled)
        {
            handled = false;
        }

        private void Pulse()
        {
            OnPulse();
        }

        protected bool IsFormActive
        {
            get
            {
                return (ReferenceEquals(Form.ActiveForm, DocumentWorkspace.FindForm()));
            }
        }

        /// <summary>
        /// This method is called many times per second, called by the DocumentWorkspace.
        /// </summary>
        protected virtual void OnPulse()
        {
            if (!_panTracking || _lastButton != MouseButtons.Right) return;
            Point position = _lastMouseXY;
            RectangleF visibleRect = DocumentWorkspace.VisibleDocumentRectangleF;
            PointF visibleCenterPt = Utility.GetRectangleCenter(visibleRect);
            var delta = new PointF(position.X - visibleCenterPt.X, position.Y - visibleCenterPt.Y);
            PointF newScroll = DocumentWorkspace.DocumentScrollPositionF;

            _trackingNub.Visible = true;

            if (delta.X == 0 && delta.Y == 0) return;
            newScroll.X += delta.X;
            newScroll.Y += delta.Y;

            ++_ignoreMouseMove; // setting DocumentScrollPosition incurs a MouseMove event. ignore it prevents 'jittering' at non-integral zoom levels (like, say, 743%)
            UI.SuspendControlPainting(DocumentWorkspace);
            DocumentWorkspace.DocumentScrollPositionF = newScroll;
            _trackingNub.Visible = true;
            _trackingNub.Location = Utility.GetRectangleCenter(DocumentWorkspace.VisibleDocumentRectangleF);
            UI.ResumeControlPainting(DocumentWorkspace);
            DocumentWorkspace.Invalidate(true);
            Update();
        }

        protected bool ScrollIfNecessary(PointF position) 
        {
            if (!AutoScroll || !CanPan()) 
            {
                return false;
            }

            RectangleF visible = DocumentWorkspace.VisibleDocumentRectangleF;
            PointF lastScrollPosition = DocumentWorkspace.DocumentScrollPositionF;
            PointF delta = PointF.Empty;
            PointF zoomedPoint = PointF.Empty;

            zoomedPoint.X = Utility.Lerp((visible.Left + visible.Right) / 2.0f, position.X, 1.02f);
            zoomedPoint.Y = Utility.Lerp((visible.Top + visible.Bottom) / 2.0f, position.Y, 1.02f);

            if (zoomedPoint.X < visible.Left) 
            {
                delta.X = zoomedPoint.X - visible.Left;
            }
            else if (zoomedPoint.X > visible.Right) 
            {
                delta.X = zoomedPoint.X - visible.Right;
            } 

            if (zoomedPoint.Y < visible.Top) 
            {
                delta.Y = zoomedPoint.Y - visible.Top;
            } 
            else if (zoomedPoint.Y > visible.Bottom) 
            {
                delta.Y = zoomedPoint.Y - visible.Bottom;
            }

            if (!delta.IsEmpty) 
            {
                var newScrollPosition = new PointF(lastScrollPosition.X + delta.X, lastScrollPosition.Y + delta.Y);
                DocumentWorkspace.DocumentScrollPositionF = newScrollPosition;
                Update();
                return true;
            }
            return false;
        }
        
        private void SelectionChangingHandler(object sender, EventArgs e)
        {
            OnSelectionChanging();
        }

        private void SelectionChangedHandler(object sender, EventArgs e)
        {
            OnSelectionChanged();
        }

        protected void SetStatus(ImageResource statusIcon, string statusText)
        {
            if (statusIcon == null && statusText != null)
            {
                statusIcon = PdnResources.GetImageResource("Icons.MenuHelpHelpTopicsIcon.png");
            }

            DocumentWorkspace.SetStatus(statusText, statusIcon);
        }

        protected SurfaceBoxRendererList RendererList
        {
            get
            {
                return DocumentWorkspace.RendererList;
            }
        }

        protected void Update()
        {
            DocumentWorkspace.Update();
        }

        protected object GetStaticData()
        {
            return DocumentWorkspace.GetStaticToolData(GetType());
        }

        protected void SetStaticData(object data)
        {
            DocumentWorkspace.SetStaticToolData(GetType(), data);
        }

        // NOTE: Your constructor must be able to run successfully with a documentWorkspace
        //       of null. This is sent in while the DocumentControl static constructor 
        //       class is building a list of ToolInfo instances, so that it may construct
        //       the list without having to also construct a DocumentControl.
        public Tool(DocumentWorkspace documentWorkspace,
                    ImageResource toolBarImage,
                    string name,
                    string helpText,
                    char hotKey,
                    bool skipIfActiveOnHotKey,
                    ToolBarConfigItems toolBarConfigItems)
        {
            _documentWorkspace = documentWorkspace;
            _toolBarImage = toolBarImage;
            _toolInfo = new ToolInfo(name, helpText, toolBarImage, hotKey, skipIfActiveOnHotKey, toolBarConfigItems, GetType());

            if (_documentWorkspace != null)
            {
                _documentWorkspace.UpdateStatusBarToToolHelpText(this);
            }
        }

        ~Tool()
        {
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing)
        {
            Debug.Assert(!Active, "Tool is still active!");

            if (!disposing) return;
            if (_saveRegion != null)
            {
                _saveRegion.Dispose();
                _saveRegion = null;
            }

            OnDisposed();
        }

        public event EventHandler Disposed;
        private void OnDisposed()
        {
            if (Disposed != null)
            {
                Disposed(this, EventArgs.Empty);
            }
        }

        public Form AssociatedForm
        {
            get
            {
                return AppWorkspace.FindForm();
            }
        }
    }
}
Back to Top