Rapid-Q Component by Rene Saarsoo Appendix A: QDIRLISTVIEW


QDIRLISTVIEW Component

QDirListView extends QListView Component. It Beheves like QFileListBox, but is a bit more "pretty"... 

QDirListView Internal Types
   TYPE ItemType            '' ie. DirListView.Item(0).Caption
     Caption AS STRING
     Checked AS INTEGER     '' If CheckBoxes is enabled and item is checked
     Handle AS INTEGER      '' Read-only
     ImageIndex AS INTEGER
     Index AS INTEGER       '' Read-only
     Selected AS INTEGER
     StateIndex AS INTEGER
   END TYPE

   TYPE ColumnType          '' ie. DirListView.Column(0).Width
     Caption AS STRING
     Width AS INTEGER
   END TYPE
QDirListView Properties
Field Type R/W Default




Align INTEGER RW alNone
BorderStyle INTEGER RW bsSingle
CheckBoxes INTEGER RW False
Color INTEGER RW
Column ARRAY of ColumnType RW
ColumnClick INTEGER RW True
ColumnsCount INTEGER RW
Cursor INTEGER RW

crDefault

Directory STRING RW Application path
Directory is the directory that contains all the files listed in the listview.
dlw_PopupMenu QPOPUPMENU RW
NB! If you need to add an PopUpMenu to the QDirListView, then add your MenuItems to dlw_PopupMenu.
Enabled INTEGER RW True
ExtensionsList QSTRINGLIST RW
ExtensionsList contains list of fileextensions. If file with extension listed in ExtensionsList is listed in ListBox, then an icon, which is specified in SmallImageList and LargeImageList is assigned to it.
First two items in ExtensionsList are reserved:
Item(0) for folders,
Item(1) for all other filetypes.
Filename STRING R
FileName is the name of the selected file in the listview, including the pathname.
Font QFONT W
GridLines INTEGER RW False
Handle INTEGER R
Height INTEGER RW 138
HideSelection INTEGER RW False
Hint STRING RW
HotTrack INTEGER RW False
Item ARRAY of ItemType RW
ItemCount INTEGER RW
ItemIndex INTEGER RW
LargeImageList QIMAGELIST RW
Same as SmallImageList but icons are in 32x32 size.
LargeImages QIMAGELIST W LargeImageList
By Default an internal ImageList is already assigned.
Left INTEGER RW 0
Mask STRING RW *.*
Mask is string that contains filter, which specifies which files are displayed in listview. By default all files are shown.
NB! At the moment only one filter is valid. i.e. "*.exe; *.com" is invalid.
MultiSelect INTEGER RW False
Parent QFORM/QPANEL/QTABCONTROL W
PopupMenu QPOPUPMENU W dlw_PopUpMenu
ReadOnly INTEGER RW True
Even if You change ReadOnly to False, you can't change actual filenames through the ListView :(
RowSelect INTEGER RW False
SelCount INTEGER RW
Selected ARRAY of INTEGER RW
ShowColumnHeaders INTEGER RW True
ShowHint INTEGER RW False
ShowRoot INTEGER RW False
If True, the ".." directory will be shown.
SmallImageList QIMAGELIST RW
SmallImageList contains list of FileIcons. If file with extension listed in ExtensionsList is listed in ListBox, then an icon, which is specified in SmallImageList and LargeImageList is assigned to it.
First two items in SmallImageList are reserved:
Item(0) for folders,
Item(1) for all other filetypes.

... Icons are in 16x16 size.
SmallImages QIMAGELIST W SmallImageList
By Default an internal ImageList is already assigned.
SortType INTEGER RW stNone
StateImages QIMAGELIST W
SubItem 2D ARRAY of STRING RW
TabOrder INTEGER RW
Tag INTEGER RW
Top INTEGER RW 0
Width INTEGER RW 400
ViewStyle INTEGER RW vsIcon
Visible INTEGER RW True


QDirListView Methods
Method Type Description Params




AddColumns SUBI Add column headers to listview STRING, Infinite
AddItems SUBI Add items to listview STRING, Infinite
AddSubItem SUB (Index%, String$) Add sub item to Index% 2
ChangeDirUp SUB Steps one directory higher in directory-tree 0
Clear SUB Clear all items in listview 0
ClearColumns SUB Clear all columns in listview 0
DelItems SUBI Delete items from listview INTEGER, Infinite
DelSubItem SUB (Index%, SubIndex%) Delete subitem from listview 2
InsertItem SUB (Index%, String$) Insert item at Index% 2
InsertSubItem SUB (Index%, SubIndex%, String$) Insert subitem 3
Refresh SUB Refreshes ListView Items 3
SwapItem SUB (Index1%, Index2%) Swap items 2

QDirListView Events
Event Type Occurs when... Params




OnClick VOID Item was clicked on 0
OnChange SUB (Index%, Change AS BYTE) Item changed (text, image, or state)
NB! Inside SUB use .InheritOnChange
2
OnColumnClick SUB (Column%) Column header was clicked 1
OnDblClick VOID Selection was double clicked on
NB! Inside SUB use .InheritOnDblClick
0
OnFileSelect VOID File was double clicked on or ENTER was pressed 0
OnKeyPress SUB (Key AS BYTE) Key was pressed 1


QDirListView Examples
' An form, that displais contents of folders and 
' has special icons for image-files.

$include "rapidq.inc"  'Important!

$include "QDirListView.inc"

' Custom iconResources for ImageFiles
$Resource ICO_JPEG_SMALL as "jpeg_small.ico"
$Resource ICO_JPEG_LARGE as "jpeg_large.ico"
$Resource ICO_GIF_SMALL as "gif_small.ico"
$Resource ICO_GIF_LARGE as "gif_large.ico"
$Resource ICO_BMP_SMALL as "bmp_small.ico"
$Resource ICO_BMP_LARGE as "bmp_large.ico"


declare sub DirListChange
declare sub DirListFileSelect(Tag as integer)

CREATE Form AS QFORM
    Width = 500
    Height = 300
    Center
    create DirList as QDirListView
      Align = alClient
      ShowRoot = True
      ViewStyle = vsList
      OnChange = DirListChange
      OnFileSelect = DirListFileSelect

      'in lowercase please!
      ExtensionsList.AddItems ("jpg", "jpe", "jpeg", "gif", "bmp")

      SmallImageList.AddIcoHandle(ICO_JPEG_SMALL)
      LargeImageList.AddIcoHandle(ICO_JPEG_LARGE)
      SmallImageList.AddIcoHandle(ICO_JPEG_SMALL)
      LargeImageList.AddIcoHandle(ICO_JPEG_LARGE)
      SmallImageList.AddIcoHandle(ICO_JPEG_SMALL)
      LargeImageList.AddIcoHandle(ICO_JPEG_LARGE)
      SmallImageList.AddIcoHandle(ICO_GIF_SMALL)
      LargeImageList.AddIcoHandle(ICO_GIF_LARGE)
      SmallImageList.AddIcoHandle(ICO_BMP_SMALL)
      LargeImageList.AddIcoHandle(ICO_BMP_LARGE)
    end create
end create

Form.ShowModal

'------------------------------------------------------
sub DirListChange
  DirList.InheritOnChange 'Important!
  Form.Caption = DirList.Directory
end sub

sub DirListFileSelect(Tag as integer) 'It Just needs one empty parameter to work
  ShowMessage("File '" + DirList.FileName + "' was selected.")
end sub


QDirListView SourceCode
'-----------------------------------------------------------------
'
'  QDirListView
'
'  An Customized QListView For Displaing Files and Folders
'
'  by Rene Saarsoo
'
'-----------------------------------------------------------------
' not well-commented and needs some work, but is fully-functional :)
' All Suggestions and Bug-Reports are welcome to  nene@hot.ee
'
' Long live the Rapid-Q!
'

' Icons for folders and unidentified files
$resource ICO_DIR_SMALL as "dir_XP_small.ico"
$resource ICO_DIR_LARGE as "dir_XP_large.ico"
$resource ICO_DEFAULTFILE_SMALL as "default_small.ico"
$resource ICO_DEFAULTFILE_LARGE as "default_large.ico"

' exclude it, if you have already declared this API-function
declare function SetFocus LIB "USER32" ALIAS "SetFocus" (Handle as long) as long

declare sub FileSelect_EventTemplate(Tag as integer)

type QDirListView extends QListView
  Directory as string property set Set_Directory
  Filename as string
  Mask as string property set Set_Mask
  ShowRoot as integer property set Set_ShowRoot
  LargeImageList as QImageList
  SmallImageList as QImageList
  ExtensionsList as QStringList
  dlw_PopupMenu as QPopupMenu
  dlw_Enter as QMenuItem
  dlw_BackSpace as QMenuItem
  OnFileSelect as event (FileSelect_EventTemplate)
  ColumnsInitialized as integer

  sub SetItemImage (Extension as string)
    QDirListView.Item(QDirListView.ItemCount - 1).ImageIndex = 1
    for i = 2 to QDirListView.ExtensionsList.ItemCount - 1
      if lcase$(Extension) = QDirListView.ExtensionsList.Item(i) then
        QDirListView.Item(QDirListView.ItemCount - 1).ImageIndex = i
        exit for
      end if
    next i
  end sub

  sub AddFileProperties (Extension as string)
    dim SizeString as string
    if FileRec.Size/1024 >= 1 then
      SizeString = str$(int(FileRec.Size / 1024)) + " KB"
    else
      SizeString = "1 KB"
    end if
    QDirListView.AddSubItem (QDirListView.ItemCount - 1, SizeString )
    QDirListView.AddSubItem (QDirListView.ItemCount - 1, ucase$(Extension) + " File")
    dim FirstSplitter as integer
    dim Month as string
    FirstSplitter = instr(FileRec.Date, "-", 0)
    Month = left$(FileRec.Date, FirstSplitter - 1)
    if len(Month) = 1 then Month = "0" + Month
    dim Day as string
    Day = left$(right$(FileRec.Date, len(FileRec.Date) - FirstSplitter), _
            instr(right$(FileRec.Date, len(FileRec.Date) - FirstSplitter), "-", 0) - 1)
    dim Year as string
    Year = right$(FileRec.Date, 4)
    QDirListView.AddSubItem (QDirListView.ItemCount - 1, Day+"."+Month+"."+Year + " " +FileRec.Time)
  end sub

  sub LoadDirectories
    dim File as string
    File = ""
    File = Dir$(QDirListView.Directory + "*.*", faDirectory)
    do
    File = Dir$
    if File = "" then
      exit do
    else
      if File = ".." and QDirListView.ShowRoot = FALSE then
      else
        if DirExists(QDirListView.Directory + File) then
          QDirListView.AddItems File
        end if
      end if
    end if
    loop
  end sub

  sub LoadFiles
    dim File as string
    dim i as integer
    File = ""
    i = 0

    do
    i = i + 1
    if i = 1 then
      File = Dir$(QDirListView.Directory + QDirListView.Mask, 0)
    else
      File = Dir$
    end if

    if File = "" then
      exit do
    else
      dim Extension as string
      Extension = ""
      dim PontPlace as integer

      QDirListView.AddItems File

      PointPlace = instr(File, ".", 0)
      if PointPlace > 0 then
        Extension = right$( File, instr(reverse$(File), ".", 0) - 1 )
        QDirListView.SetItemImage (Extension)
      else
        QDirListView.Item(QDirListView.ItemCount - 1).ImageIndex = 1
      end if
      QDirListView.AddFileProperties (Extension)
    end if
    loop
  end sub

  sub Refresh
    QDirListView.Clear
    QDirListView.LoadDirectories
    QDirListView.LoadFiles
    QDirListView.ViewStyle = QDirListView.ViewStyle + 1   ' SomeHow we manage with
    QDirListView.ViewStyle = QDirListView.ViewStyle - 1   ' changing the style
                                                          ' to make items fully wisible
                                                          ' ( without "..." at the end )
    if ColumnsInitialized = FALSE then
      QDirListView.ClearColumns
      QDirListView.AddColumns "Name", "Size", "Type", "Date Modified"
      QDirListView.Column(0).Width = 150
      QDirListView.Column(1).Width = 60
      QDirListView.Column(2).Width = 60
      QDirListView.Column(3).Width = 100
      ColumnsInitialized = TRUE
    end if
    QDirListView.Visible = false     ' Whith this we manage to repaint the control.
    QDirListView.Visible = true      ' Otherwise it would stay messed-up ( You can Try :) )
    SetFocus(QDirListView.Handle)    ' Focus was lost on hiding, so we set it back.
  end sub

  sub ChangeDirUp
    QDirListView.Directory = left$(QDirListView.Directory, _
            len(QDirListView.Directory) - _
            instr(mid$(reverse$(QDirListView.Directory), 2), "\", 0)  )
    QDirListView.refresh
  end sub

  sub ChangeDir
    if QDirListView.Item(QDirListView.ItemIndex).Caption = ".." then
      QDirListView.ChangeDirUp
    else
      QDirListView.Directory = QDirListView.FileName + "\"
      QDirListView.refresh
    end if
  end sub

  sub TryToChangeDirOrMakeEvent
    if QDirListView.FileName > "" then
      if DirExists(QDirListView.FileName) then
        QDirListView.ChangeDir
      else
        CallFunc(QDirListView.OnFileSelect, 0)
      end if
    end if
  end sub



  event OnChange
    if QDirListView.ItemIndex >= 0 then
    QDirListView.FileName = QDirListView.Directory + QDirListView.Item(QDirListView.ItemIndex).Caption
    else
    QDirListView.FileName = ""
    end if
  end event

  event OnDblClick
    QDirListView.TryToChangeDirOrMakeEvent
  end event

  event dlw_Enter.OnClick
    QDirListView.TryToChangeDirOrMakeEvent
  end event

  event dlw_BackSpace.OnClick
    QDirListView.ChangeDirUp
  end event


  property set Set_Directory (Dir as string)
    if right$(Dir, 1) = "\" then
      QDirListView.Directory = Dir
    else
      QDirListView.Directory = Dir + "\"
    end if
    QDirListView.Refresh
  end property

  property set Set_ShowRoot (RootSet as integer)
    QDirListView.ShowRoot = RootSet
    QDirListView.Refresh
  end property

  property set Set_Mask (MaskSet as string)
    QDirListView.Mask = MaskSet
    QDirListView.Refresh
  end property

  constructor
    Width = 400
    Height = 138
    Directory = left$(Command$(0), len(Command$(0)) - len(APPLICATION.ExeName) )
    Filename = ""
    Mask = "*.*"
    ShowRoot = FALSE
    ReadOnly = TRUE
    ColumnsInitialized = FALSE
    LargeImageList.Width = 32
    LargeImageList.Height = 32
    ExtensionsList.AddItems "<dir>"
    SmallImageList.AddICOHandle ICO_DIR_SMALL
    LargeImageList.AddICOHandle ICO_DIR_LARGE
    ExtensionsList.AddItems "<dir>"
    SmallImageList.AddICOHandle ICO_DEFAULTFILE_SMALL
    LargeImageList.AddICOHandle ICO_DEFAULTFILE_LARGE
    LargeImages = QDirListView.LargeImageList
    SmallImages = QDirListView.SmallImageList
    dlw_Enter.ShortCut = "Enter"
    dlw_Enter.Visible = FALSE
    dlw_BackSpace.ShortCut = "BkSp"
    dlw_BackSpace.Visible = FALSE
    dlw_PopupMenu.AddItems(QDirListView.dlw_Enter, QDirListView.dlw_BackSpace)
    PopUpMenu = QDirListView.dlw_PopUpMenu
  end constructor
end type





Hosted by uCoz