Class: WR::Listview

Inherits:

WinControl

Object
Data
RWin::Window
Window
WinControl
WR::Listview

show all

Extended by:: ModFormDesigner

Includes:: ModCommCtrl

Defined in:: lib/wrb/components/listview.rb,
lib/wrb/applications/frmdesigner/controls/Listview.rb

Overview

A window that displays a collection of items. This provides several ways to arrange and display items.
See also <a href=“docs.microsoft.com/en-us/windows/desktop/Controls/ window-controls”> Windows Control section of Microsoft Docs.</a>

Defined Under Namespace

Classes: Column, Columns, Item

Constant Summary collapse

LVITEM =

API.defstruct "
UINT mask;
int iItem;
int iSubItem;
UINT state;
UINT stateMask;
LPTSTR pszText;
int cchTextMax;
int iImage;
LPARAM lParam;
int iIndent;  
int    iGroupId;
UINT   cColumns;
UINT*  puColumns;"

LVCOLUMN =

API.defstruct "
UINT mask;
int fmt;
int cx;
LPTSTR pszText;
int cchTextMax;
int iSubItem;
int iImage;
int iOrder;"

LVFINDINFO =

API.defstruct "
UINT flags;
LPTSTR psz;
LPARAM lParam;
POINT pt;
UINT vkDirection;"

LVHITTEST =

API.defstruct "
POINT pt;
UINT flags;
int iItem;
int iSubItem"

NMLISTVIEW =

API.defstruct "
NMHDR hdr;
int iItem;
int iSubItem;
UINT uNewState;
UINT uOldState;
UINT uChanged;
POINT ptAction;
LPARAM lParam;"

NMLVCUSTOMDRAW =

API.defstruct "
NMCUSTOMDRAW nmcd;
COLORREF clrText;
COLORREF clrTextBk;
int iSubItem;
DWORD dwItemType;
COLORREF clrFace;
int iIconEffect;
int iIconPhase;
int iPartId;
int iStateId;
RECT rcText;
UINT uAlign;"

LVKEYDOWN =

API.defstruct "
NMHDR hdr;
WORD wVKey;
UINT flags;"

NMLVGETINFOTIP =

API.defstruct "
NMHDR hdr;
DWORD dwFlags;
LPTSTR pszText;
int cchTextMax;
int iItem;
int iSubItem;
LPARAM lParam;"

NMITEMACTIVATE =

API.defstruct "
NMHDR  hdr;
int    iItem;
int    iSubItem;
UINT   uNewState;
UINT   uOldState;
UINT   uChanged;
POINT  ptAction;
LPARAM lParam;
UINT   uKeyFlags;"

NMLVDISPINFO =

API.defstruct "
NMHDR  hdr;
LVITEM item;"

LVBKIMAGE =

API.defstruct "
ULONG ulFlags;
HBITMAP hbm;
LPTSTR pszImage;
UINT cchImageMax;
int xOffsetPercent;
int yOffsetPercent;"

MAXCOLUMN =

0xffff

MaxText =

WinStyles = Main ####################

{
  :iconview        => LVS_ICON,
  :reportview      => LVS_REPORT,
  :smalliconview   => LVS_SMALLICON,
  :listview        => LVS_LIST,
  :singlesel       => LVS_SINGLESEL,
  :showselalways   => LVS_SHOWSELALWAYS,
  :sortascending   => LVS_SORTASCENDING,
  :sortdescending  => LVS_SORTDESCENDING,
  :shareimagelists => LVS_SHAREIMAGELISTS,
  :nolabelwrap     => LVS_NOLABELWRAP,
  :autoarrange     => LVS_AUTOARRANGE,
  :editlabels      => LVS_EDITLABELS,
  :ownerdata       => LVS_OWNERDATA,
  :noscroll        => LVS_NOSCROLL,
  :alingtop        => LVS_ALIGNTOP,
  :alignleft       => LVS_ALIGNLEFT,
  :ownerdrawfixed  => LVS_OWNERDRAWFIXED,
  :nocolumnheader  => LVS_NOCOLUMNHEADER,
  :nosortheader    => LVS_NOSORTHEADER
}

LvsExStyles =

{
  :gridlines             => LVS_EX_GRIDLINES,
  :subitemimages         => LVS_EX_SUBITEMIMAGES,
  :checkboxes            => LVS_EX_CHECKBOXES,
  :trackselect           => LVS_EX_TRACKSELECT,
  :headerdragdrop        => LVS_EX_HEADERDRAGDROP,
  :fullrowselect         => LVS_EX_FULLROWSELECT,
  :oneclickactivate      => LVS_EX_ONECLICKACTIVATE,
  :twoclickactivate      => LVS_EX_TWOCLICKACTIVATE,
  :flatsb                => LVS_EX_FLATSB,
  :regional              => LVS_EX_REGIONAL,
  :infotip               => LVS_EX_INFOTIP,
  :underlinehot          => LVS_EX_UNDERLINEHOT,
  :underlinecold         => LVS_EX_UNDERLINECOLD,
  :multiworkareas        => LVS_EX_MULTIWORKAREAS,
  :labeltip              => LVS_EX_LABELTIP,
  :borderselect          => LVS_EX_BORDERSELECT,
  :doublebuffer          => LVS_EX_DOUBLEBUFFER,
  :hidelabels            => LVS_EX_HIDELABELS,
  :singlerow             => LVS_EX_SINGLEROW,
  :snaptoglid            => LVS_EX_SNAPTOGRID,
  :simpleselect          => LVS_EX_SIMPLESELECT,
  :justifycolumns        => LVS_EX_JUSTIFYCOLUMNS,
  :transparentbkgnd      => LVS_EX_TRANSPARENTBKGND,
  :transparentshadowtext => LVS_EX_TRANSPARENTSHADOWTEXT,
  :autoautoarrange       => LVS_EX_AUTOAUTOARRANGE,
  :headerinallivews      => LVS_EX_HEADERINALLVIEWS,
  :autocheckselect       => LVS_EX_AUTOCHECKSELECT,
  :autosizecolumns       => LVS_EX_AUTOSIZECOLUMNS,
  :columnsnappoints      => LVS_EX_COLUMNSNAPPOINTS,
  :columnoverflow        => LVS_EX_COLUMNOVERFLOW,
}

PreDefinedEvents =

{
  :click        => [WM_NOTIFY, NM_CLICK, 'xs', NMITEMACTIVATE],
  :dblclk       => [WM_NOTIFY, NM_DBLCLK, 'xs', NMITEMACTIVATE],
  :return       => [WM_NOTIFY, NM_RETURN, 'xs', NMHDR],
  :rclick       => [WM_NOTIFY, NM_RCLICK, 'xs', NMITEMACTIVATE],
  :rdblclk      => [WM_NOTIFY, NM_RDBLCLK, 'xs', NMITEMACTIVATE],
  :setfocus     => [WM_NOTIFY, NM_SETFOCUS, 'xs', NMHDR],
  :killfocus    => [WM_NOTIFY, NM_KILLFOCUS, 'xs', NMHDR],
  :customdraw   => [WM_NOTIFY, NM_CUSTOMDRAW, 'xs', NMLVCUSTOMDRAW],
  :hover        => [WM_NOTIFY, NM_HOVER, 'xs', NMHDR],
  :releasedcapture => [WM_NOTIFY, NM_RELEASEDCAPTURE, 'xs', NMHDR],
  :keydown      => [WM_NOTIFY, LVN_KEYDOWN, 'xs', LVKEYDOWN],
  :itemactivate => [WM_NOTIFY, LVN_ITEMACTIVATE, 'xs', NMITEMACTIVATE],
  :itemchanging => [WM_NOTIFY, LVN_ITEMCHANGING, 'xs', NMLISTVIEW],
  :itemchanged  => [WM_NOTIFY, LVN_ITEMCHANGED, 'xs', NMLISTVIEW],
  :insertitem   => [WM_NOTIFY, LVN_INSERTITEM, 'xs', NMLISTVIEW],
  :deleteitem   => [WM_NOTIFY, LVN_DELETEITEM, 'xs', NMLISTVIEW],
  :columnclick  => [WM_NOTIFY, LVN_COLUMNCLICK, 'xs', NMLISTVIEW],
  :begindrag    => [WM_NOTIFY, LVN_BEGINDRAG, 'xs', NMLISTVIEW],
  :beginrdrag   => [WM_NOTIFY, LVN_BEGINRDRAG, 'xs', NMLISTVIEW],
  :beginlabeledit => [WM_NOTIFY, LVN_BEGINLABELEDIT, 'xs', NMLVDISPINFO],
  :endlabeledit => [WM_NOTIFY, LVN_ENDLABELEDIT, 'xs', NMLVDISPINFO]
}

DefaultEvents =

[
  :click,       #???_click(NMITEMACTIVATE)

  :itemchanged  #???_itemchanged(NMLISTVIEW)

]

ViewModes =

{
  :iconview => LVS_ICON,
  :reportview => LVS_REPORT,
  :smalliconview => LVS_SMALLICON,
  :listview => LVS_LIST
}

Instance Attribute Summary collapse

#_items ⇒ Object readonly

Returns the value of attribute _items.

Attributes inherited from WinControl

#name

Attributes included from ModBaseWin

#_deny_font_inherit

Attributes included from ModCreateWin

#default_hfont

Instance Method Summary collapse

#<<(arg) ⇒ Object

Adds the args at last of the items.
Give a String or a Array of [String, Object] as args.
#__fd_edit_item(lv, idx, sbitm, ed) ⇒ Object
#__fd_item_loaded(item, asrc) ⇒ Object
#__fd_on_additem(lv, idx, mnu, id) ⇒ Object
#__fd_on_delete_this ⇒ Object
#__fd_on_deleteitem(lv, idx) ⇒ Object
#__fd_on_lv_rclick(lv, idx) ⇒ Object
#__fd_output_items(lns, curln, indent) ⇒ Object
#__fd_set_lvitem(lv, ilist) ⇒ Object
#__fd_update_lv(lv) ⇒ Object
#__fd_update_lv_alt(lv) ⇒ Object
#bkcolor ⇒ Object

Gets the background color of this control.
#bkcolor=(clr) ⇒ Object

Sets the background color of this control.
#checkboxes ⇒ Object

Retreives whether check boxes for items is enabled in this list-view control.
#checkboxes=(f) ⇒ Object

Sets whether check boxes for items is enabled in this list-view control.
#clear ⇒ Object

Clears all items in this list-view control.
#columns ⇒ Object

Gets the columns of a listview.
#columns=(args) ⇒ Object

Sets the collumns of header of a Listview.
#count ⇒ Object

Retreives count of items.
#create ⇒ Object
#delete(*args) ⇒ Object

delete(index=nil, number=1) Deletes items at specified index and number from this control.
If no arguments given, deletes self.
#delete_item(index) ⇒ Object

Deletes item of specified index from this control.
#each ⇒ Object

each(){|item| … } Performs the block for each item in this listview as a block parameter.
#editlabel(idx) ⇒ Object

Begins in-place editing of the specified list-view item’s text.
#ensurevisible(i, partial = true) ⇒ Object

Ensures that specified list-view item is either entirely or partially visible, scrolling the list-view control if necessary.
#fetch(idx) ⇒ Object

Gets an image-list item specified index.
#find(start = -1,, param: nil, string: nil, substring: nil, wrap: nil, nearestxy: nil, direction: nil) ⇒ Object

Searches for a list-view item with the specified characteristics.
#focused ⇒ Object

Searches the index of focused item.
#focused=(idx) ⇒ Object

Sets the specified item to focused.
#fullrowselect ⇒ Object

Retreives whether full-row selection is enabled in this list-view control.
#fullrowselect=(f) ⇒ Object

Sets whether full-row selection is enabled in this list-view control.
#get_extendedstyle(xstyle) ⇒ Object

Gets the extended styles that are currently in use for this list-view control.
#getnextitem(start, flag) ⇒ Object

Searches for a list-view item that has the specified properties and bears the specified relationship to a specified item.
#gridlines ⇒ Object

Retreives whether displays gridlines around items and subitems.
#gridlines=(f) ⇒ Object

Sets whether displays gridlines around items and subitems.
#groupheaderimagelist ⇒ Object

Gets a group-header imagelist assigned to this control.
#groupheaderimagelist=(il) ⇒ Object

Assignes a group-header imagelist to this control.
#headerdragdrop ⇒ Object

Retreives whether drag-and-drop reordering of columns is enabled in this list-view control.
#headerdragdrop=(f) ⇒ Object

Sets whether drag-and-drop reordering of columns is enabled in this list-view control.
#hittest(x, y) ⇒ Object

Determines which list-view item, if any, is at a specified position.
#imagelist ⇒ Object

Gets a normal and a small imagelist assigned to this Listview control.
#imagelist=(*args) ⇒ Object

imagelist=( smallimage) Assignes a normal and a small imagelist to this Listview control.
#initialize(*args) ⇒ Listview constructor

A new instance of Listview.
#insert(idx, *args) ⇒ Object (also: #[]=)

insert(index, length=1, *args) Inserts and replaces at the specified index and length by the items.
Give the arrays of [[text, image, indent, data], … ] as args.
#insert_item(idx, lvitem, arg) ⇒ Object

Inserts an item into the Listview.
#last ⇒ Object

Gets the last of item in this list-view control.
#multiselect ⇒ Object

Gets wheter the multiple items may be selected.
#multiselect=(f) ⇒ Object

Sets wheter the multiple items may be selected.
#normalimagelist ⇒ Object

Gets a normal imagelist assigned to this control.
#normalimagelist=(il) ⇒ Object

Assignes a normal imagelist to this control.
#selections ⇒ Object

Retreives the list of selected items in this list-view control.
#set_extendedstyle(xstyle, f = true) ⇒ Object (also: #extendedstyle=)

Sets extended styles in this list-view control.
#showselalways ⇒ Object

Gets whether selection is shown always, if any.
#showselalways=(f) ⇒ Object

The selection, if any, is always shown, even if the control does not have the focus.
#slice(idx, num = 1) ⇒ Object (also: #[])

Retreives the array of Listview::Item at the specified index and length.
#smallimagelist ⇒ Object

Gets a small imagelist assigned to this control.
#smallimagelist=(il) ⇒ Object

Assignes a small imagelist to this control.
#stateimagelist ⇒ Object

Gets a state imagelist assigned to this control.
#stateimagelist=(il) ⇒ Object

Assignes a state imagelist to this control.
#stringwidth(txt) ⇒ Object

Determines the width of a specified string using this list-view control’s current font.
#textbkcolor ⇒ Object

Gets the text background color of this list-view control.
#textbkcolor=(clr) ⇒ Object

Sets the background color of text in this list-view control.
#textcolor ⇒ Object

Gets the text color of this list-view control.
#textcolor=(clr) ⇒ Object

Sets the text color of a list-view control.
#tooltip ⇒ Object

Retrieves the tooltip control that the list-view control uses to display tooltips.
#tooltip=(tt) ⇒ Object

Sets the tooltip control that the list-view control will use to display tooltips.
#trackselect ⇒ Object

Retreives whether hot-track selection is enabled in this list-view control.
#trackselect=(f) ⇒ Object

Sets whether hot-track selection is enabled in this list-view control.
#viewmode ⇒ Object

Gets a view-mode of this list-vew control.
#viewmode=(mode) ⇒ Object

Sets a view-mode of this lis-view control.
#viewmode_to_sym ⇒ Object

Converts a integer value of view-mode to symbol.

Methods included from ModFormDesigner

extended

Methods included from ModAutoloading

included

Methods included from ModCommCtrl

included

Methods included from RC

HIWORD, INDEXTOOVERLAYMASK, LOWORD, MAKELPARAM, MAKEROP4, RGB, SPLITPARAM, _I, _T, _X

Methods inherited from WinControl

[], #__move, #enabled, #enabled=, #get_toplevel_win, #idcmd, #idcmd=, #is_subclassing, #margin, #margin=, #set_subclass

Methods inherited from Window

#position, #position=, #size=

Methods included from ModBaseWin

#CancelDefWindowProc, #accept_events, #acceptable_events, #active?, #caption, #caption=, #classname, #clientpos, #exstyle, #exstyle=, #focused?, #font, #font=, #h, #h=, #hide, #inspect, #move, #parent, #parent=, #refresh, #resize, #setorder, #show, #showna, #size=, #style, #style=, #sym2exstyle, #sym2style, #visible, #visible=, #w, #w=, #windowsize, #x, #x=, #y, #y=

Methods inherited from RWin::Window

#ClientToScreen, #DrawMenuBar, #GetWindowLong, #GetWindowRect, #PostMessage, #RegisterHotKey, #ReleaseCapture, #RemoveWindowSubclass, #ScreenToClient, #SendMessage, #SetCapture, #SetFocus, #SetMenu, #SetWindowLong, #SetWindowPos, #SetWindowSubclass, #ShowWindow, #TrackPopupMenu, #UnregisterHotKey, #_hwnd, #alive?, #caption, #caption=, #clientpos, #clientsize, #close, #cursorPos, #event_registered?, #get_msgtranslator, #h, #h=, #idcmd, #idcmd=, #method_missing, #move, new_from_handle, #parent, #parent=, #redraw, #refresh, #register_event, #registered_messages, #resize, #screenpos, #set_accelerator, #set_msgtranslator, #setorder, #unregister_event, #visible, #visible=, #w, #w=, #windowsize, #x, #x=, #y, #y=

Constructor Details

#initialize(*args) ⇒ `Listview`

Returns a new instance of Listview.

# File 'lib/wrb/components/listview.rb', line 835

def initialize(*args)
  @_extendedstyle = 0
  @_columns = Columns.new(self)
  super(*args)
  @_classname = "SysListView32"
  self.exstyle = WS_EX_CLIENTEDGE
  @_acceptable_events = PreDefinedEvents.dup
  @lvhit = LVHITTEST[POINT[*self.clientpos]]
  @_items = []
  @_ar_data = []
  @_lvitem4delete = LVITEM[LVIF_PARAM] # for delete method

end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RWin::Window

Instance Attribute Details

#_items ⇒ `Object` (readonly)

Returns the value of attribute _items.



833
834
835

# File 'lib/wrb/components/listview.rb', line 833

def _items
  @_items
end

Instance Method Details

#<<(arg) ⇒ `Object`

Adds the args at last of the items.
Give a String or a Array of [String, Object] as args.



983
984
985

# File 'lib/wrb/components/listview.rb', line 983

def <<(arg)
  self[count, 0] = arg
end

#__fd_edit_item(lv, idx, sbitm, ed) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 39

def __fd_edit_item(lv, idx, sbitm, ed)
  if lv.columns[0].text=='ItemText'
    case sbitm
    when 0
      self[idx] = ed.text.gsub(/\\t/, "\t") unless ed.text.empty?
    when 1
      self[idx].image = ed.text.empty? ? -1 : ed.text.to_i
    else
      ed.hide
    end
    __fd_update_lv(lv)
  else
    case sbitm
    when 0
      columns[idx].text = ed.text unless ed.text.empty?
    when 1
      columns[idx].width = ed.text.to_i unless ed.text.empty?
    when 2
      columns[idx].format = ed.text.to_i unless ed.text.empty?
    when 3
      columns[idx].image = ed.text.to_i unless ed.text.empty?
    else
      ed.hide
    end
    __fd_update_lv_alt(lv)
  end
end

#__fd_item_loaded(item, asrc) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 130

def __fd_item_loaded(item, asrc)
  extend ModFDItemsSrcLine unless @__fd_items_srcs
  @__fd_items_srcs << asrc
end

#__fd_on_additem(lv, idx, mnu, id) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 75

def __fd_on_additem(lv, idx, mnu, id)
  if lv.columns[0].text=='ItemText'
    self << "item#{lv.count}"
    __fd_update_lv(lv)
  else
    columns << ["column#{columns.count}", 80]
    __fd_update_lv_alt(lv)
  end
end

#__fd_on_delete_this ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 95

def __fd_on_delete_this()
  return unless lns = @_toplevelwin.__fd_src[:lines]
  __fd_delete_items_src(columns, lns)
end

#__fd_on_deleteitem(lv, idx) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 85

def __fd_on_deleteitem(lv, idx)
  return if idx < 0
  if lv.columns[0].text=='ItemText'
    self[idx].delete
  else
    columns[idx].delete
  end
  __fd_update_lv(lv)
end

#__fd_on_lv_rclick(lv, idx) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 67

def __fd_on_lv_rclick(lv, idx)
  if lv.columns[0].text=='ItemText'
    [:additem, "Add Item", :sep, :deleteitem, "Delete"]
  else
    [:additem, "Add Column", :sep, :deleteitem, "Delete"]
  end
end

#__fd_output_items(lns, curln, indent) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 100

def __fd_output_items(lns, curln, indent)
  ar = []
  pr = __fd_get_parents_str2
  if columns.count > 0
#        columns.each{|i|

#          if i.image

#            ar << "#{pr}.columns << [\"#{i.text}\", #{i.width}, #{i.format}, #{i.image}]"

#          else

#            ar << "#{pr}.columns << [\"#{i.text}\", #{i.width}, #{i.format}]"

#          end

#        }

    aa = []
    columns.each{|i|
      if i.image
        aa << "[\"#{i.text}\", #{i.width}, #{i.format}, #{i.image}]"
      else
        aa << "[\"#{i.text}\", #{i.width}, #{i.format}]"
      end
    }
    ar << "#{pr}.columns << [#{aa.join(', ')}]"
  end
  if count > 0
    each{|i|
      ss = (0..columns.count-1).inject([]){|ar, j| ar<<i[j]}.join('\t').sub(/\\t+$/, '')
      ar << pr + " << " + (i.image>=0 ? "[\"#{ss}\", #{i.image}]" : "\"#{ss}\"")
    }
  end
  __fd_set_items_srcs(lns, curln, indent, ar)
end

#__fd_set_lvitem(lv, ilist) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 12

def __fd_set_lvitem(lv, ilist)
  lv.viewmode = :reportview
  lv.imagelist = ilist
  lv.style &= ~LVS_NOCOLUMNHEADER
end

#__fd_update_lv(lv) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 18

def __fd_update_lv(lv)
  lv.columns = ['ItemText', 208], ['Img', 40]
  lv.clear
  each{|i|
    if columns.count > 0
      s = (0..columns.count-1).inject([]){|a, j| a<<i[j]}.join('\\t').sub(/(:?\\t)+$/, '')
      lv << s + "\t#{i.image>=0 ? i.image : ''}"
    else
      lv << i.text + "\t#{i.image>=0 ? i.image : ''}"
    end
  }
end

#__fd_update_lv_alt(lv) ⇒ `Object`

# File 'lib/wrb/applications/frmdesigner/controls/Listview.rb', line 31

def __fd_update_lv_alt(lv)
  lv.columns = ['ColumnText', 136], ['Width', 44, 1], ['Fmt', 40, 2], ['Img', 40]
  lv.clear
  columns.each{|col|
    lv << "#{col.text}\t#{col.width}\t#{col.format} "
  }
end

#bkcolor ⇒ `Object`

Gets the background color of this control.



1072
1073
1074

# File 'lib/wrb/components/listview.rb', line 1072

def bkcolor()
  alive? ? SendMessage(LVM_GETBKCOLOR, 0, 0) & 0xffffff : @_bkcolor
end

#bkcolor=(clr) ⇒ `Object`

Sets the background color of this control.



1076
1077
1078

# File 'lib/wrb/components/listview.rb', line 1076

def bkcolor=(clr) 
  alive? ? SendMessage(LVM_SETBKCOLOR, 0, clr) : @_bkcolor = clr
end

#checkboxes ⇒ `Object`

Retreives whether check boxes for items is enabled in this list-view control.

1178	# File 'lib/wrb/components/listview.rb', line 1178 def checkboxes() get_extendedstyle(LVS_EX_CHECKBOXES); end

#checkboxes=(f) ⇒ `Object`

Sets whether check boxes for items is enabled in this list-view control.

1180	# File 'lib/wrb/components/listview.rb', line 1180 def checkboxes=(f) set_extendedstyle(LVS_EX_CHECKBOXES, f); end

#clear ⇒ `Object`

Clears all items in this list-view control.

# File 'lib/wrb/components/listview.rb', line 1234

def clear() 
  alive? ? SendMessage(LVM_DELETEALLITEM, 0, 0) : items.clear()
  self
end

#columns ⇒ `Object`

Gets the columns of a listview. Returns a instance of Listview::Columns.



878
879
880

# File 'lib/wrb/components/listview.rb', line 878

def columns()
  @_columns
end

#columns=(args) ⇒ `Object`

Sets the collumns of header of a Listview

# File 'lib/wrb/components/listview.rb', line 883

def columns=(args)
  return @_columns.clear if args.nil? || args.empty?
  args = [args] unless args.is_a?(Array)
  @_columns[0, @_columns.size] = args
end

#count ⇒ `Object`

Retreives count of items.



977
978
979

# File 'lib/wrb/components/listview.rb', line 977

def count()
  alive? ? SendMessage(LVM_GETITEMCOUNT, 0, 0) : @_items.size
end

#create ⇒ `Object`

# File 'lib/wrb/components/listview.rb', line 849

def create()
  if @_parent.event_registered?(idcmd, WM_NOTIFY, LVN_DELETEITEM, "__deleteitem__", self)
    @_parent.register_event(self.idcmd, WM_NOTIFY, LVN_DELETEITEM, "__deleteitem__", 'xs',
                           NMLISTVIEW, self) # for internal use

  end
  super
  self.extendedstyle = @_extendedstyle if @_extendedstyle && @_extendedstyle > 0
  self.imagelist = @_imagelist if @_imagelist
  self.normalimagelist = @_normalimagelist if @_normalimagelist
  self.smallimagelist = @_smallimagelist if @_smallimagelist
  self.stateimagelist = @_stateimagelist if @_stateimagelist
  self.groupheaderimagelist = @_groupheaderimagelist if @_groupheaderimagelist
  self.bkcolor = @_bkcolor if @_bkcolor
  self.textcolor = @_textcolor if @_textcolor
  self.textbkcolor = @_textbkcolor if @_textbkcolor
  self.tooltip = @_tooltip if @_tooltip
  @_columns.__send__(:_create_substance) if @_columns
  _create_substance if @_items
  @_extendedstyle = @_normalimagelist = @_smallimagelist = @_stateimagelist =
  @_groupheaderimagelist = @_bkcolor = @_textcolor = @_tooltip = @_items = nil
end

#delete(*args) ⇒ `Object`

delete(index=nil, number=1) Deletes items at specified index and number from this control.
If no arguments given, deletes self.

# File 'lib/wrb/components/listview.rb', line 969

def delete(*args)
  return super() if args.empty?
  index, len = args
  len ||= 1
  len.times{ delete_item(index) }
end

#delete_item(index) ⇒ `Object`

Deletes item of specified index from this control.



962
963
964

# File 'lib/wrb/components/listview.rb', line 962

def delete_item(index)
  alive? ? SendMessage(LVM_DELETEITEM, index, 0) : @_items.delete_at(index)
end

#each ⇒ `Object`

each(){|item| … } Performs the block for each item in this listview as a block parameter.



989
990
991

# File 'lib/wrb/components/listview.rb', line 989

def each()
  count.times{|i| yield self.fetch(i)} if block_given?
end

#editlabel(idx) ⇒ `Object`

Begins in-place editing of the specified list-view item’s text.



1303
1304
1305

# File 'lib/wrb/components/listview.rb', line 1303

def editlabel(idx)
  SendMessage(LVM_EDITLABEL, idx.to_i, 0)
end

#ensurevisible(i, partial = true) ⇒ `Object`

Ensures that specified list-view item is either entirely or partially visible, scrolling the list-view control if necessary.



1240
1241
1242

# File 'lib/wrb/components/listview.rb', line 1240

def ensurevisible(i, partial=true)
  SendMessage(LVM_ENSUREVISIBLE, i.to_i, partial ? 1 : 0)
end

#fetch(idx) ⇒ `Object`

Gets an image-list item specified index.



945
946
947

# File 'lib/wrb/components/listview.rb', line 945

def fetch(idx)
  Listview::Item.new(self, idx)
end

#find(start = -1,, param: nil, string: nil, substring: nil, wrap: nil, nearestxy: nil, direction: nil) ⇒ `Object`

Searches for a list-view item with the specified characteristics.

# File 'lib/wrb/components/listview.rb', line 1277

def find(start=-1, param: nil, string: nil, substring: nil, wrap: nil, nearestxy: nil, direction: nil)
  lvfi = LVFINDINFO.new
  if param
    lvfi.lParam = param.to_i
    lvfi.flags |= LVFI_PARAM
  end
  if string
    lvfi.psz = string.to_s
    lvfi.flags |= LVFI_STRING
    lvfi.flags |= LVFI_WRAP if wrap
  end
  if substring
    lvfi.psz = string.to_s
    lvfi.flags |= LVFI_PARTIAL
    lvfi.flags |= LVFI_WRAP if wrap
  end
  if nearestxy
    lvfi.pt.x = nearestxy[0]
    lvfi.pt.y = nearestxy[1]
    lvfi.vkDirection = direction.to_i if direction
    lvfi.flags |= LVFI_NEARESTXY
  end
  SendMessage(LVM_FINDITEM, start, lvfi)
end

#focused ⇒ `Object`

Searches the index of focused item.



1263
1264
1265

# File 'lib/wrb/components/listview.rb', line 1263

def focused()
  getnextitem(-1, LVNI_FOCUSED)
end

#focused=(idx) ⇒ `Object`

Sets the specified item to focused.

# File 'lib/wrb/components/listview.rb', line 1268

def focused=(idx)
  if idx && idx > 0
    self[idx].focused = true
  else
    self[focused].focused = nil
  end
end

#fullrowselect ⇒ `Object`

Retreives whether full-row selection is enabled in this list-view control.

1193	# File 'lib/wrb/components/listview.rb', line 1193 def fullrowselect() get_extendedstyle(LVS_EX_FULLROWSELECT); end

#fullrowselect=(f) ⇒ `Object`

Sets whether full-row selection is enabled in this list-view control.

1195	# File 'lib/wrb/components/listview.rb', line 1195 def fullrowselect=(f) set_extendedstyle(LVS_EX_FULLROWSELECT, f); end

#get_extendedstyle(xstyle) ⇒ `Object`

Gets the extended styles that are currently in use for this list-view control.



1158
1159
1160

# File 'lib/wrb/components/listview.rb', line 1158

def get_extendedstyle(xstyle)
  alive? ? SendMessage(LVM_GETEXTENDEDLISTVIEWSTYLE, 0, xstyle)>0 || nil : @_extendedstyle
end

#getnextitem(start, flag) ⇒ `Object`

Searches for a list-view item that has the specified properties and bears the specified relationship to a specified item.



1258
1259
1260

# File 'lib/wrb/components/listview.rb', line 1258

def getnextitem(start, flag)
  SendMessage(LVM_GETNEXTITEM, start, flag)
end

#gridlines ⇒ `Object`

Retreives whether displays gridlines around items and subitems.

1173	# File 'lib/wrb/components/listview.rb', line 1173 def gridlines() get_extendedstyle(LVS_EX_GRIDLINES); end

#gridlines=(f) ⇒ `Object`

Sets whether displays gridlines around items and subitems.

1175	# File 'lib/wrb/components/listview.rb', line 1175 def gridlines=(f) set_extendedstyle(LVS_EX_GRIDLINES, f); end

#groupheaderimagelist ⇒ `Object`

Gets a group-header imagelist assigned to this control.

# File 'lib/wrb/components/listview.rb', line 1060

def groupheaderimagelist() 
  alive? ? APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_GROUPHEADER, 0)) || nil :
           @_groupheaderimagelist
end

#groupheaderimagelist=(il) ⇒ `Object`

Assignes a group-header imagelist to this control.

# File 'lib/wrb/components/listview.rb', line 1065

def groupheaderimagelist=(il)
  il = Imagelist.loadb64(il) if il.is_a?(String)
  alive? ? SendMessage(LVM_SETIMAGELIST, LVSIL_GROUPHEADER, il ? il._himagelist : 0) : 
                       @_groupheaderimagelist = il
end

#headerdragdrop ⇒ `Object`

Retreives whether drag-and-drop reordering of columns is enabled in this list-view control.

1188	# File 'lib/wrb/components/listview.rb', line 1188 def headerdragdrop() get_extendedstyle(LVS_EX_HEADERDRAGDROP); end

#headerdragdrop=(f) ⇒ `Object`

Sets whether drag-and-drop reordering of columns is enabled in this list-view control.

1190	# File 'lib/wrb/components/listview.rb', line 1190 def headerdragdrop=(f) get_extendedstyle(LVS_EX_HEADERDRAGDROP, f); end

#hittest(x, y) ⇒ `Object`

Determines which list-view item, if any, is at a specified position.

# File 'lib/wrb/components/listview.rb', line 1245

def hittest(x, y)
  @lvhit.pt.x = x
  @lvhit.pt.y = y
  SendMessage(LVM_SUBITEMHITTEST, 0, @lvhit)
  [@lvhit.iItem, @lvhit.iSubItem, @lvhit.flags]
end

#imagelist ⇒ `Object`

Gets a normal and a small imagelist assigned to this Listview control.

# File 'lib/wrb/components/listview.rb', line 996

def imagelist()
  if alive?
    [APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_NORMAL, 0))||nil,
     APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_SMALL, 0))||nil]
  else
    @_imagelist
  end
end

#imagelist=(*args) ⇒ `Object`

imagelist=( smallimage) Assignes a normal and a small imagelist to this Listview control.

# File 'lib/wrb/components/listview.rb', line 1007

def imagelist=(*args) #([normaliamge,] smallimage)

  args = args[0] if args[0].is_a?(Array)#; dpp args

  if alive?
    im1, im2 = args
    im1 = Imagelist.loadb64(im1) if im1.is_a?(String)
    im2 = Imagelist.loadb64(im2) if im2.is_a?(String)
    if im1.iconsize[0]==32
      SendMessage(LVM_SETIMAGELIST, LVSIL_NORMAL, im1 ? im1._himagelist : 0)
      SendMessage(LVM_SETIMAGELIST, LVSIL_SMALL, im2 ? im2._himagelist : 0) if im2
    else
      SendMessage(LVM_SETIMAGELIST, LVSIL_SMALL, im1 ? im1._himagelist : 0)
    end
  else
    @_imagelist = args
  end
end

#insert(idx, *args) ⇒ `Object` Also known as: []=

insert(index, length=1, *args) Inserts and replaces at the specified index and length by the items.
Give the arrays of [[text, image, indent, data], … ] as args.

# File 'lib/wrb/components/listview.rb', line 922

def insert(idx, *args)
  idx = self.count if idx == -1
  case args.size
  when 2
    len = args.shift
  when 1
    len = 1
  else #; dpp idx, len, args

    raise ArgumentError, "Illegal num of args: #{args.size + 1}"
  end
  len.times{delete_item(idx)} 
  args = args[0] #;dpp args

  if args.is_a?(String)
    insert_item(idx, LVITEM.new, args)
  elsif args[0].is_a?(String) && !args[1].is_a?(String)
    insert_item(idx, LVITEM.new, args)
  else
    args.each_with_index{|arg, i| insert_item(idx + i, LVITEM.new, arg)}
  end
end

#insert_item(idx, lvitem, arg) ⇒ `Object`

Inserts an item into the Listview. This is low level method, so shuld be used ‘[]=’ or ‘insert’.

# File 'lib/wrb/components/listview.rb', line 891

def insert_item(idx, lvitem, arg)
  if alive?
    lvitem.mask = LVIF_STD
    lvitem.iItem = idx
    lvitem.iSubItem = 0
    txt, image, indent, data = arg
    txts = txt.to_s.split("\t")
    lvitem.pszText = t = txts.shift.to_s
    lvitem.cchTextMax = t.size + 1
    lvitem.iImage = image.nil? ? -1 : image.to_i
    lparam = data.__id__
    @_ar_data << data if (lparam&1)==0 && lparam>NilID
    lvitem.lParam = lparam  #; dp "@%p", lvitem.to_a

    lvitem.iIndent = indent.to_i
    SendMessage(LVM_INSERTITEM, 0, lvitem)
    # set subitems

    lvitem.mask = LVIF_TEXT
    txts.each_with_index{|itxt, i|
      lvitem.iSubItem = i+1
      lvitem.pszText = itxt.to_s
      lvitem.cchTextMax = itxt.size
      SendMessage(LVM_SETITEMTEXT, idx, lvitem)
    }
  else
    @_items.insert(idx, arg)
  end
end

#last ⇒ `Object`

Gets the last of item in this list-view control.



1229
1230
1231

# File 'lib/wrb/components/listview.rb', line 1229

def last()
  self[count-1]
end

#multiselect ⇒ `Object`

Gets wheter the multiple items may be selected.

1151	# File 'lib/wrb/components/listview.rb', line 1151 def multiselect() (self.style & LVS_SIGLESEL) == 0; end

#multiselect=(f) ⇒ `Object`

Sets wheter the multiple items may be selected. By default, multiple items may be selected.

1153	# File 'lib/wrb/components/listview.rb', line 1153 def multiselect=(f) f ? self.style &= ~LVS_SINGLESEL : self.style \|= LVS_SINGLESEL; end

#normalimagelist ⇒ `Object`

Gets a normal imagelist assigned to this control.



1025
1026
1027

# File 'lib/wrb/components/listview.rb', line 1025

def normalimagelist() 
  alive? ? APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_NORMAL, 0)) || nil : @_nomalimagelist
end

#normalimagelist=(il) ⇒ `Object`

Assignes a normal imagelist to this control.

# File 'lib/wrb/components/listview.rb', line 1029

def normalimagelist=(il) # dp "@%p", arg

  il = Imagelist.loadb64(il) if il.is_a?(String)
  alive? ? SendMessage(LVM_SETIMAGELIST, LVSIL_NORMAL, il ? il._himagelist : 0) :
           @_normalimagelist = il
end

#selections ⇒ `Object`

Retreives the list of selected items in this list-view control.

# File 'lib/wrb/components/listview.rb', line 1215

def selections()
  ret = []
  def ret.clear()
    self.each{|j| j.selected = false}
    super
  end
  i = -1
  while (i=SendMessage(LVM_GETNEXTITEM, i, LVNI_SELECTED)) > -1
    ret << Item.new(self, i)
  end
  ret
end

#set_extendedstyle(xstyle, f = true) ⇒ `Object` Also known as: extendedstyle=

Sets extended styles in this list-view control.

# File 'lib/wrb/components/listview.rb', line 1163

def set_extendedstyle(xstyle, f=true)
  if alive?
    SendMessage(LVM_SETEXTENDEDLISTVIEWSTYLE,xstyle,f ? xstyle : 0)
  else
    f ?  @_extendedstyle |= xstyle : @_extendedstyle &= ~xstyle
  end
end

#showselalways ⇒ `Object`

Gets whether selection is shown always, if any.

1144	# File 'lib/wrb/components/listview.rb', line 1144 def showselalways() (self.style & LVS_SHOWSELALWAYS) > 0; end

#showselalways=(f) ⇒ `Object`

The selection, if any, is always shown, even if the control does not have the focus.



1146
1147
1148

# File 'lib/wrb/components/listview.rb', line 1146

def showselalways=(f) f ? 
  self.style |= LVS_SHOWSELALWAYS : self.style &= ~LVS_SHOWSELALWAYS
end

#slice(idx, num = 1) ⇒ `Object` Also known as: []

Retreives the array of Listview::Item at the specified index and length.

# File 'lib/wrb/components/listview.rb', line 950

def slice(idx, num=1)
  if num == 1
    fetch(idx)
  else
    ret = []
    num.times{|i| ret << fetch(idx + i)}
    ret
  end
end

#smallimagelist ⇒ `Object`

Gets a small imagelist assigned to this control.

# File 'lib/wrb/components/listview.rb', line 1036

def smallimagelist() 
  alive? ? APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_SMALL, 0)) || nil :
           @_smallimagelist
end

#smallimagelist=(il) ⇒ `Object`

Assignes a small imagelist to this control.

# File 'lib/wrb/components/listview.rb', line 1041

def smallimagelist=(il) # dp "@%p", arg

  il = Imagelist.loadb64(il) if il.is_a?(String)
  alive? ? SendMessage(LVM_SETIMAGELIST, LVSIL_SMALL, il ? il._himagelist : 0) :
           @_smallimagelist = il
end

#stateimagelist ⇒ `Object`

Gets a state imagelist assigned to this control.

# File 'lib/wrb/components/listview.rb', line 1048

def stateimagelist() 
  alive? ? APP.hrsc2ref(SendMessage(LVM_GETIMAGELIST, LVSIL_STSATE, 0)) || nil : 
           @_stateimagelist
end

#stateimagelist=(il) ⇒ `Object`

Assignes a state imagelist to this control.

# File 'lib/wrb/components/listview.rb', line 1053

def stateimagelist=(il) # dp "@%p", arg

  il = Imagelist.loadb64(il) if il.is_a?(String)
  alive? ? SendMessage(LVM_SETIMAGELIST, LVSIL_STATE, il ? il._himagelist : 0) : 
           @_stateimagelist = il
end

#stringwidth(txt) ⇒ `Object`

Determines the width of a specified string using this list-view control’s current font.



1253
1254
1255

# File 'lib/wrb/components/listview.rb', line 1253

def stringwidth(txt)
  SendMessage(LVM_GETSTRINGWIDTH, 0, txt)
end

#textbkcolor ⇒ `Object`

Gets the text background color of this list-view control.



1124
1125
1126

# File 'lib/wrb/components/listview.rb', line 1124

def textbkcolor()
  alive? ? SendMessage(LVM_GETTEXTBKCOLOR, 0, 0) & 0xffffff : @_textbkcolor
end

#textbkcolor=(clr) ⇒ `Object`

Sets the background color of text in this list-view control.



1128
1129
1130

# File 'lib/wrb/components/listview.rb', line 1128

def textbkcolor=(clr)
  alive? ? SendMessage(LVM_SETTEXTBKCOLOR, 0, clr) : @_textbkcolor = clr
end

#textcolor ⇒ `Object`

Gets the text color of this list-view control.



1115
1116
1117

# File 'lib/wrb/components/listview.rb', line 1115

def textcolor()
  alive? ? SendMessage(LVM_GETTEXTCOLOR, 0, 0) & 0xffffff : @_textcolor
end

#textcolor=(clr) ⇒ `Object`

Sets the text color of a list-view control.



1119
1120
1121

# File 'lib/wrb/components/listview.rb', line 1119

def textcolor=(clr)
  alive? ? SendMessage(LVM_SETTEXTCOLOR, 0, clr) : @_textcolor = clr
end

Retrieves the tooltip control that the list-view control uses to display tooltips.



1133
1134
1135

# File 'lib/wrb/components/listview.rb', line 1133

def tooltip()
  alive? ? APP.hwnd2ref(SendMessage(LVM_GETTOOLTIPS, 0, 0)) || nil : @_tooltip
end

#tooltip=(tt) ⇒ `Object`

Sets the tooltip control that the list-view control will use to display tooltips.



1137
1138
1139

# File 'lib/wrb/components/listview.rb', line 1137

def tooltip=(tt)
  alive? ? SendMessage(LVM_SETTOOLTIPS, 0, tt ? tt.hWnd : 0) : @_tooltip = tt
end

#trackselect ⇒ `Object`

Retreives whether hot-track selection is enabled in this list-view control.

1183	# File 'lib/wrb/components/listview.rb', line 1183 def trackselect() get_extendedstyle(LVS_EX_TRACKSELECT); end

#trackselect=(f) ⇒ `Object`

Sets whether hot-track selection is enabled in this list-view control.

1185	# File 'lib/wrb/components/listview.rb', line 1185 def trackselect=(f) set_extendedstyle(LVS_EX_TRACKSELECT, f); end

#viewmode ⇒ `Object`

Gets a view-mode of this list-vew control.

1204	# File 'lib/wrb/components/listview.rb', line 1204 def viewmode() self.style & LVS_TYPEMASK; end

#viewmode=(mode) ⇒ `Object`

Sets a view-mode of this lis-view control. You can use following symbols instead of integer value.
:reportview, :iconview, :smalliconview, :listview

# File 'lib/wrb/components/listview.rb', line 1209

def viewmode=(mode)
  mode = ViewModes[mode] if mode.is_a?(Symbol)
  self.style = (self.style & ~LVS_TYPEMASK) | mode
end

#viewmode_to_sym ⇒ `Object`

Converts a integer value of view-mode to symbol.

1206	# File 'lib/wrb/components/listview.rb', line 1206 def viewmode_to_sym() ViewModes.key(self.style & LVS_TYPEMASK); end

Class: WR::Listview

Overview

Defined Under Namespace

Constant Summary collapse

Constants included from ModCommCtrl

Constants included from RC

Constants inherited from WinControl

Constants included from ModBaseWin

Instance Attribute Summary collapse

Attributes inherited from WinControl

Attributes included from ModBaseWin

Attributes included from ModCreateWin

Instance Method Summary collapse

Methods included from ModFormDesigner

Methods included from ModAutoloading

Methods included from ModCommCtrl

Methods included from RC

Methods inherited from WinControl

Methods inherited from Window

Methods included from ModBaseWin

Methods inherited from RWin::Window

Constructor Details

#initialize(*args) ⇒ Listview

Dynamic Method Handling

Instance Attribute Details

#_items ⇒ Object (readonly)

Instance Method Details

#<<(arg) ⇒ Object

#__fd_edit_item(lv, idx, sbitm, ed) ⇒ Object

#__fd_item_loaded(item, asrc) ⇒ Object

#__fd_on_additem(lv, idx, mnu, id) ⇒ Object

#__fd_on_delete_this ⇒ Object

#__fd_on_deleteitem(lv, idx) ⇒ Object

#__fd_on_lv_rclick(lv, idx) ⇒ Object

#__fd_output_items(lns, curln, indent) ⇒ Object

#__fd_set_lvitem(lv, ilist) ⇒ Object

#__fd_update_lv(lv) ⇒ Object

#__fd_update_lv_alt(lv) ⇒ Object

#bkcolor ⇒ Object

#bkcolor=(clr) ⇒ Object

#checkboxes ⇒ Object

#checkboxes=(f) ⇒ Object

#clear ⇒ Object

#columns ⇒ Object

#columns=(args) ⇒ Object

#count ⇒ Object

#create ⇒ Object

#delete(*args) ⇒ Object

#delete_item(index) ⇒ Object

#each ⇒ Object

#editlabel(idx) ⇒ Object

#ensurevisible(i, partial = true) ⇒ Object

#fetch(idx) ⇒ Object

#find(start = -1,, param: nil, string: nil, substring: nil, wrap: nil, nearestxy: nil, direction: nil) ⇒ Object

#focused ⇒ Object

#focused=(idx) ⇒ Object

#fullrowselect ⇒ Object

#fullrowselect=(f) ⇒ Object

#get_extendedstyle(xstyle) ⇒ Object

#getnextitem(start, flag) ⇒ Object

#gridlines ⇒ Object

#gridlines=(f) ⇒ Object

#groupheaderimagelist ⇒ Object

#groupheaderimagelist=(il) ⇒ Object

#headerdragdrop ⇒ Object

#headerdragdrop=(f) ⇒ Object

#hittest(x, y) ⇒ Object

#imagelist ⇒ Object

#imagelist=(*args) ⇒ Object

#insert(idx, *args) ⇒ Object Also known as: []=

#insert_item(idx, lvitem, arg) ⇒ Object

#last ⇒ Object

#multiselect ⇒ Object

#multiselect=(f) ⇒ Object

#normalimagelist ⇒ Object

#normalimagelist=(il) ⇒ Object

#selections ⇒ Object

#set_extendedstyle(xstyle, f = true) ⇒ Object Also known as: extendedstyle=

#showselalways ⇒ Object

#showselalways=(f) ⇒ Object