Merge pull request #24 from nea/master

Added: GetScrollInfo functionality for the Scintilla main view

Author: kbilsted

Demo Plugin/NppManagedPluginDemo/Demo.cs

@@ -9,6 +9,7 @@
 using System.Runtime.InteropServices;
 using System.Text.RegularExpressions;
 using Kbg.NppPluginNET.PluginInfrastructure;
+using static Kbg.NppPluginNET.PluginInfrastructure.Win32;
 
 namespace Kbg.NppPluginNET
 {
@@ -126,6 +127,24 @@ static internal void CommandMenuInit()
             PluginBase.SetCommand(14, "---", null);
 
             PluginBase.SetCommand(15, "Dockable Dialog Demo", DockableDlgDemo); idFrmGotToLine = 15;
+
+            PluginBase.SetCommand(16, "---", null);
+
+            PluginBase.SetCommand(17, "Print Scroll and Row Information", PrintScrollInformation);
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        static void PrintScrollInformation()
+        {
+            ScrollInfo scrollInfo = editor.GetScrollInfo(ScrollInfoMask.SIF_RANGE | ScrollInfoMask.SIF_TRACKPOS | ScrollInfoMask.SIF_PAGE, ScrollInfoBar.SB_VERT);
+            var scrollRatio = (double)scrollInfo.nTrackPos / (scrollInfo.nMax - scrollInfo.nPage);
+            var scrollPercentage = Math.Min(scrollRatio, 1) * 100;
+            editor.ReplaceSel($@"The maximum row in the current document was {scrollInfo.nMax+1}.
+A maximum of {scrollInfo.nPage} rows is visible at a time.
+The current scroll ratio is {Math.Round(scrollPercentage, 2)}%.
+");
         }
 
         static internal void SetToolBarIcon()

Visual Studio Project Template C#/PluginInfrastructure/IScintillaGateway.cs

@@ -1,5 +1,6 @@
 // NPP plugin platform for .Net v0.93.96 by Kasper B. Graversen etc.
 using System;
+using static Kbg.NppPluginNET.PluginInfrastructure.Win32;
 
 namespace Kbg.NppPluginNET.PluginInfrastructure
 {
@@ -23,6 +24,13 @@ public interface IScintillaGateway
         /// </summary>
         int GetCurrentLineNumber();
 
+        /// <summary>
+        /// Get the scroll information for the current Scintilla window.
+        /// </summary>
+        /// <param name="mask">Arguments for the scroll information such as tracking</param>
+        /// <param name="scrollBar">Which scroll bar information are you looking for</param>
+        /// <returns>A ScrollInfo struct with information of the current scroll state</returns>
+        ScrollInfo GetScrollInfo(ScrollInfoMask mask = ScrollInfoMask.SIF_ALL, ScrollInfoBar scrollBar = ScrollInfoBar.SB_BOTH);
 
         /* ++Autogenerated -- start of section automatically generated from Scintilla.iface */
         /// <summary>Add text to the document at current position. (Scintilla feature 2001)</summary>

Visual Studio Project Template C#/PluginInfrastructure/ScintillaGateway.cs

@@ -1,6 +1,8 @@
 // NPP plugin platform for .Net v0.93.96 by Kasper B. Graversen etc.
 using System;
+using System.Runtime.InteropServices;
 using System.Text;
+using static Kbg.NppPluginNET.PluginInfrastructure.Win32;
 
 namespace Kbg.NppPluginNET.PluginInfrastructure
 {
@@ -66,6 +68,21 @@ public int GetCurrentLineNumber()
             return LineFromPosition(GetCurrentPos()); 
         }
 
+        /// <summary>
+        /// Get the scroll information for the current Scintilla window.
+        /// </summary>
+        /// <param name="mask">Arguments for the scroll information such as tracking</param>
+        /// <param name="scrollBar">Which scroll bar information are you looking for</param>
+        /// <returns>A ScrollInfo struct with information of the current scroll state</returns>
+        public ScrollInfo GetScrollInfo(ScrollInfoMask mask = ScrollInfoMask.SIF_ALL, ScrollInfoBar scrollBar = ScrollInfoBar.SB_BOTH)
+        {
+            ScrollInfo scrollInfo = new ScrollInfo();
+            scrollInfo.cbSize = (uint)Marshal.SizeOf(scrollInfo);
+            scrollInfo.fMask = (uint)mask;
+            Win32.GetScrollInfo(scintilla, (int)scrollBar, ref scrollInfo);
+            return scrollInfo;
+        }
+
         /* ++Autogenerated -- start of section automatically generated from Scintilla.iface */
         /// <summary>Add text to the document at current position. (Scintilla feature 2001)</summary>
         public unsafe void AddText(int length, string text)

Visual Studio Project Template C#/PluginInfrastructure/Win32.cs

@@ -8,6 +8,76 @@ namespace Kbg.NppPluginNET.PluginInfrastructure
 {
     public class Win32
     {
+        /// <summary>
+        /// Get the scroll information of a scroll bar or window with scroll bar
+        /// @see https://msdn.microsoft.com/en-us/library/windows/desktop/bb787537(v=vs.85).aspx
+        /// </summary>
+        [StructLayout(LayoutKind.Sequential)]
+        public struct ScrollInfo
+        {
+            /// <summary>
+            /// Specifies the size, in bytes, of this structure. The caller must set this to sizeof(SCROLLINFO).
+            /// </summary>
+            public uint cbSize;
+            /// <summary>
+            /// Specifies the scroll bar parameters to set or retrieve.
+            /// @see ScrollInfoMask
+            /// </summary>
+            public uint fMask;
+            /// <summary>
+            /// Specifies the minimum scrolling position.
+            /// </summary>
+            public int nMin;
+            /// <summary>
+            /// Specifies the maximum scrolling position.
+            /// </summary>
+            public int nMax;
+            /// <summary>
+            /// Specifies the page size, in device units. A scroll bar uses this value to determine the appropriate size of the proportional scroll box.
+            /// </summary>
+            public uint nPage;
+            /// <summary>
+            /// Specifies the position of the scroll box.
+            /// </summary>
+            public int nPos;
+            /// <summary>
+            /// Specifies the immediate position of a scroll box that the user is dragging. 
+            /// An application can retrieve this value while processing the SB_THUMBTRACK request code. 
+            /// An application cannot set the immediate scroll position; the SetScrollInfo function ignores this member.
+            /// </summary>
+            public int nTrackPos;
+        }
+
+        /// <summary>
+        /// Used for the ScrollInfo fMask
+        /// SIF_ALL             => Combination of SIF_PAGE, SIF_POS, SIF_RANGE, and SIF_TRACKPOS.
+        /// SIF_DISABLENOSCROLL => This value is used only when setting a scroll bar's parameters. If the scroll bar's new parameters make the scroll bar unnecessary, disable the scroll bar instead of removing it.
+        /// SIF_PAGE            => The nPage member contains the page size for a proportional scroll bar.
+        /// SIF_POS             => The nPos member contains the scroll box position, which is not updated while the user drags the scroll box.
+        /// SIF_RANGE           => The nMin and nMax members contain the minimum and maximum values for the scrolling range.
+        /// SIF_TRACKPOS        => The nTrackPos member contains the current position of the scroll box while the user is dragging it.
+        /// </summary>
+        public enum ScrollInfoMask
+        {
+            SIF_RANGE = 0x1,
+            SIF_PAGE = 0x2,
+            SIF_POS = 0x4,
+            SIF_DISABLENOSCROLL = 0x8,
+            SIF_TRACKPOS = 0x10,
+            SIF_ALL = SIF_RANGE + SIF_PAGE + SIF_POS + SIF_TRACKPOS
+        }
+
+        /// <summary>
+        /// Used for the GetScrollInfo() nBar parameter
+        /// </summary>
+        public enum ScrollInfoBar
+        {
+            SB_HORZ = 0,
+            SB_VERT = 1,
+            SB_CTL = 2,
+            SB_BOTH = 3
+        }
+
         /// <summary>
         /// You should try to avoid calling this method in your plugin code. Rather use one of the gateways such as 
         /// <see cref="ScintillaGateway"/> or <see cref="NotepadPPGateway"/>.  
@@ -229,5 +299,15 @@ public static IntPtr SendMessage(IntPtr hWnd, uint Msg, int wParam, ref LangType
 
         [DllImport("kernel32")]
         public static extern void OutputDebugString(string lpOutputString);
+
+        /// <summary>
+        /// @see https://msdn.microsoft.com/en-us/library/windows/desktop/bb787583(v=vs.85).aspx
+        /// </summary>
+        /// <param name="hwnd"></param>
+        /// <param name="nBar"></param>
+        /// <param name="scrollInfo"></param>
+        /// <returns></returns>
+        [DllImport("user32")]
+        public static extern int GetScrollInfo(IntPtr hwnd, int nBar, ref ScrollInfo scrollInfo);
     }
 }