 | | Wide Studio Object Reference
| |
クラスの型
WSClist
メソッド関数仕様
setLabelHeight 関数の説明
- 書式
- void setLabelHeight(WSCushort* height)
- 機能
- 表示項目の縦幅を指定します。
- 処理
-
- 引数
-
(in)WSCushort height | 項目の縦幅 |
- 返値
- なし。
- 注意
- 一度、updateList()
関数を呼び出して、リストの表示を更新してください。
- サンプル
-
newlist_000->setLabelHeight(25);
newlist_000->updateList();
delAll 関数の説明
- 書式
- void delAll()
- 機能
- 表示項目を全て削除します。
- 処理
-
- 引数
- なし。
- 返値
- なし。
- 注意
- 削除した後、項目の追加等が終ったら、updateList() 関数で
一度、表示を更新してください。
- サンプル
-
newlist_000->delAll();
newlist_000->addItem("item1");
newlist_000->addItem("item2");
:
newlist_000->updateList();
getLabel 関数の説明
- 書式
- WSCbase* getLabel(long pos)
- 機能
- 実際に表示項目を表示している、内部のオブジェクトを
取得します。
- 処理
- 項目の表示を行っているオブジェクトを返します。
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1) |
- 返値
- 項目を表示しているオブジェクト
- 注意
- 指定する位置は、先頭が0で、N個ある場合は最後は、N-1 を
指定します。また、-1 を指定すると N-1 を指定したものと
みなされます。
- サンプル
-
newlist_000->addItem("item1");
WSCbase* label = newlist_000->getLabel(-1); //末尾の項目のラベルを取得
label->setProperty(WSNforeColor,"#ff0000"); //文字列の表示色を赤に設定
getNum 関数の説明
- 書式
- long getNum()
- 機能
- 表示項目の数を取得します。
- 処理
-
- 引数
- なし。
- 返値
- なし。
- 注意
- なし。
- サンプル
-
long i;
long num = newlist_000->getNum();
WSCstring item;
for(i=0; i<num; i++){
item = newlist_000->getItem(i);
printf("pos=%d item=%s\n",i,(char*)item);
}
getItem 関数の説明
- 書式
- WSCstring getItem(long pos)
- 機能
- 指定した位置の項目の文字列を取得します。
- 処理
-
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1) |
- 返値
- 表示文字列
- 注意
- 返される文字列を char* で受け止めてはいけません。
必ず、WSCstring クラスで受け、
それから char* を取り出してください。
- サンプル
- getNum()を参照してください。
addItem 関数の説明
- 書式
- void addItem(char* item,long pos = -1)
- 機能
- 指定した位置に項目の文字列を挿入します。
- 処理
- 指定した位置(先頭=1〜 N-1、-1=末尾)に与えられた文字列を
表示項目に加えます。
- 引数
-
(in)char* | 表示文字列 |
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
- 位置を指定しない場合、-1、すなわち、項目をリストの末尾に
追加するものとみなします。
なお、表示項目を変更した場合は、最後に一度、updateList()
関数を呼び出して、リストの表示を更新してください。
- サンプル
-
newlist_000->delAll();
newlist_000->addItem("item0"); //末尾に追加
newlist_000->addItem("item1"); //末尾に追加
newlist_000->addItem("item2",0); //先頭に追加
newlist_000->addItem("item3",1); //先頭の次に追加
newlist_000->updateList();
結果:
item2
item3
item0
item1
replaceItem 関数の説明
- 書式
- void replaceItem(char* item,long pos)
- 機能
- 指定した位置に項目の文字列を置き換えます。
- 処理
- 指定した位置(先頭=1〜 N-1、-1=末尾)を与えられた文字列で
置き換えます。
- 引数
-
(in)char* | 表示文字列 |
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
- 指定する位置は、先頭が0で、N個ある場合は最後は、N-1 を
指定します。また、-1 を指定すると N-1 を指定したものと
みなされます。
なお、表示項目を変更した場合は、最後に一度、updateList()
関数を呼び出して、リストの表示を更新してください。
- サンプル
-
newlist_000->delAll();
newlist_000->addItem("item1"); //末尾に追加
newlist_000->addItem("item2"); //末尾に追加
newlist_000->replaceItem("item0",-1); //末尾のものを置換
newlist_000->updateList();
結果:
item1
item2
delPos 関数の説明
- 書式
- void delPos(long pos);
- 機能
- 指定した位置の項目を削除します。
- 処理
- 指定した位置(先頭=1〜 N-1、-1=末尾)を表示項目リストから
削除します。
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
- 指定する位置は、先頭が0で、N個ある場合は最後は、N-1 を
指定します。また、-1 を指定すると N-1 を指定したものと
みなされます。
- サンプル
-
newlist_000->delAll(); //クリア
newlist_000->addItem("item0"); //末尾に追加
newlist_000->addItem("item1"); //末尾に追加
newlist_000->addItem("item2"); //末尾に追加
newlist_000->delPos(1);
newlist_000->updateList();
結果
item0
item2
getSelectedPos 関数の説明
- 書式
- long getSelectedPos();
- 機能
- 選択された項目の位置を取得します。
- 処理
- マウスにより選択状態になった項目の位置を取得します。
- 引数
- なし。
- 返値
- 項目位置。(先頭=0 〜 N-1)
- 注意
-
- サンプル
-
long pos = newlist_000->getSelectedPos();
printf("selected item = %d\n",pos);
setSelectPos 関数の説明
- 書式
- void setSelectPos(long pos);
- 機能
- 指定した位置の項目を選択状態にします。
- 処理
- 指定した位置(先頭=1〜 N-1、-1=末尾)を選択状態にします。
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
-
- サンプル
-
newlist_000->delAll();
newlist_000->addItem("item0");
newlist_000->addItem("item1");
newlist_000->addItem("item2");
newlist_000->setSelectedPos(1); // item1 を選択状態に設定
getSelectedItem 関数の説明
- 書式
- WSCstring getSelectedItem();
- 機能
- 選択された項目の文字列を返します。
- 処理
-
- 引数
- なし。
- 返値
- 選択状態になっている項目の文字列を返します。
- 注意
- 返された文字列は、開放してはいけません。また、
複数選択されている場合は、最後に選択されたものが返されます。
選択されたもののすべてを取得したい場合は、getSelectedLabels()
関数を使用してください。
- サンプル
-
WSCstring item;
item = newlist_000->setSelectedItem();
printf("selected item = %s",(char*)item);
setTopPos 関数の説明
- 書式
- void setTopPos(long pos);
- 機能
- 指定した位置の項目がリストの一番上に表示されるように
表示位置をスクロールします。
- 処理
-
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
-
- サンプル
-
newlist_000->setTopPos(0); //先頭 1 行目を再上段に来るようスクロール
newlist_000->setTopPos(10); //先頭 11 行目を再上段に来るようスクロール
setBottomPos 関数の説明
- 書式
- void setBottomPos(long pos);
- 機能
- 指定した位置の項目がリストの一番下に表示されるように
表示位置をスクロールします。
- 処理
-
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
- 返値
- なし。
- 注意
-
- サンプル
-
newlist_000->setBottomPos(100); //先頭 101 行目を再下段に来るようスクロール
updateList 関数の説明
- 書式
- void updateList();
- 機能
- 表示項目に加えられた変更を表示に反映します。
- 処理
-
- 引数
- なし。
- 返値
- なし。
- 注意
- なし。
- サンプル
- addItem() を参照してください。
setLabelClass 関数の説明
- 書式
- void setLabelClass(char* class_name);
- 機能
- 表示項目に使用されるオブジェクトのクラスを指定します。
- 処理
- 指定されたクラスで、表示項目を表示します。
デフォルトは、 WSCvlabel クラスです。
- 引数
-
(in)char* class_name | クラス名称を指定 |
- 返値
- なし。
- 注意
- クラスを指定する場合、プロパティ WSNlabelString を
持ったものを指定してください。リストクラスは、
表示すべき文字列をWSNlabelString プロパティに格納します。
- サンプル
-
newlist_000->setLabelClass("WSCvklabel"); //クラス名を設定
getSelectItemChanged 関数の説明
- 書式
- WSCbool getSelectItemChanged()
- 機能
- 項目の選択状態が変化したかどうかを返します。
- 処理
- マウス等により選択状態でない項目が選択状態になったりして、
項目の選択状態が変化した場合、返り値が True となります。
- 引数
- なし。
- 返値
- True = 変化あり、False = 変化なし。
- 注意
- getSelectItemChanged() 関数を呼び出すに先だって、
setSelectItemChanged() 関数で、フラグを False にしておく
必要があります。setSelectItemChanged() でフラグを落した
時点から、選択状態に変化があった場合、
getSelectedItemChanged() の返り値が True となります。
- サンプル
-
WSCbool changed = newlist_000->getSelectItemChanged();
if (changed == False){
//選択状態に変化なし。
}else{
//選択状態に変化あり。
}
setSelectItemChanged 関数の説明
- 書式
- void setSelectItemChanged(WSCbool fl);
- 機能
- 選択状態フラグに値をセットします。
- 処理
-
- 引数
-
(in)WSCbool fl | True = 選択状態変更あり、False = なし |
- 返値
- なし。
- 注意
- この関数は、状態フラグの値を設定するだけです。
getSelectItemChanged() 関数を呼び出すのに使用します。
- サンプル
-
newlist_000->setSelectItemChanged(True); //選択状態変更フラグをセットします。
getLabels 関数の説明
- 書式
- WSClistData* getLabels();
- 機能
- 項目を表示しているオブジェクトのリストを返します。
- 処理
-
- 引数
- なし。
- 返値
- オブジェクトのリスト
- 注意
- 返されたリストを開放してはいけません。
getChildren() 関数の子リストと同じように、
リストの各要素を WSCbase* キャストしてオブジェクトに
アクセスします。
- サンプル
-
WSClistData* labels = newlist_000->getLabels();
long i;
long num = labels->getNum();
for(i=0; i<num; i++){
WSCbase* label = (WSCbase*)labels->getData(i);
//label に対して処理。
}
getSelectedLabels 関数の説明
- 書式
- void getSelectedLabels(WSClistData & list);
- 機能
- 与えられたリストに、選択状態にある項目表示オブジェクトを
格納します。
- 処理
-
- 引数
-
(out)WSClistData & list | オブジェクトを格納するリスト |
- 返値
- なし。
- 注意
- 返されたリストの各要素を WSCbase* キャストしてオブジェクトに
アクセスします。
- サンプル
-
WSClistData selected_labels;
newlist_000->getSelectedLabels(selected_labels);
long i;
long num = selected_labels.getNum();
for(i=0; i<num; i++){
WSCbase* label = (WSCbase*)selected_labels[i];
//label に対して処理。
}
setItemVisible 関数の説明
- 書式
- long setItemVisible(long pos,WSCbool fl);
- 機能
- 指定された位置の項目の表示状態を指定します。
- 処理
-
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
(in)WSCbool fl | True = 表示、False = 非表示 |
- 返値
- WS_NO_ERR= 正常、それ以外はエラー。
- 注意
- 項目を削除せずに、非表示としたい場合等に使用します。
- サンプル
-
newlist_000->setItemVisible(0,False); //先頭の項目を不可視化。
setItemValue 関数の説明
- 書式
- long setItemValue(long pos,long kind,long bal);
- 機能
- 指定された位置の項目の項目属性に値を指定します。
- 処理
- 項目属性には、次の様なものが存在します。
WS_OPEN |
ツリー表示モード時の項目の開閉状態 (0=閉、1=開) |
WS_ABSOLUTE_OPEN |
ツリー表示モード時の項目の開閉状態 (0=閉、1=開) |
WS_INDENT_LEVEL |
ツリー表示モード時の項目の階層レベル(0=最上位,1,2,...) |
WS_ICON |
アイコン用画像ファイルのファイル名(char*) |
WS_ABSOLUTE_OPEN は、深い階層にある表示項目を開いた状態にした
場合、上位の階層を含めて開いた状態にします。
アイコンを指定する場合は、アイコン表示プロパティを設定
しなければなりません。
- 引数
-
(in)long pos | 項目の位置(先頭=0 〜 N-1、-1=末尾) |
(in)long kind | 項目属性 |
(in)long val | 設定したい属性値 |
- 返値
- WS_NO_ERR= 正常、それ以外はエラー。
- 注意
-
- サンプル
-
//ツリー表示の場合
newlist_000->delAll();
newlist_000->addItem("item1");
newlist_000->addItem("item2");
newlist_000->addItem("item3");
newlist_000->addItem("item4");
newlist_000->addItem("item5");
newlist_000->setItemValue(0,WS_INDENT_LEVEL,0);
newlist_000->setItemValue(1,WS_INDENT_LEVEL,1);
newlist_000->setItemValue(2,WS_INDENT_LEVEL,2);
newlist_000->setItemValue(3,WS_INDENT_LEVEL,1);
newlist_000->setItemValue(4,WS_INDENT_LEVEL,2);
newlist_000->setItemValue(0,WS_OPEN,1);
newlist_000->setItemValue(1,WS_OPEN,1);
newlist_000->setItemValue(2,WS_OPEN,1);
newlist_000->setItemValue(3,WS_OPEN,0);
結果:
---item1
+--item2
| +--item3
+--item4
( +--item5 ) 不可視
getSortPos() 関数の説明
- 書式
- long getSortPos();
- 機能
- 押されたソートボタンの番号を返します。
- 処理
- 詳細表示モードの時の、ソートボタンの左から、0,1,2,...
が返されます。
- 引数
- なし。
- 返値
- ソートボタンの番号
- 注意
-
- サンプル
-
//詳細表示、タイトルバー領域のソートボタンの番号の取得
long pos = newlist_000->getSortPos();
getTopPos() 関数の説明
- 書式
- long getTopPos();
- 機能
- 現在表示中の最上段に位置する項目の番号を返します。
- 処理
- 現在表示中の最上段に位置する項目の番号を
0,1,2,...
で返します。
- 引数
- なし。
- 返値
- 最上段の項目の番号
- 注意
-
- サンプル
-
//現在の最上段の項目位置の取得
long pos = newlist_000->getTopPos();
getBottomPos() 関数の説明
- 書式
- long getBottomPos();
- 機能
- 現在表示中の最下段に位置する項目の番号を返します。
- 処理
- 現在表示中の最下段に位置する項目の番号を
0,1,2,...
で返します。
- 引数
- なし。
- 返値
- 最下段の項目の番号
- 注意
-
- サンプル
-
//現在の最下段の項目位置の取得
long pos = newlist_000->getBottomPos();
setEnableActivate() 関数の説明
- 書式
- void setEnableActivate(WSCbool fl);
- 機能
- 項目選択時に、ACTIVATE トリガを発生するかどうか設定します。
- 処理
- True が設定された場合、項目選択時に、
ACTIVATE トリガを発生させます。
- 引数
-
- 返値
- なし。
- 注意
-
- サンプル
-
//項目選択時に ACTIVATE を発生させるようにします。
newlist_000->setEnableActivate(True);
onSort() 関数の説明
- 書式
- void onSort();
- 機能
- リストタイプ属性が詳細表示の場合表示されるソートボタンが
押された場合、onSort( ) 関数が実行されます。
- 処理
- アプリケーションは、トリガ(WSEV_SORT)による
イベントプロシージャを用いる変わりに、
この関数をオーバーライドすることでも、データのソートに関する
イベント処理を行うことができます。
getSortPos() 関数を用いて、どのソートボタンが押されたかを
確認し、データのソートを行います。
- 引数
- なし。
- 返値
- なし。
- 注意
-
- サンプル
-
void new_class::onSort(){
//ソートボタンがおされた場合に呼び出されます。
//押されたソートボタン番号の取得
long btn = getSortPos();
//押下されたボタン毎に処理を行います。
//処理を派生元クラスに引き継ぎます。
old_class::onSort();
}
onItemSelected() 関数の説明
- 書式
- void onItemSelected();
- 機能
- 項目が選択状態になった場合、onItemSelected( )
関数が実行されます。
- 処理
- アプリケーションは、トリガ(WSEV_ITEM_SELECTED)による
イベントプロシージャを用いる変わりに、
この関数をオーバーライドすることでも、データの選択に関する
イベント処理を行うことができます。
- 引数
- なし。
- 返値
- なし。
- 注意
-
- サンプル
-
void new_class::onItemSelected(){
//項目が選択された場合に呼び出されます。
long pos = getSelectedPos();
//処理を派生元クラスに引き継ぎます。
old_class::onItemSelected();
}
onInputFixed() 関数の説明
- 書式
- void onInputFixed(WSCstring str,long pos,long column);
- 機能
- 項目にキーボード入力され、確定状態になった場合、
onInputFixed( )関数が実行されます。
- 処理
- アプリケーションは、トリガ(WSEV_INPUT_FIXED)による
イベントプロシージャを用いる変わりに、
この関数をオーバーライドすることでも、文字列の入力に関する
イベント処理を行うことができます。
- 引数
-
(in)WSCstring str | 入力された文字列 |
(in)long pos | 入力のあった項目番号 |
(in)long column | 詳細表示の場合のコラム位置 |
- 返値
- なし。
- 注意
-
- サンプル
-
void new_class::onInputFixed(){
//項目入力が確定された場合に呼び出されます。
//入力文字列の取得
WSCstring str;
str = getInputString();
//処理を派生元クラスに引き継ぎます。
old_class::onInputFixed();
}
cancelInput() 関数の説明
- 書式
- void cancelInput();
- 機能
- 現在入力中のキーボード入力をキャンセルします。
- 処理
-
- 引数
- なし。
- 返値
- なし。
- 注意
-
- サンプル
-
//現在、入力されている文字列を破棄します。
newlist_000->cancelInput();
getInputString() 関数の説明
- 書式
- void getInputString();
- 機能
- 現在入力中のキーボード入力を取得します。
- 処理
-
- 引数
- なし。
- 返値
- 現在の入力中の文字列
- 注意
-
- サンプル
- onInputFixed() を参照してください。
onKey() 関数の説明
- 書式
- void onKey(WSDkeyboard* keyboard,WSCbool keydown);
- 機能
- 項目にキーボードが押下または離された場合に
onKey( )関数が実行されます。
- 処理
- アプリケーションは、トリガ
WSEV_KEY_PRESS / WSEV_KEY_RELEASE による
イベントプロシージャを用いる変わりに、
この関数をオーバーライドすることでも、キーボード入力に関する
イベント処理を行うことができます。
- 引数
-
(in)WSDkeyboard* keyboard | キーボードインスタンス |
(in)WSCbool keydown | True = Press、False = Release |
- 返値
- なし。
- 注意
-
- サンプル
-
void new_class::onKey(WSDkeyboard* keyboard,WSCbool keydown){
//キー入力された場合に呼び出されます。
if (keydown != False){ //キー押下
//キーの取得
long key = keyboard->getKey();
//入力文字列の取得
WSCstring str = keyboard->getText();
}
//処理を派生元クラスに引き継ぎます。
old_class::onKey(keyboard,keydown);
}
Document Release 3.20 For Use with Wide Studio Release 3.20, Winter 2002 WideStudio Home | Up to Copyright(C) T. Hirabayashi, 1999-2002 | | Last modified: Nov. 28, 2002 | |