Class: WR::Header

Inherits:

WinControl

Object
Data
RWin::Window
Window
WinControl
WR::Header

show all

Includes:: ModCommCtrl, RC

Defined in:: lib/wrb/components/header.rb

Overview

A window that is usually positioned above columns of text or numbers like a Listview’s one.
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: Item

Constant Summary collapse

HDTEXTFILTER =

API.defstruct "
LPSTR pszText;
INT cchTextMax;"

HDITEM =

API.defstruct "
UINT mask;
int cxy;
LPTSTR pszText;
HBITMAP hbm;
int cchTextMax;
int fmt;
LPARAM lParam;
int iImage;
int iOrder;
UINT type;
void* pvFilter;"

HD_LAYOUT =

API.defstruct  "
RECT *prc;
WINDOWPOS *pwpos;"

HD_HITTESTINFO =

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

NMHEADER =

API.defstruct "
NMHDR hdr;
int iItem;
int iButton;
HDITEM *pitem;"

HeaderFormats =

{
  :left => HDF_LEFT,
  :right => HDF_RIGHT,
  :center => HDF_CENTER,
  :justifymask => HDF_JUSTIFYMASK,
  :rtlreading => HDF_RTLREADING,
  :ownerdraw => HDF_OWNERDRAW,
  :string => HDF_STRING,
  :bitmap => HDF_BITMAP,
  :bitmap_on_right => HDF_BITMAP_ON_RIGHT,
  :image => HDF_IMAGE,
  :sortup => HDF_SORTUP,
  :sortdown => HDF_SORTDOWN,
  :checkbox => HDF_CHECKBOX,
  :checked => HDF_CHECKED,
  :fixedwidth => HDF_FIXEDWIDTH,
  :splitbutton => HDF_SPLITBUTTON
}

WinStyles =

{
  :horz => HDS_HORZ,
  :buttons => HDS_BUTTONS,
  :hottrack => HDS_HOTTRACK,
  :hidden => HDS_HIDDEN,
  :dragdrop => HDS_DRAGDROP,
  :fulldrag => HDS_FULLDRAG,
  :filterbar => HDS_FILTERBAR,
  :flat => HDS_FLAT,
  :checkboxes => HDS_CHECKBOXES,
  :nosizing => HDS_NOSIZING,
  :overflow => HDS_OVERFLOW
}

PreDefinedEvents =

{
  :begindrag => [WM_NOTIFY, HDN_BEGINDRAG, 'xs', NMHEADER],
  :enddrag => [WM_NOTIFY, HDN_ENDDRAG, 'xs', NMHEADER],
  :filterchange => [WM_NOTIFY, HDN_FILTERCHANGE, 'xs', NMHEADER],
  :filterbtnclick => [WM_NOTIFY, HDN_FILTERBTNCLICK, 'xs', NMHEADER],
  :itemchanging => [WM_NOTIFY, HDN_ITEMCHANGING, 'xs', NMHEADER],
  :itemchanged => [WM_NOTIFY, HDN_ITEMCHANGED, 'xs', NMHEADER],
  :itemclick => [WM_NOTIFY, HDN_ITEMCLICK, 'xs', NMHEADER],
  :itemdblclick => [WM_NOTIFY, HDN_ITEMDBLCLICK, 'xs', NMHEADER],
  :dividerdblclick => [WM_NOTIFY, HDN_DIVIDERDBLCLICK, 'xs', NMHEADER],
  :begintrack => [WM_NOTIFY, HDN_BEGINTRACK, 'xs', NMHEADER],
  :endtrack => [WM_NOTIFY, HDN_ENDTRACK, 'xs', NMHEADER],
  :track => [WM_NOTIFY, HDN_TRACK, 'xs', NMHEADER],
  :getdispinfo => [WM_NOTIFY, HDN_GETDISPINFO, 'xs', NMHEADER]
}

DefaultEvents = ( Nothing )

[]

Instance Attribute Summary collapse

#_ar_data ⇒ Object readonly

Main ###########################.

Attributes inherited from WinControl

#name

Attributes included from ModBaseWin

#_deny_font_inherit

Attributes included from ModCreateWin

#default_hfont

Instance Method Summary collapse

#create ⇒ Object
#data ⇒ Object

Not implemented yet.
#data=(arg) ⇒ Object

Not implemented yet.
#delete_item(index) ⇒ Object

Deletes an item at specified index from this heder control.
#fetch(index) ⇒ Object

Retreives a Header::Item at specified index.
#imagelist ⇒ Object

Gets an imagelist assigned to this Header control.
#imagelist=(il) ⇒ Object

Assignes an imagelist to this Header control.
#initialize(*args) ⇒ Header constructor

A new instance of Header.
#insert_item(index, text, width = nil, image = nil, *formats) ⇒ Object

Inserts item at specified args.
‘formats’ can be both an integer or some symbols.

Methods included from RC

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

Methods included from ModCommCtrl

included

Methods inherited from WinControl

[], #__move, #delete, #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 included from ModAutoloading

included

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) ⇒ `Header`

Returns a new instance of Header.

# File 'lib/wrb/components/header.rb', line 378

def initialize(*args)
  super
  @_classname = "SysHeader32"
  @_acceptable_events = PreDefinedEvents.dup
  @_ar_data = []
  @_items = []
end

Dynamic Method Handling

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

Instance Attribute Details

#_ar_data ⇒ `Object` (readonly)

Main ###########################



377
378
379

# File 'lib/wrb/components/header.rb', line 377

def _ar_data
  @_ar_data
end

Instance Method Details

#create ⇒ `Object`

# File 'lib/wrb/components/header.rb', line 387

def create()
  super
  @_items.each_with_index{|val, idx| insert_item(idx, *val)}
  self.imagelist = @_imagelist if @_imagelist
  @_items = @_imagelist = nil
end

#data ⇒ `Object`

Not implemented yet



437
438

# File 'lib/wrb/components/header.rb', line 437

def data()
end

#data=(arg) ⇒ `Object`

Not implemented yet



440
441

# File 'lib/wrb/components/header.rb', line 440

def data=(arg)
end

#delete_item(index) ⇒ `Object`

Deletes an item at specified index from this heder control.



413
414
415

# File 'lib/wrb/components/header.rb', line 413

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

#fetch(index) ⇒ `Object`

Retreives a Header::Item at specified index.



418
419
420

# File 'lib/wrb/components/header.rb', line 418

def fetch(index)
  alive? ? Item.new(self, index) : @_items.fetch(index)
end

#imagelist ⇒ `Object`

Gets an imagelist assigned to this Header control.



432
433
434

# File 'lib/wrb/components/header.rb', line 432

def imagelist()
  alive? ? APP.hrsc2ref(SendMessage(HDM_GETIMAGELIST, 0, 0)) : @_imagelist
end

#imagelist=(il) ⇒ `Object`

Assignes an imagelist to this Header control.

# File 'lib/wrb/components/header.rb', line 423

def imagelist=(il)
  if alive?
    SendMessage(HDM_SETIMAGELIST, 0, il._himagelist)
  else
    @_imagelist = il
  end
end

#insert_item(index, text, width = nil, image = nil, *formats) ⇒ `Object`

Inserts item at specified args.
‘formats’ can be both an integer or some symbols.

# File 'lib/wrb/components/header.rb', line 396

def insert_item(index, text, width=nil, image=nil, *formats)
  if alive?
    fmt = formats[0].is_a?(Integer) ? formats[0] : 0
    while formats.last.is_a?(Symbol) #; dpp args.last
      fmt = fmt | HeaderFormats[formats.pop]
    end
    hditem = HDITEM[HDI_TEXT | HDI_FORMAT | HDI_WIDTH | HDI_IMAGE*(image ? 1 : 0),
             width.to_i, text.to_s, 0, text.size, fmt]
    hditem.iImage = image.to_i
    SendMessage(HDM_INSERTITEM, index.to_i, hditem)
  else
    @_items[index] = text, width, image, *formats
  end
end

Class: WR::Header

Overview

Defined Under Namespace

Constant Summary collapse

Constants included from RC

Constants included from ModCommCtrl

Constants inherited from WinControl

Constants included from ModBaseWin