title: Phi::ListView
author: YOSHIDA Kazuhiro
mailto: moriq@moriq.com

1. Phi::ListView

項目のリストの表示

エクスプローラでお馴染みのコントロールである。 %c:Phi::ListView% の項目は，列形式で表示したりアイコンを付けて表示したりできる。

1.1. super class

Phi::WinControl#

1.1. properties

: view_style : Fixnum
  項目の表示方法

  : VS_ICON
    各項目を下にラベルの付いたフルサイズのアイコンとして表示する。ユーザーは任意の位置に項目をドラッグできる
  : VS_SMALL_ICON
    各項目を右側にラベルの付いた小さいアイコンとして表示する。ユーザーは任意の位置に項目をドラッグできる
  : VS_LIST
    各項目を右側にラベルの付いた小さいアイコンとして表示する。項目は列形式で並び，任意の位置にドラッグすることはできない
  : VS_REPORT
    各項目に 1 行を割り当て，列形式で情報を配置する。一番左の列に小さいアイコンとラベルを表示し，それに続く列に下位項目を入れる。 #show_column_headers が %c:false% でなければ各列にはヘッダーが付く

: icon_options : IconOptions
  アイコンの配列方法

  #view_style は %c:VS_ICON% または %c:VS_SMALL_ICONS% でなければ効果はない。

: items : Phi::ListItems
  項目のリスト

1. Phi::ListItems

項目のリスト

1.1. super class

%c:Object%

1.1. properties

: self[n] : ListItem
  %v:n% 番目のリスト項目

: count : Fixnum
  項目数

1.1. methods

1. Phi::ListItem

項目

1.1. properties

: caption : String
  リストの項目のラベルになるテキスト

  %c:caption% は，リスト項目に名前を付けることができる。 %c:caption% は Phi::ListView#view_style に基づく関連付けられているイメージとともに表示される。 Phi::ListView#read_only が %c:false% の場合，ユーザーは %c:caption% を編集できる。

: image_index : Fixnum
  リスト項目のアイコンとして表示するイメージのインデックス

  %c:image_index% を設定すると，リスト項目を， Phi::ListView#large_images または Phi::ListView#small_images のイメージのいずれかに関連付けることができる。 Phi::ListView#view_style が %c:VS_ICON% ならば， %c:image_index% は Phi::ListView#large_images のイメージのインデックスになる。 Phi::ListView#view_style が %c:VS_SMALL_ICON% ， %c:VS_LIST% または %c:VS_REPORT% ならば， %c:image_index% は Phi::ListView#small_images のイメージのインデックスになる。

: state_index : Fixnum
  項目に対して表示するイメージのインデックス

  %c:state_index% を設定すると，リスト項目を， Phi::ListView#state_images のイメージのいずれかに関連付けることができる。 %c:state_index% を変更すると，項目の状態が変更されたときに別のイメージを表示できる。

  状態イメージは通常のリスト項目の左に表示される。

: sub_items : Phi::Strings
  リスト項目の下位項目として表示される文字列

  %c:sub_items% は， Phi::ListView#view_style が %c:VS_REPORT% のときに，項目の右側の列に表示される文字列を追加することができる。 %c:sub_items% を実装する Strings# オブジェクトは %c:self% の作成時に作成される。下位項目を追加または削除するには， %c:sub_items% のメソッドを使う。

  : 注意
    Phi::ListView#view_style が %c:VS_REPORT% に設定されている場合のみ下位項目が表示される。

1. IconOptions

どのようにアイコンを配置するか

1.1. super class

%c:Object%

1.1. properties

: arrangement : Fixnum
  項目をどこに合わせるか

  : IA_TOP
    項目を，リストビューコントロールの上端の行に左から右へ並べる
  : IA_LEFT
    項目を，リストビューコントロールの左端の列に上から下へ並べる

: auto_arrange : Boolean
  リスト項目の追加，削除，移動を行うときに，アイコンが自動的に整列されるかどうか

  : true の場合
    アイコンは自動的に整列される。
  : false の場合
    Phi::ListView#arrange が呼び出されるまでアイコンは整列されない。

: wrap_text : Boolean
  アイコンのキャプションをすべて 1 行で表示するかラップするか

  %c:true% に設定すると，アイコンのキャプションがアイコンの幅を超える場合に，次の行以降に折り返されて表示される。
