CSpinButtonCtrl クラス

[アーティクル]
06/16/2023

Windows コモンスピンボタンコントロールの機能が用意されています。

構文

class CSpinButtonCtrl : public CWnd

メンバー

パブリックコンストラクター

名前	説明
CSpinButtonCtrl::CSpinButtonCtrl	`CSpinButtonCtrl` オブジェクトを構築します。

パブリックメソッド

名前	説明
CSpinButtonCtrl::Create	スピンボタンコントロールを作成し、 `CSpinButtonCtrl` オブジェクトにアタッチします。
CSpinButtonCtrl::CreateEx	指定した Windows 拡張スタイルを使用してスピンボタンコントロールを作成し、 `CSpinButtonCtrl` オブジェクトにアタッチします。
CSpinButtonCtrl::GetAccel	スピンボタンコントロールの高速化情報を取得します。
CSpinButtonCtrl::GetBase	スピンボタンコントロールの現在のベースを取得します。
CSpinButtonCtrl::GetBuddy	現在のバディウィンドウへのポインターを取得します。
CSpinButtonCtrl::GetPos	スピンボタンコントロールの現在位置を取得します。
CSpinButtonCtrl::GetRange	スピンボタンコントロールの上限と下限 (範囲) を取得します。
CSpinButtonCtrl::SetAccel	スピンボタンコントロールの加速度を設定します。
CSpinButtonCtrl::SetBase	スピンボタンコントロールのベースを設定します。
CSpinButtonCtrl::SetBuddy	スピンボタンコントロールのバディウィンドウを設定します。
CSpinButtonCtrl::SetPos	コントロールの現在位置を設定します。
CSpinButtonCtrl::SetRange	スピンボタンコントロールの上限と下限 (範囲) を設定します。

解説

"スピンボタンコントロール" (アップダウンコントロールとも呼ばれます) は、スクロール位置やコンパニオンコントロールに表示される数値などの値をインクリメントまたはデクリメントするためにユーザーがクリックできる矢印ボタンのペアです。スピンボタンコントロールに関連付けられている値は、現在の位置と呼ばれます。スピンボタンコントロールは、"バディウィンドウ" と呼ばれるコンパニオンコントロールで最もよく使用されます。

このコントロール (したがって、 CSpinButtonCtrl クラス) は、Windows 95/98 および Windows NT バージョン 3.51 以降で実行されているプログラムでのみ使用できます。

ユーザーには、スピンボタンコントロールとその相棒ウィンドウは、多くの場合、1 つのコントロールのように見えます。スピンボタンコントロールが自動的にバディウィンドウの横に配置され、バディウィンドウのキャプションが現在の位置に自動的に設定されるように指定できます。スピンボタンコントロールと編集コントロールを使用して、ユーザーに数値入力を求めることができます。

上矢印をクリックすると、現在の位置が最大値に移動し、下矢印をクリックすると現在の位置が最小値に移動します。既定では、最小値は 100、最大値は 0 です。最小値が最大設定を超える場合 (既定の設定を使用する場合など)、上矢印をクリックすると位置の値が小さくなり、下矢印をクリックすると大きくなります。

バディウィンドウのないスピンボタンコントロールは、一種の簡略化されたスクロールバーとして機能します。たとえば、タブコントロールにスピンボタンコントロールが表示され、ユーザーが追加のタブを表示にスクロールできる場合があります。

CSpinButtonCtrlの使用方法の詳細については、「Controls および CSpinButtonCtrl の使用を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CSpinButtonCtrl

要件

ヘッダー: afxcmn.h

CSpinButtonCtrl::Create

スピンボタンコントロールを作成し、 CSpinButtonCtrl オブジェクトにアタッチします。

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

パラメーター

dwStyle
スピンボタンコントロールのスタイルを指定します。スピンボタンコントロールスタイルの任意の組み合わせをコントロールに適用します。これらのスタイルについては、Windows SDK のアップダウンコントロールスタイルで説明されています。

rect
スピンボタンコントロールのサイズと位置を指定します。 CRect オブジェクトまたは RECT 構造体のいずれかを指定できます。

pParentWnd
スピンボタンコントロールの親ウィンドウ (通常は CDialog) へのポインター。 NULL は指定できません。

nID
スピンボタンコントロールの ID を指定します。

戻り値

初期化が成功した場合は 0 以外。それ以外の場合は 0。

解説

最初に 2 つの手順で CSpinButtonCtrl オブジェクトを構築し、コンストラクターを呼び出してから、 Createを呼び出します。これにより、スピンボタンコントロールが作成され、 CSpinButtonCtrl オブジェクトにアタッチされます。

拡張ウィンドウスタイルのスピンボタンコントロールを作成するには、Createの代わりに CSpinButtonCtrl::CreateEx を呼び出します。

CSpinButtonCtrl::CreateEx

コントロール (子ウィンドウ) を作成し、 CSpinButtonCtrl オブジェクトに関連付けます。

virtual BOOL CreateEx(
    DWORD dwExStyle,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

パラメーター

dwExStyle
作成するコントロールの拡張スタイルを指定します。拡張ウィンドウスタイルの一覧については、Windows SDK の CreateWindowEx の dwExStyle パラメーターを参照してください。

rect
作成するウィンドウのサイズと位置を記述する RECT 構造体への参照 ( pParentWnd のクライアント座標)。

pParentWnd
コントロールの親であるウィンドウへのポインター。

nID
コントロールの子ウィンドウ ID。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

Create の代わりにCreateExを使用して、Windows 拡張スタイルの前書きWS_EX_で指定された拡張 Windows スタイルを適用します。

CSpinButtonCtrl::CSpinButtonCtrl

CSpinButtonCtrl オブジェクトを構築します。

CSpinButtonCtrl();

CSpinButtonCtrl::GetAccel

スピンボタンコントロールの高速化情報を取得します。

UINT GetAccel(
    int nAccel,
    UDACCEL* pAccel) const;

パラメーター

nAccel
pAccel で指定された配列内の要素の数。

pAccel
アクセラレーション情報を受け取る UDACCEL 構造体の配列へのポインター。

戻り値

取得されたアクセラレータ構造体の数。

CSpinButtonCtrl::GetBase

スピンボタンコントロールの現在のベースを取得します。

UINT GetBase() const;

戻り値

現在の基本値。

CSpinButtonCtrl::GetBuddy

現在のバディウィンドウへのポインターを取得します。

CWnd* GetBuddy() const;

戻り値

現在のバディウィンドウへのポインター。

CSpinButtonCtrl::GetPos

スピンボタンコントロールの現在位置を取得します。

int GetPos() const;  int GetPos32(LPBOOL lpbError = NULL) const;

パラメーター

lpbError
値が正常に取得された場合は 0 に設定されるブール値へのポインター。エラーが発生した場合は 0 以外。このパラメーターが NULL に設定されている場合、エラーは報告されません。

戻り値

最初のバージョンでは、下位ワードの 16 ビットの現在位置が返されます。エラーが発生した場合、上位ワードは 0 以外です。

2 番目のバージョンでは、32 ビット位置が返されます。

解説

返された値を処理すると、コントロールはバディウィンドウのキャプションに基づいて現在の位置を更新します。このコントロールは、バディウィンドウがない場合、またはキャプションで無効または範囲外の値が指定されている場合にエラーを返します。

CSpinButtonCtrl::GetRange

スピンボタンコントロールの上限と下限 (範囲) を取得します。

DWORD GetRange() const;

void GetRange(
    int& lower,
    int& upper) const;

void GetRange32(
    int& lower,
    int &upper) const;

パラメーター

lower
コントロールの下限を受け取る整数への参照。

upper
コントロールの上限を受け取る整数への参照。

戻り値

最初のバージョンでは、上限と下限を含む 32 ビット値が返されます。下位ワードはコントロールの上限であり、上位ワードは下限です。

解説

GetRange32メンバー関数は、スピンボタンコントロールの範囲を 32 ビット整数として取得します。

CSpinButtonCtrl::SetAccel

スピンボタンコントロールの加速度を設定します。

BOOL SetAccel(
    int nAccel,
    UDACCEL* pAccel);

パラメーター

nAccel
pAccelで指定されたUDACCEL構造体の数。

pAccel
アクセラレーション情報を含む UDACCEL 構造体の配列へのポインター。要素は、 nSec メンバーに基づいて昇順で並べ替える必要があります。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

CSpinButtonCtrl::SetBase

スピンボタンコントロールのベースを設定します。

int SetBase(int nBase);

パラメーター

nBase
コントロールの新しい基本値。 10 進数の場合は 10、16 進数の場合は 16 にすることができます。

戻り値

成功した場合は前の基本値、無効なベースが指定された場合は 0。

解説

基本値は、バディウィンドウに数値を 10 進数と 16 進数のどちらで表示するかを決定します。 16 進数は常に符号なしです。10 進数は符号付きです。

CSpinButtonCtrl::SetBuddy

スピンボタンコントロールのバディウィンドウを設定します。

CWnd* SetBuddy(CWnd* pWndBuddy);

パラメーター

pWndBuddy
新しいバディウィンドウへのポインター。

戻り値

前のバディウィンドウへのポインター。

解説

スピンコントロールは、ほとんどの場合、いくつかのコンテンツを表示する編集コントロールなどの別のウィンドウに関連付けられます。この他のウィンドウは、スピンコントロールの "バディ" と呼ばれます。

CSpinButtonCtrl::SetPos

スピンボタンコントロールの現在位置を設定します。

int SetPos(int nPos);
int SetPos32(int nPos);

パラメーター

nPos
コントロールの新しい位置。この値は、コントロールの上限と下限で指定された範囲内である必要があります。

戻り値

前の位置 ( SetPosの場合は 16 ビット精度、 SetPos32の場合は 32 ビット精度)。

解説

SetPos32 は 32 ビット位置を設定します。

CSpinButtonCtrl::SetRange

スピンボタンコントロールの上限と下限 (範囲) を設定します。

void SetRange(
    short nLower,
    short nUpper);

void SetRange32(
    int nLower,
    int nUpper);

パラメーター

nLower と nUpper
コントロールの上限と下限。 SetRangeの場合、どちらの制限もUD_MAXVALより大きくすることも、UD_MINVAL未満にすることもできません。さらに、2 つの制限の差はUD_MAXVALを超えることはできません。 SetRange32 制限に制限はありません。任意の整数を使用します。

解説

SetRange32メンバー関数は、スピンボタンコントロールの 32 ビット範囲を設定します。

Note

スピンボタンの既定の範囲では、最大値が 0 に設定され、最小値が 100 に設定されます。最大値が最小値より小さいため、上矢印をクリックすると位置が小さくなり、下矢印をクリックすると増加します。これらの値を調整するには、 CSpinButtonCtrl::SetRange を使用します。

次の方法で共有

CSpinButtonCtrl クラス

構文

メンバー

パブリック コンストラクター

パブリック メソッド

解説

継承階層

要件

CSpinButtonCtrl::Create

パラメーター

戻り値

解説

CSpinButtonCtrl::CreateEx

パラメーター

戻り値

解説

CSpinButtonCtrl::CSpinButtonCtrl

CSpinButtonCtrl::GetAccel

パラメーター

戻り値

CSpinButtonCtrl::GetBase

戻り値

CSpinButtonCtrl::GetBuddy

戻り値

CSpinButtonCtrl::GetPos

パラメーター

戻り値

解説

CSpinButtonCtrl::GetRange

パラメーター

戻り値

解説

CSpinButtonCtrl::SetAccel

パラメーター

戻り値

CSpinButtonCtrl::SetBase

パラメーター

戻り値

解説

CSpinButtonCtrl::SetBuddy

パラメーター

戻り値

解説

CSpinButtonCtrl::SetPos

パラメーター

戻り値

解説

CSpinButtonCtrl::SetRange

パラメーター

解説

関連項目

フィードバック

その他のリソース

パブリックコンストラクター

パブリックメソッド