wrb 2.0.0

data/lib/wrb/components/tabctrl.rb

@@ -0,0 +1,686 @@
+require 'wrb'
+require 'wrb/commctrlconst'
+
+module WR
+  module RC
+    TCS_SCROLLOPPOSITE    = 0x1
+    TCS_BOTTOM            = 0x2
+    TCS_RIGHT             = 0x2
+    TCS_MULTISELECT       = 0x4
+    TCS_FLATBUTTONS       = 0x8
+    TCS_FORCEICONLEFT     = 0x10
+    TCS_FORCELABELLEFT    = 0x20
+    TCS_HOTTRACK          = 0x40
+    TCS_VERTICAL          = 0x80
+    TCS_TABS              = 0x0
+    TCS_BUTTONS           = 0x100
+    TCS_SINGLELINE        = 0x0
+    TCS_MULTILINE         = 0x200
+    TCS_RIGHTJUSTIFY      = 0x0
+    TCS_FIXEDWIDTH        = 0x400
+    TCS_RAGGEDRIGHT       = 0x800
+    TCS_FOCUSONBUTTONDOWN = 0x1000
+    TCS_OWNERDRAWFIXED    = 0x2000
+    TCS_TOOLTIPS          = 0x4000
+    TCS_FOCUSNEVER        = 0x8000
+
+    TCS_EX_FLATSEPARATORS = 0x1
+    TCS_EX_REGISTERDROP   = 0x2
+    
+    TCM_FIRST            = 0x1300
+    TCM_GETIMAGELIST     = TCM_FIRST+2
+    TCM_SETIMAGELIST     = TCM_FIRST+3
+    TCM_GETITEMCOUNT     = TCM_FIRST+4
+    TCM_GETITEMA         = TCM_FIRST+5
+    TCM_GETITEMW         = TCM_FIRST+60
+    TCM_SETITEMA         = TCM_FIRST+6
+    TCM_SETITEMW         = TCM_FIRST+61
+    TCM_INSERTITEMA      = TCM_FIRST+7
+    TCM_INSERTITEMW      = TCM_FIRST+62
+    TCM_DELETEITEM       = TCM_FIRST+8
+    TCM_DELETEALLITEMS   = TCM_FIRST+9
+    TCM_GETITEMRECT      = TCM_FIRST+10
+    TCM_GETCURSEL        = TCM_FIRST+11
+    TCM_SETCURSEL        = TCM_FIRST+12
+    TCM_HITTEST          = TCM_FIRST+13
+    TCM_SETITEMEXTRA     = TCM_FIRST+14
+    TCM_ADJUSTRECT       = TCM_FIRST+40
+    TCM_SETITEMSIZE      = TCM_FIRST+41
+    TCM_REMOVEIMAGE      = TCM_FIRST+42
+    TCM_SETPADDING       = TCM_FIRST+43
+    TCM_GETROWCOUNT      = TCM_FIRST+44
+    TCM_GETTOOLTIPS      = TCM_FIRST+45
+    TCM_SETTOOLTIPS      = TCM_FIRST+46
+    TCM_GETCURFOCUS      = TCM_FIRST+47
+    TCM_SETCURFOCUS      = TCM_FIRST+48
+    TCM_SETMINTABWIDTH   = TCM_FIRST+49
+    TCM_DESELECTALL      = TCM_FIRST+50
+    TCM_HIGHLIGHTITEM    = TCM_FIRST+51
+    TCM_SETEXTENDEDSTYLE = TCM_FIRST+52
+    TCM_GETEXTENDEDSTYLE = TCM_FIRST+53
+    
+    if RWin::UNICODE
+      TCM_GETITEM        = TCM_GETITEMW
+      TCM_SETITEM        = TCM_SETITEMW
+      TCM_INSERTITEM     = TCM_INSERTITEMW
+    else
+      TCM_GETITEM        = TCM_GETITEMA
+      TCM_SETITEM        = TCM_SETITEMA
+      TCM_INSERTITEM     = TCM_INSERTITEMA
+    end
+
+    TCN_FIRST          = -550
+    TCN_KEYDOWN        = TCN_FIRST-0
+    TCN_SELCHANGE      = TCN_FIRST-1
+    TCN_SELCHANGING    = TCN_FIRST-2
+    TCN_GETOBJECT      = TCN_FIRST-3
+    TCN_FOCUSCHANGE    = TCN_FIRST-4
+    
+    TCIF_TEXT          = 0x1
+    TCIF_IMAGE         = 0x2
+    TCIF_RTLREADING    = 0x4
+    TCIF_PARAM         = 0x8
+    TCIF_STATE         = 0x10
+
+    TCIS_BUTTONPRESSED = 0x1
+    TCIS_HIGHLIGHTED   = 0x2
+    
+    TCHT_NOWHERE       = 0x1
+    TCHT_ONITEMICON    = 0x2
+    TCHT_ONITEMLABEL   = 0x4
+    TCHT_ONITEM        = (TCHT_ONITEMICON | TCHT_ONITEMLABEL)
+  end
+  
+  # This control is analogous to the dividers in a notebook or the labels in a file cabinet.
+  # <br>See also <a href="https://docs.microsoft.com/en-us/windows/desktop/Controls/
+  # window-controls"> Windows Control section of Microsoft Docs.</a>
+  class Tabctrl < WinControl
+    
+    TCITEMHEADER = API.defstruct "
+      UINT mask;
+      UINT lpReserved1;
+      UINT lpReserved2;
+      LPTSTR pszText;
+      int cchTextMax;
+      int iImage;"
+    
+    TCITEM = API.defstruct "
+      UINT   mask;
+      DWORD  dwState;
+      DWORD  dwStateMask;
+      LPTSTR pszText;
+      int    cchTextMax;
+      int    iImage;
+      LPARAM lParam;"
+    
+    TCHITTESTINFO = API.defstruct "
+      POINT pt;
+      UINT flags;"
+    
+    TCKEYDOWN = API.defstruct "
+      NMHDR hdr;
+      WORD wVKey;
+      UINT flags;"
+    
+    NMTCKEYDOWN = API.defstruct "
+      NMHDR hdr;
+      WORD  wVKey;
+      UINT  flags;"
+      
+    # Holder of TCITEM and tab index
+    class Tab 
+      include ModAccessor
+      class Controls < Collection
+        def initialize(onr)
+          @owner = onr
+        end
+        
+        def <<(arg)# dpp arg
+          @owner.owner << arg unless arg.idcmd
+          @owner._add_accessor(arg, "#{arg.name}".intern)
+          @owner.instance_eval("def _#{arg.name}() #{arg.name}; end")
+          class << arg
+            attr_accessor :owner
+          end
+          arg.owner = self
+          super(arg)
+          self.uniq!
+          arg
+        end
+        
+        def show() #; dpp self
+          self.each{|i| i.showna}
+        end
+        
+        def hide()
+          self.each{|i| i.hide}
+        end
+        def delete(obj)
+          obj.show
+          super
+        end
+      end
+      
+      include RC
+      attr_reader :tcitem, :owner
+      attr_accessor :index
+      
+      def initialize(*args)
+        @owner = args.shift if args[0].is_a?(Tabctrl)
+        @controls = Controls.new(self)
+        if args.empty? # For get tab data
+          #@index = args[0]
+          @tcitem = TCITEM[TCIF_TEXT | TCIF_IMAGE | TCIF_PARAM]
+        else  # For set all tab data
+          @tcitem = TCITEM.new
+          text, @image, @data = args
+          if text
+            @text = text.dup
+            @tcitem.mask |= TCIF_TEXT
+            @tcitem.pszText = @text
+            @tcitem.cchTextMax = @text.size
+          end
+          if @image
+            @tcitem.mask |= TCIF_IMAGE
+            @tcitem.iImage = @image
+          end
+          if @data
+            @tcitem.mask |= TCIF_PARAM
+            lparam = @data.__id__
+            @owner._ar_data << dt if (lparam&1)==0 && lparam>NilID
+            @tcitem.lParam = lparam
+          end
+        end
+      end
+      
+      def owner=(onr) 
+        @owner = onr
+      end
+      
+      def inspect() 
+        sprintf("<%s %#x text=%p>", self.class, __id__, @text)
+      end
+      
+      def controls()
+        @controls
+      end
+      
+      def index()
+        @owner.tabs.index(self)
+      end
+    
+#      def update(idx)
+#        @index = idx
+#        if @text
+#          @owner.SendMessage(TCM_SETITEM, idx, @tcitem)
+#        else
+#          buff = TCHAR[256]
+#          @tcitem.cchTextMax = buff.size
+#          @tcitem.pszText = buff
+#          @owner.SendMessage(TCM_GETITEM, idx, @tcitem)
+#          @text = buff.to_s #; dpp @tcitem.mask, @text
+#        end
+#        self
+#      end
+      
+      def delete()
+        @controls.show
+        @owner.delete(index)
+      end
+      
+      def <<(arg) #dpp arg
+        @controls << arg
+        arg.visible = self.visible
+#        @owner.pages[index] << arg
+        arg
+      end
+      
+      def text()
+        if @owner.alive?
+          @tcitem.clear(TCIF_TEXT, 0, 0, buff=TCHAR[256], buff.size)
+          @owner.SendMessage(TCM_GETITEM, index, @tcitem)
+          @text = buff.to_s
+        else
+          @text
+        end
+      end
+      alias caption text
+      def text=(txt)
+        str = txt.dup
+        if @owner.alive?
+          @tcitem.clear(TCIF_TEXT, 0, 0, str, str.size)
+          @owner.SendMessage(TCM_SETITEM, index, @tcitem)
+        else
+          @text = str
+        end
+      end
+      alias caption= text=
+      
+      def image()
+        if @owner.alive?
+          @tcitem.clear(TCIF_IMAGE)
+          @owner.SendMessage(TCM_GETITEM, index, @tcitem)
+          @tcitem.iImage
+        else
+          @image
+        end
+      end
+      def image=(img)
+        if @owner.alive?
+          return  @owner.SendMessage(TCM_REMOVEIMAGE, index, 0) if img.nil?
+          @tcitem.clear(TCIF_IMAGE, 0, 0, nil, 0, img)
+          @owner.SendMessage(TCM_SETITEM, index, @tcitem)
+        else
+          @image = img
+        end
+      end
+      
+      def data()
+        if @owner.alive?
+          @tcitem.clear(TCIF_PARAM)
+          @owner.SendMessage(TCM_GETITEM, index, @tcitem)
+          ObjectSpace._id2ref(@tcitem.lParam)
+        else
+          @data
+        end
+      end
+      def data=(dt)
+        if @owner.alive?
+          @owner._ar_data.delete_at(@owner._ar_data.index(self.data))
+          @tcitem.clear(TCIF_PARAM)
+          lparam = dt.__id__
+          @owner._ar_data << dt if (lparam&1)==0 && lparam>NilID
+          @tcitem.lParam = lparam
+          @owner.SendMessage(TCM_SETITEM, index, @tcitem)
+        else
+          @data = dt
+        end
+      end
+      
+      def show()
+        @controls.show
+      end
+      def hide()
+        @controls.hide
+      end
+      
+      def visible() #; dpp @owner.tabs.index(self), @owner.cursel
+        @owner.tabs.index(self) == @owner.cursel
+      end
+      
+      ##### Only for window alive #####
+      
+      def rect()
+        rc = RECT.new
+        @owner.SendMessage(TCM_GETITEMRECT, index, rc)
+        rc
+      end
+    end
+    
+    ##################### Main ##################
+    include ModCommCtrl
+    include ModParent
+    include ModAccessor
+    
+    WinStyles = {
+      :bottom            => TCS_BOTTOM,
+      :buttons           => TCS_BUTTONS,
+      :fixedwidth        => TCS_FIXEDWIDTH,
+      :focusnever        => TCS_FOCUSNEVER,
+      :focusonbuttondown => TCS_FOCUSONBUTTONDOWN,
+      :flatbuttons       => TCS_FLATBUTTONS,
+      :forceiconleft     => TCS_FORCEICONLEFT,
+      :forcelabelleft    => TCS_FORCELABELLEFT,
+      :hottrack          => TCS_HOTTRACK,
+      :ownerdrawfixed    => TCS_OWNERDRAWFIXED,
+      :multiline         => TCS_MULTILINE,
+      :multiselect       => TCS_MULTISELECT,
+      :raggedright       => TCS_RAGGEDRIGHT,
+      :right             => TCS_RIGHT,
+      :rightjustify      => TCS_RIGHTJUSTIFY,
+      :scrollopposite    => TCS_SCROLLOPPOSITE,
+      :singleline        => TCS_SINGLELINE,
+      :tabs              => TCS_TABS,
+      :tooltips          => TCS_TOOLTIPS,
+      :vertical          => TCS_VERTICAL,
+    }
+    
+    TabExStyles = {
+      :flatseparators    => TCS_EX_FLATSEPARATORS,
+      :registerdrop      => TCS_EX_REGISTERDROP,
+      :noflatseparators  => ~TCS_EX_FLATSEPARATORS
+    }
+    
+    PreDefinedEvents = {
+      :click           => [WM_NOTIFY, NM_CLICK, 'xs', NMMOUSE],
+      :dblclk          => [WM_NOTIFY, NM_DBLCLK, 'xs', NMMOUSE],
+      :focuschange     => [WM_NOTIFY, TCN_FOCUSCHANGE, 'xs', NMHDR],
+      :keydown         => [WM_NOTIFY, TCN_KEYDOWN, 'xs', NMTCKEYDOWN],
+      :rclick          => [WM_NOTIFY, NM_RCLICK, 'xs', NMMOUSE],
+      :rdblclk         => [WM_NOTIFY, NM_RDBLCLK, 'xs', NMMOUSE],
+      :releasedcapture => [WM_NOTIFY, NM_RELEASEDCAPTURE, 'xs', NMHDR],
+      :selchange       => [WM_NOTIFY, TCN_SELCHANGE, 'xs', NMHDR],
+      :selchanging     => [WM_NOTIFY, TCN_SELCHANGING, 'xs', NMHDR],
+#     :getobject       => [WM_NOTIFY, TCN_GETOBJECT, 'xs', NMOBJECTNOTIFY], # COM
+    }
+    DefaultEvents = [
+      :selchange # ???_selchange(arg)
+    ]
+    
+#    def self.sym2style(*args) _sym2style(WinStyles, args); end
+#    def self.sym2exstyle(*args) _sym2style(WinExStyles, args); end
+    
+    attr_reader :_ar_data #, :controls
+    
+    def initialize(*args)
+      class << (@_tabs = []); attr_accessor :owner end
+      @_tabs.owner = self
+      super
+      @_classname = 'SysTabControl32'
+      self.style |= TCS_HOTTRACK
+      @_acceptable_events = PreDefinedEvents.dup
+      @_ar_data = []
+    end
+    #
+    def idcmd=(id)
+      @_parent.set_msgtranslator(WM_NOTIFY) unless @_parent.get_msgtranslator(WM_NOTIFY)
+      @_parent.register_event(id, WM_NOTIFY, TCN_SELCHANGE, "__selchanged__", 'xs', NMHDR, self) #refrection
+      super
+    end
+    #
+    def create()
+      super
+      SetWindowSubclass()
+      self.imagelist = @_imagelist if @_imagelist
+      self.cursel = @_cursel if @_cursel
+      self.focused = @_focused if @_focused
+      self.tooltips = @_tooltips if @_tooltips
+      self.extendedstyle = @_extendedstyle if @_extendedstyle
+      self.padding = @_padding if @_padding
+      self.mintabwidth = @_mintabwidth if @_mintabwidth
+      self.tabs = @_tabs if @_tabs
+    end
+    #
+    def register_event(*args)
+      if !@_setsubclass && !args.last.is_a?(RWin::Window) &&
+         (args[1]==WM_COMMAND || args[1]==WM_NOTIFY)
+        args[6] = get_toplevel_win # forwarding to toplevel
+      end
+      super *args
+    end
+    
+    # Inserts a new tab in this tab control.<br>
+    # Give an array of [text, image, data] or a Tabctrl::Tab
+    def insert_tab(idx, arg) #;dpp idx, arg
+      if arg.is_a?(Array)
+        tab = Tab.new(self, *arg)
+      elsif arg.is_a?(Tab)
+        tab = arg
+        tab.owner = self
+      else
+        raise ArgumentError, "Argument must be a Tab or an Array."
+      end
+      @_tabs.insert(idx, tab)
+      SendMessage(TCM_INSERTITEM, idx, tab.tcitem) if alive?
+      tab
+    end
+    def insert(idx, arg)
+      insert_tab(idx, arg)
+    end
+    
+#    def delete_tab(idx)
+#      if alive? 
+#        tab = Tab.new(self)
+#        tab.index = idx
+#        if n=@_ar_data.index(tab.data)
+#          @_ar_data.delete_at(n)
+#        end
+#        SendMessage(TCM_DELETEITEM, idx, 0)
+#      end
+#      @_tabs.delete_at(idx)
+#    end
+    
+    # If given index, deletes a tab specified index and removes associated control from it, otherwize deletes self.
+    def delete(idx=nil)
+      if idx.nil?
+        @controls.each{|i| i.delete}
+        @_parent.controls.delete(self)
+        return
+      end
+      if alive?
+        return if idx >= self.count
+        if n=@_ar_data.index(self[idx].data)
+          @_ar_data.delete_at(n)
+        end
+        SendMessage(TCM_DELETEITEM, idx, 0)
+        self.refresh
+      end
+      @_tabs.delete_at(idx)
+    end
+    
+    # Retreives count of tabs.
+    def count() #; dpp @_tabs
+      alive? ? SendMessage(TCM_GETITEMCOUNT, 0, 0) : @_tabs.size
+    end
+    
+    # Retreives Tabctrl::Tabs
+    def tabs()
+      #r = alive? ? (0..count-1).inject([]){|r, i| r << Tab.new(self).update(i)} : @_tabs
+      @_tabs
+    end
+    # Sets multiple tabs to this tab control.
+    # Give an array of [[text, image, data], ... ] or an array of Tabctrl::Tabs.
+    def tabs=(ar)
+      ar = [ar] unless ar.is_a?(Array) #; dpp ar, @_tabs, count
+      if alive?
+        ar = ar.dup
+        self.clear
+      end
+      self[0, count] = ar unless ar.empty?
+    end
+    
+    # Clears all tabs and removes associated controls.
+    def clear()
+      alive? && SendMessage(TCM_DELETEALLITEMS, 0, 0)
+      @_tabs.clear
+    end
+    
+    # Adds control on this tab control.<br>
+    # Syntax is same as <code>Controls#<< </code>.
+    def <<(arg)
+      # Tabctl sends all message in the client area to parent, so no need to set parent.
+      @controls ||= Controls.new(self)
+      if arg.is_a?(WinControl)
+        @controls << arg
+        self._add_accessor(arg, arg.name)
+#       @_parent.controls._add_accessor(arg, arg.name)  # Which do you like?
+        arg
+      else # add new tab and page
+        self[self.count, 0] = *arg
+        self.tabs
+      end
+    end
+    
+    # Retreives specified index of tab in this tab control.
+    def [](idx)
+      @_tabs[idx]
+    end
+    
+    # []=(index, length=1, *args)
+    # Inserts and replaces tabs by specified index and length with arguments.
+    def []=(idx, *args)
+      case args.size
+      when 1
+        num = 1; args=args[0]
+      when 2
+        num, args = args
+      end
+      return if args.empty? || args==[nil]
+      anum = args.size
+      j = 0
+      item = args[0].is_a?(String) ? [args.shift] : [] #; dpp args
+      while i=args.shift
+        if i.is_a?(String) #; dpp i, j, item
+          unless item.empty?
+            insert(idx+j, item)
+            j += 1
+          end
+          item = []
+        elsif i.is_a?(Array) || i.is_a?(Tab) # ; dpp i, j, item
+          unless item.empty?
+            insert(idx+j, item)
+            j += 1
+          end
+          insert(idx+j, i)
+          j += 1
+          item = []
+          next
+        elsif i.nil?
+          next
+        end
+        item << i
+      end
+      insert(idx+j, item) if !item.empty? #; dpp @_pages,idx, num, ar_pages, anum
+      refresh if alive?
+    end
+    
+    # Retrieves the image list associated with this tab control. 
+    def imagelist() 
+      alive? ? APP.hrsc2ref(SendMessage(TCM_GETIMAGELIST, 0, 0)) || nil : @_imagelist
+    end
+    # Assigns an image list to this tab control. 
+    def imagelist=(il)
+      il = Imagelist.loadb64(il) if il.is_a?(String)
+      if alive? 
+        SendMessage(TCM_SETIMAGELIST, 0, il ? il._himagelist : 0)
+      else
+        @_imagelist = il
+      end
+    end
+    
+    # Determines the currently selected tab in this tab control. 
+    def cursel() 
+      alive? ? SendMessage(TCM_GETCURSEL, 0, 0) : @_cursel.to_i
+    end
+    # Selects a tab in a tab control.
+    def cursel=(args)
+      sel, with_msg = args
+      if alive?
+        SendMessage(TCM_SETCURSEL, sel, 0)
+        if with_msg.nil? || with_msg
+          SendMessage(WM_NOTIFY, 0, NMHDR[_hwnd, idcmd, TCN_SELCHANGE])
+        end
+      else
+        @_cursel = sel
+      end
+    end
+    
+    # Only for TCS_BUTTONS style 
+    def focused() 
+      alive? ? SendMessage(TCM_GETCURFOCUS, 0, 0) : @_focused.to_i
+    end
+    # Only for TCS_BUTTONS style 
+    def focused=(fc)
+      alive? ? SendMessage(TCM_SETCURFOCUS, fc, 0) : @_focused = fc
+    end
+    
+    # Retrieves the tooltip control associated with this tab control. 
+    def tooltips()
+      alive? ? APP.hwnd2ref(SendMessage(TCM_GETTOOLTIPS, 0, 0)) : @_tooltips
+    end
+    # Assigns a tooltip control to this tab control.
+    def tooltips=(tt)
+      alive? ? SendMessage(TCM_SETTOOLTIPS, 0, tt.hWnd) : @_tooltips = tt
+    end
+    
+    # Retrieves the extended styles that are currently in use for this tab control. 
+    def extendedstyle()
+      if alive?
+        SendMessage(TCM_GETEXTENDEDSTYLE, 0, 0)
+      else
+        @_extendedstyle.to_i
+      end
+    end
+    # Sets the extended styles that this tab control will use.
+    def extendedstyle=(xs)
+      if alive? #; dp "@%p", xs
+        SendMessage(TCM_SETEXTENDEDSTYLE, 0, xs)
+      else
+        @_extendedstyle = xs
+      end
+    end
+    
+    # Gets the minimum width of tabs.
+    def mintabwidth()
+      @_mintabwidth
+    end
+    # Sets the minimum width of tabs in this tab control. 
+    def mintabwidth=(w)
+      @_mintabwidth = w
+      SendMessage(TCM_SETMINTABWIDTH, 0, w.nil? ? -1 : w) if alive?
+    end
+    
+    # Gets the padding of this tab control. 
+    def padding()
+      @_padding
+    end
+    # Sets the padding around each tab's icon and label in this tab control. 
+    def padding=(args) # Write only
+      @_padding = args
+      if alive?
+        px, py = args.nil? ? [0, 0] : args
+        raise ArgumentError, "Argument must be pair of x, y pixcels" unless py
+        SendMessage(TCM_SETPADDING, 0, MAKELPARAM(px, py))
+      end
+    end
+    
+    # Retreives count of tabs in this tab control.
+    def count()
+      tabs.count
+    end
+    
+    # each(){|tab| ... }
+    # Performs the block for each <i>tab</i> in this as a block parameter.
+    def each()
+      tabs.each{|tb| yield tb}
+    end
+    
+    ##### Only for window alive #####
+    
+    # Determines which tab, if any, is at a specified screen position.<br>
+    # Returns a TCHITTESTINFO structure.
+    def hittest(x, y, flag=TCHT_ONITEM)
+      SendMessage(TCM_HITTEST, 0, TCHITTESTINFO[x, y, flag])
+    end
+    
+    #
+    def __move(x, y, w, h)
+      super
+      @controls.each{|i| i.__move(0, 0, self.w, self.h)} if @controls
+    end
+    
+    protected
+    def _apply_options(arg)
+      if st = WinStyles[arg]
+        self.style |= st
+        return nil
+      end
+      if es = TabExStyles[arg] #; dp "@%p, %p", arg, es
+        if es < 0
+          self.extendedstyle &= es
+        else
+          self.extendedstyle |= es
+        end
+      end
+      super
+    end
+    
+    private
+    def __selchanged__(nm)
+      return unless idcmd == nm.idFrom
+      ci = self.cursel
+      @_tabs.each_with_index{|tab, i| ci==i ? tab.controls.show : tab.controls.hide}
+    end
+    
+  end
+end