Imported existing sources

2017-02-04 13:47:58 +01:00
parent 14a5be61cc
commit 7c97b9e539
86 changed files with 49665 additions and 0 deletions
@@ -0,0 +1,219 @@
+/*
+ * DragSource.cs - Add drag source functionality to an ObjectListView
+ *
+ * Author: Phillip Piper
+ * Date: 2009-03-17 5:15 PM
+ *
+ * Change log:
+ * 2011-03-29   JPP  - Separate OLVDataObject.cs
+ * v2.3
+ * 2009-07-06   JPP  - Make sure Link is acceptable as an drop effect by default
+ *                     (since MS didn't make it part of the 'All' value)
+ * v2.2
+ * 2009-04-15   JPP  - Separated DragSource.cs into DropSink.cs
+ * 2009-03-17   JPP  - Initial version
+ * 
+ * Copyright (C) 2009-2014 Phillip Piper
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ * If you wish to use this code in a closed source application, please contact phillip_piper@bigfoot.com.
+ */
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Text;
+using System.Windows.Forms;
+using System.Drawing;
+using System.Drawing.Drawing2D;
+
+namespace BrightIdeasSoftware
+{
+    /// <summary>
+    /// An IDragSource controls how drag out from the ObjectListView will behave
+    /// </summary>
+    public interface IDragSource
+    {
+        /// <summary>
+        /// A drag operation is beginning. Return the data object that will be used 
+        /// for data transfer. Return null to prevent the drag from starting. The data
+        /// object will normally include all the selected objects.
+        /// </summary>
+        /// <remarks>
+        /// The returned object is later passed to the GetAllowedEffect() and EndDrag()
+        /// methods.
+        /// </remarks>
+        /// <param name="olv">What ObjectListView is being dragged from.</param>
+        /// <param name="button">Which mouse button is down?</param>
+        /// <param name="item">What item was directly dragged by the user? There may be more than just this 
+        /// item selected.</param>
+        /// <returns>The data object that will be used for data transfer. This will often be a subclass
+        /// of DataObject, but does not need to be.</returns>
+        Object StartDrag(ObjectListView olv, MouseButtons button, OLVListItem item);
+
+        /// <summary>
+        /// What operations are possible for this drag? This controls the icon shown during the drag
+        /// </summary>
+        /// <param name="dragObject">The data object returned by StartDrag()</param>
+        /// <returns>A combination of DragDropEffects flags</returns>
+        DragDropEffects GetAllowedEffects(Object dragObject);
+
+        /// <summary>
+        /// The drag operation is complete. Do whatever is necessary to complete the action.
+        /// </summary>
+        /// <param name="dragObject">The data object returned by StartDrag()</param>
+        /// <param name="effect">The value returned from GetAllowedEffects()</param>
+        void EndDrag(Object dragObject, DragDropEffects effect);
+    }
+
+    /// <summary>
+    /// A do-nothing implementation of IDragSource that can be safely subclassed.
+    /// </summary>
+    public class AbstractDragSource : IDragSource
+    {
+        #region IDragSource Members
+
+        /// <summary>
+        /// See IDragSource documentation
+        /// </summary>
+        /// <param name="olv"></param>
+        /// <param name="button"></param>
+        /// <param name="item"></param>
+        /// <returns></returns>
+        public virtual Object StartDrag(ObjectListView olv, MouseButtons button, OLVListItem item) {
+            return null;
+        }
+
+        /// <summary>
+        /// See IDragSource documentation
+        /// </summary>
+        /// <param name="data"></param>
+        /// <returns></returns>
+        public virtual DragDropEffects GetAllowedEffects(Object data) {
+            return DragDropEffects.None;
+        }
+
+        /// <summary>
+        /// See IDragSource documentation
+        /// </summary>
+        /// <param name="dragObject"></param>
+        /// <param name="effect"></param>
+        public virtual void EndDrag(Object dragObject, DragDropEffects effect) {
+        }
+
+        #endregion
+    }
+
+    /// <summary>
+    /// A reasonable implementation of IDragSource that provides normal
+    /// drag source functionality. It creates a data object that supports
+    /// inter-application dragging of text and HTML representation of 
+    /// the dragged rows. It can optionally force a refresh of all dragged
+    /// rows when the drag is complete.
+    /// </summary>
+    /// <remarks>Subclasses can override GetDataObject() to add new
+    /// data formats to the data transfer object.</remarks>
+    public class SimpleDragSource : IDragSource
+    {
+        #region Constructors
+
+        /// <summary>
+        /// Construct a SimpleDragSource
+        /// </summary>
+        public SimpleDragSource() {
+        }
+
+        /// <summary>
+        /// Construct a SimpleDragSource that refreshes the dragged rows when
+        /// the drag is complete
+        /// </summary>
+        /// <param name="refreshAfterDrop"></param>
+        public SimpleDragSource(bool refreshAfterDrop) {
+            this.RefreshAfterDrop = refreshAfterDrop;
+        }
+
+        #endregion
+
+        #region Public properties
+
+        /// <summary>
+        /// Gets or sets whether the dragged rows should be refreshed when the 
+        /// drag operation is complete.
+        /// </summary>
+        public bool RefreshAfterDrop {
+            get { return refreshAfterDrop; }
+            set { refreshAfterDrop = value;  }
+        }
+        private bool refreshAfterDrop;
+
+        #endregion
+
+        #region IDragSource Members
+
+        /// <summary>
+        /// Create a DataObject when the user does a left mouse drag operation.
+        /// See IDragSource for further information.
+        /// </summary>
+        /// <param name="olv"></param>
+        /// <param name="button"></param>
+        /// <param name="item"></param>
+        /// <returns></returns>
+        public virtual Object StartDrag(ObjectListView olv, MouseButtons button, OLVListItem item) {
+            // We only drag on left mouse
+            if (button != MouseButtons.Left)
+                return null;
+
+            return this.CreateDataObject(olv);
+        }
+
+        /// <summary>
+        /// Which operations are allowed in the operation? By default, all operations are supported.
+        /// </summary>
+        /// <param name="data"></param>
+        /// <returns>All opertions are supported</returns>
+        public virtual DragDropEffects GetAllowedEffects(Object data) {
+            return DragDropEffects.All | DragDropEffects.Link; // why didn't MS include 'Link' in 'All'??
+        }
+
+        /// <summary>
+        /// The drag operation is finished. Refreshe the dragged rows if so configured.
+        /// </summary>
+        /// <param name="dragObject"></param>
+        /// <param name="effect"></param>
+        public virtual void EndDrag(Object dragObject, DragDropEffects effect) {
+            OLVDataObject data = dragObject as OLVDataObject;
+            if (data == null)
+                return;
+
+            if (this.RefreshAfterDrop)
+                data.ListView.RefreshObjects(data.ModelObjects);
+        }
+
+        /// <summary>
+        /// Create a data object that will be used to as the data object
+        /// for the drag operation.
+        /// </summary>
+        /// <remarks>
+        /// Subclasses can override this method add new formats to the data object.
+        /// </remarks>
+        /// <param name="olv">The ObjectListView that is the source of the drag</param>
+        /// <returns>A data object for the drag</returns>
+        protected virtual object CreateDataObject(ObjectListView olv) {
+            return new OLVDataObject(olv);
+        }
+
+        #endregion
+    }
+}
@@ -0,0 +1,185 @@
+/*
+ * OLVDataObject.cs - An OLE DataObject that knows how to convert rows of an OLV to text and HTML
+ *
+ * Author: Phillip Piper
+ * Date: 2011-03-29 3:34PM
+ *
+ * Change log:
+ * v2.8
+ * 2014-05-02   JPP  - When the listview is completely empty, don't try to set CSV text in the clipboard.
+ * v2.6
+ * 2012-08-08   JPP  - Changed to use OLVExporter.
+ *                   - Added CSV to formats exported to Clipboard
+ * v2.4
+ * 2011-03-29   JPP  - Initial version
+ * 
+ * Copyright (C) 2011-2014 Phillip Piper
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ *
+ * If you wish to use this code in a closed source application, please contact phillip_piper@bigfoot.com.
+ */
+
+using System;
+using System.Collections;
+using System.Windows.Forms;
+
+namespace BrightIdeasSoftware {
+    
+    /// <summary>
+    /// A data transfer object that knows how to transform a list of model
+    /// objects into a text and HTML representation.
+    /// </summary>
+    public class OLVDataObject : DataObject {
+        #region Life and death
+
+        /// <summary>
+        /// Create a data object from the selected objects in the given ObjectListView
+        /// </summary>
+        /// <param name="olv">The source of the data object</param>
+        public OLVDataObject(ObjectListView olv)
+            : this(olv, olv.SelectedObjects) {
+        }
+
+        /// <summary>
+        /// Create a data object which operates on the given model objects 
+        /// in the given ObjectListView
+        /// </summary>
+        /// <param name="olv">The source of the data object</param>
+        /// <param name="modelObjects">The model objects to be put into the data object</param>
+        public OLVDataObject(ObjectListView olv, IList modelObjects) {
+            this.objectListView = olv;
+            this.modelObjects = modelObjects;
+            this.includeHiddenColumns = olv.IncludeHiddenColumnsInDataTransfer;
+            this.includeColumnHeaders = olv.IncludeColumnHeadersInCopy;
+            this.CreateTextFormats();
+        }
+
+        #endregion
+
+        #region Properties
+
+        /// <summary>
+        /// Gets or sets whether hidden columns will also be included in the text
+        /// and HTML representation. If this is false, only visible columns will
+        /// be included.
+        /// </summary>
+        public bool IncludeHiddenColumns {
+            get { return includeHiddenColumns; }
+        }
+        private readonly bool includeHiddenColumns;
+
+        /// <summary>
+        /// Gets or sets whether column headers will also be included in the text
+        /// and HTML representation.
+        /// </summary>
+        public bool IncludeColumnHeaders {
+            get { return includeColumnHeaders; }
+        }
+        private readonly bool includeColumnHeaders;
+
+        /// <summary>
+        /// Gets the ObjectListView that is being used as the source of the data
+        /// </summary>
+        public ObjectListView ListView {
+            get { return objectListView; }
+        }
+        private readonly ObjectListView objectListView;
+
+        /// <summary>
+        /// Gets the model objects that are to be placed in the data object
+        /// </summary>
+        public IList ModelObjects {
+            get { return modelObjects; }
+        }
+        private readonly IList modelObjects;
+
+        #endregion
+
+        /// <summary>
+        /// Put a text and HTML representation of our model objects
+        /// into the data object.
+        /// </summary>
+        public void CreateTextFormats() {
+
+            OLVExporter exporter = this.CreateExporter();
+
+            // Put both the text and html versions onto the clipboard.
+            // For some reason, SetText() with UnicodeText doesn't set the basic CF_TEXT format,
+            // but using SetData() does.
+            //this.SetText(sbText.ToString(), TextDataFormat.UnicodeText);
+            this.SetData(exporter.ExportTo(OLVExporter.ExportFormat.TabSeparated));
+            string exportTo = exporter.ExportTo(OLVExporter.ExportFormat.CSV);
+            if (!String.IsNullOrEmpty(exportTo))
+                this.SetText(exportTo, TextDataFormat.CommaSeparatedValue);
+            this.SetText(ConvertToHtmlFragment(exporter.ExportTo(OLVExporter.ExportFormat.HTML)), TextDataFormat.Html);
+        }
+
+        /// <summary>
+        /// Create an exporter for the data contained in this object
+        /// </summary>
+        /// <returns></returns>
+        protected OLVExporter CreateExporter() {
+            OLVExporter exporter = new OLVExporter(this.ListView);
+            exporter.IncludeColumnHeaders = this.IncludeColumnHeaders;
+            exporter.IncludeHiddenColumns = this.IncludeHiddenColumns;
+            exporter.ModelObjects = this.ModelObjects;
+            return exporter;
+        }
+
+        /// <summary>
+        /// Make a HTML representation of our model objects
+        /// </summary>
+        [Obsolete("Use OLVExporter directly instead", false)]
+        public string CreateHtml() {
+            OLVExporter exporter = this.CreateExporter();
+            return exporter.ExportTo(OLVExporter.ExportFormat.HTML);
+        }
+
+        /// <summary>
+        /// Convert the fragment of HTML into the Clipboards HTML format.
+        /// </summary>
+        /// <remarks>The HTML format is found here http://msdn2.microsoft.com/en-us/library/aa767917.aspx
+        /// </remarks>
+        /// <param name="fragment">The HTML to put onto the clipboard. It must be valid HTML!</param>
+        /// <returns>A string that can be put onto the clipboard and will be recognized as HTML</returns>
+        private string ConvertToHtmlFragment(string fragment) {
+            // Minimal implementation of HTML clipboard format
+            const string SOURCE = "http://www.codeproject.com/Articles/16009/A-Much-Easier-to-Use-ListView";
+
+            const String MARKER_BLOCK =
+                "Version:1.0\r\n" +
+                "StartHTML:{0,8}\r\n" +
+                "EndHTML:{1,8}\r\n" +
+                "StartFragment:{2,8}\r\n" +
+                "EndFragment:{3,8}\r\n" +
+                "StartSelection:{2,8}\r\n" +
+                "EndSelection:{3,8}\r\n" +
+                "SourceURL:{4}\r\n" +
+                "{5}";
+
+            int prefixLength = String.Format(MARKER_BLOCK, 0, 0, 0, 0, SOURCE, "").Length;
+
+            const String DEFAULT_HTML_BODY =
+                "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">" +
+                "<HTML><HEAD></HEAD><BODY><!--StartFragment-->{0}<!--EndFragment--></BODY></HTML>";
+
+            string html = String.Format(DEFAULT_HTML_BODY, fragment);
+            int startFragment = prefixLength + html.IndexOf(fragment, StringComparison.Ordinal);
+            int endFragment = startFragment + fragment.Length;
+
+            return String.Format(MARKER_BLOCK, prefixLength, prefixLength + html.Length, startFragment, endFragment, SOURCE, html);
+        }
+    }
+}