クラス KSCL::CComboBox の解説

KSCL::CComboBoxのコラボレーション図

解説

　コンボボックスを操作するためのクラスです。

メンバ列挙型の解説

enum KSCL::CComboBox::E_LISTBOX_POS

リストボックス内での位置を示す定数値です。. 　InsertToList() で使用します。 列挙型値: E_FIRST_POS  一番頭。 E_LAST_POS  一番最後。 E_ERROR  エラーが発生しました。

コンストラクタとデストラクタの解説

KSCL::CComboBox::CComboBox (  const int    p_iId, IHwnd *const    p_iHwnd )  throw ()

・コンストラクタ。. 　値を初期化します。

KSCL::CComboBox::~CComboBox (    )  throw () [virtual]

・デストラクタ。. 　特に何もしません。

メンバ関数の解説

const CDialogCtrlData & KSCL::CComboBox::GetDialogCtrlDataRef (    )  const throw ()

・ダイアログコントロールのデータへの参照を返します。. 　ID やウィンドウハンドルを持つ CDialogCtrlData への参照を返します。

std::string KSCL::CComboBox::GetData (    )  const throw ()

・コンボボックスのエディットボックスから文字列を取得して返します。. 戻り値: エディットボックスから取得した文字列。

bool KSCL::CComboBox::SetData (  const std::string &    p_rcStr )  throw ()

・エディットボックスに文字列をセットします。. 戻り値: true  セットできました。 false  セットに失敗しました。 引数: p_rcStr  セットする文字列。

int KSCL::CComboBox::AddToList (  const std::string &    p_rcStr )  throw ()

・コンボボックスの最後に文字列を追加します。. 戻り値: 追加後の文字列の位置。 引数: p_rcStr  追加する文字列。

int KSCL::CComboBox::InsertToList (  const int    p_iIndexPos, const std::string &    p_rcStr )  throw ()

・コンボボックスに文字列を挿入します。. 戻り値: 追加後の文字列の位置。エラー時には E_ERROR が返ります。 引数: p_iIndexPos  挿入する位置。 0 で先頭、 E_LAST_POS で最後。 p_rcStr  追加する文字列。

bool KSCL::CComboBox::InsertFromEditToList (  const bool    p_bCompareNoCase )  throw ()

・エディットボックスの文字列をリストボックスの最初に挿入します。. 　コンボボックスが持つエディットボックスの文字列を、コンボボックスが持つリストボックスの頭に追加する、 というよくあるパターンです。 　エディットボックスの中身が空の場合と、リストボックスの中身が空の場合には何もしません。 　また、コンボボックス内に同一の文字列が含まれている場合にはそれを削除します。 戻り値: true  成功しました。 false  失敗しました。どちらかが空の場合です。 引数: p_bCompareNoCase  大文字小文字を比較しない場合には true を渡してください。

void KSCL::CComboBox::AddAllLines (  const std::vector< std::string > &    p_rcStrVec )  throw ()

・全行を std::vector から追加します。. 　コンボボックスが持つリストボックス内に、全行を追加します。 　そのまま追加するので、空でない場合には元々入っているもののあとに追加されます。 引数: p_rcStrVec  追加する文字列全行。

int KSCL::CComboBox::GetCount (    )  const throw ()

・コンボボックス内の行数を取得します。. 　コンボボックスが持つリストボックス内の行数を取得します。もちろんエディットボックスの部分は含みません。

std::string KSCL::CComboBox::GetFromList (  const int    p_iIndexPos )  const throw ()

・コンボボックスから単語を取得します。. 　コンボボックスが持つリストボックス内の、第１引数で指定した行から文字列を取りだして返します。 戻り値: 取得した文字列。 引数: p_iIndexPos  取得したい行。 0 ベースです。

void KSCL::CComboBox::GetAllLines (  std::vector< std::string > &    p_rcRetStrVec )  const throw ( std::out_of_range )

・全行を取得して std::vector に入れて返します。. 　コンボボックスが持つリストボックス内の全行を第１引数に追加して返します。 　そのまま追加するので、空でない場合には元々入っているもののあとに追加されます。 引数: p_rcRetStrVec  ここから返します。

void KSCL::CComboBox::Clear (    )  throw ()

空にします。. 　リストボックス内の全行を消します。ついでにエディットボックスの方も空にするんでご注意を。

メンバの解説

CDialogCtrlData KSCL::CComboBox::m_cDialogCtrlData [private]

ダイアログコントロールのデータ。.

CEdit KSCL::CComboBox::m_cEdit [private]

エディットボックスとして処理するためのクラス。.

KSCL(KAB-studioClassLibrary)に対してThu Jun 12 09:55:02 2003に生成されました。 1.2.15