OpenTween/ControlTransaction.cs

   1 // OpenTween - Client of Twitter
   2 // Copyright (c) 2014 kim_upsilon (@kim_upsilon) <https://upsilo.net/~upsilon/>
   3 // All rights reserved.
   4 //
   5 // This file is part of OpenTween.
   6 //
   7 // This program is free software; you can redistribute it and/or modify it
   8 // under the terms of the GNU General Public License as published by the Free
   9 // Software Foundation; either version 3 of the License, or (at your option)
  10 // any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  15 // for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with this program. If not, see <http://www.gnu.org/licenses/>, or write to
  19 // the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
  20 // Boston, MA 02110-1301, USA.
  21
  22 #nullable enable
  23
  24 using System;
  25 using System.Collections.Generic;
  26 using System.ComponentModel;
  27 using System.Linq;
  28 using System.Text;
  29 using System.Windows.Forms;
  30
  31 namespace OpenTween
  32 {
  33     /// <summary>
  34     /// WinformsコントロールのBegin/EndUpdate等のメソッドをusingブロックによって呼び出すためのクラス
  35     /// </summary>
  36     public static class ControlTransaction
  37     {
  38         public static IDisposable Update(ListView control)
  39             => new Transaction<ListView>(control, x => x.BeginUpdate(), x => x.EndUpdate());
  40
  41         public static IDisposable Update(ListBox control)
  42             => new Transaction<ListBox>(control, x => x.BeginUpdate(), x => x.EndUpdate());
  43
  44         public static IDisposable Update(ComboBox control)
  45             => new Transaction<ComboBox>(control, x => x.BeginUpdate(), x => x.EndUpdate());
  46
  47         public static IDisposable Update(TreeView control)
  48             => new Transaction<TreeView>(control, x => x.BeginUpdate(), x => x.EndUpdate());
  49
  50         public static IDisposable Update(Control control)
  51         {
  52             // Begin/EndUpdate メソッドを持たないコントロールに対しては、
  53             // WM_SETREDRAW メッセージを直接コントロールに送信する。
  54             return new Transaction<Control>(control,
  55                 x => NativeMethods.SetRedrawState(x, false),
  56                 x =>
  57                 {
  58                     NativeMethods.SetRedrawState(x, true);
  59                     x.Invalidate(true);
  60                 });
  61         }
  62
  63         public static IDisposable Layout(Control control)
  64             => Layout(control, performLayout: true);
  65
  66         public static IDisposable Layout(Control control, bool performLayout)
  67             => new Transaction<Control>(control, x => x.SuspendLayout(), x => x.ResumeLayout(performLayout));
  68
  69         public static IDisposable Init(ISupportInitialize control)
  70             => new Transaction<ISupportInitialize>(control, x => x.BeginInit(), x => x.EndInit());
  71
  72         public static IDisposable Cursor(Control control, Cursor newCursor)
  73         {
  74             var oldCursor = control.Cursor;
  75
  76             return new Transaction<Control>(control, x => x.Cursor = newCursor, x => x.Cursor = oldCursor);
  77         }
  78
  79         public static IDisposable Enabled(Control control)
  80         {
  81             var oldState = control.Enabled;
  82
  83             return new Transaction<Control>(control, x => x.Enabled = true, x => x.Enabled = oldState);
  84         }
  85
  86         public static IDisposable Disabled(Control control)
  87         {
  88             var oldState = control.Enabled;
  89
  90             return new Transaction<Control>(control, x => x.Enabled = false, x => x.Enabled = oldState);
  91         }
  92
  93         private class Transaction<T> : IDisposable
  94         {
  95             private readonly T control;
  96
  97             private readonly Action<T> beginTransaction;
  98             private readonly Action<T> endTransaction;
  99
 100             internal Transaction(T control, Action<T> beginTrans, Action<T> endTrans)
 101             {
 102                 this.control = control;
 103
 104                 this.beginTransaction = beginTrans;
 105                 this.endTransaction = endTrans;
 106
 107                 this.beginTransaction(this.control);
 108             }
 109
 110             public void Dispose()
 111                 => this.endTransaction(this.control);
 112         }
 113     }
 114 }