`CScrollBar` クラス

[アーティクル]
10/12/2023

Windows のスクロールバーコントロールの機能を提供します。

構文

class CScrollBar : public CWnd

メンバー

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

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

パブリックメソッド

名前	説明
`CScrollBar::Create`	Windows スクロールバーを作成し、 `CScrollBar` オブジェクトにアタッチします。
`CScrollBar::EnableScrollBar`	スクロールバーの矢印の一方または両方を有効または無効にします。
`CScrollBar::GetScrollBarInfo`	`SCROLLBARINFO`構造体を使用して、スクロールバーに関する情報を取得します。
`CScrollBar::GetScrollInfo`	スクロールバーに関する情報を取得します。
`CScrollBar::GetScrollLimit`	スクロールバーの制限を取得します。
`CScrollBar::GetScrollPos`	スクロールボックスの現在位置を取得します。
`CScrollBar::GetScrollRange`	指定されたスクロールバーの現在の最小および最大のスクロールバー位置を取得します。
`CScrollBar::SetScrollInfo`	スクロールバーの情報を設定します。
`CScrollBar::SetScrollPos`	スクロールボックスの現在位置を設定します。
`CScrollBar::SetScrollRange`	指定されたスクロールバーの最小位置と最大位置の値を設定します。
`CScrollBar::ShowScrollBar`	スクロールバーの表示と非表示を切り替えます。

解説

スクロールバーコントロールは、2 つの手順で作成します。まず、コンストラクター CScrollBar を呼び出して CScrollBar オブジェクトを構築し、 Create メンバー関数を呼び出して Windows スクロールバーコントロールを作成し、 CScrollBar オブジェクトにアタッチします。

ダイアログボックス内に (ダイアログリソースを使用して) CScrollBar オブジェクトを作成すると、ユーザーがダイアログボックスを閉じると、 CScrollBar が自動的に破棄されます。

ウィンドウ内に CScrollBar オブジェクトを作成する場合は、破棄が必要になる場合もあります。

スタック上に CScrollBar オブジェクトを作成すると、自動的に破棄されます。 new関数を使用してヒープ上にCScrollBar オブジェクトを作成する場合は、ユーザーが Windows スクロールバーを終了したときにオブジェクトに対してdeleteを呼び出して破棄する必要があります。

CScrollBar オブジェクトにメモリを割り当てる場合は、CScrollBarデストラクターをオーバーライドして割り当てを破棄します。

CScrollBarの使用に関する関連情報については、「Controls」を参照してください。

継承階層

CObject

CCmdTarget

CWnd

CScrollBar

要件

ヘッダー: afxwin.h

`CScrollBar::Create`

Windows スクロールバーを作成し、 CScrollBar オブジェクトにアタッチします。

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

パラメーター

dwStyle
スクロールバーのスタイルを指定します。スクロールバーにスクロールバースタイルの任意の組み合わせを適用します。

rect
スクロールバーのサイズと位置を指定します。 RECT構造体またはCRect オブジェクトを指定できます。

pParentWnd
スクロールバーの親ウィンドウ (通常は CDialog オブジェクト) を指定します。 NULLすることはできません。

nID
スクロールバーのコントロール ID。

戻り値

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

解説

CScrollBar オブジェクトは、2 つの手順で作成します。まず、 CScrollBar オブジェクトを構築するコンストラクターを呼び出してから、 Createを呼び出します。これにより、関連付けられている Windows スクロールバーが作成されて初期化され、 CScrollBar オブジェクトにアタッチされます。

次のウィンドウスタイルをスクロールバーに適用します。

WS_CHILD いつも
WS_VISIBLE 通常は
WS_DISABLED 稀に
WS_GROUP コントロールをグループ化するには

例

// Example 1:
// Create a horizontal CScrollBar control as a child window of CMyDialog
// class (a CDialog-derived class). The scroll bar is NOT visible until the
// call ShowScrollBar() is made. m_ScrollBarHorz is of type CScrollBar class,
// and it is a member variable in CMyDialog class.
VERIFY(m_ScrollBarHorz.Create(SBS_HORZ | SBS_TOPALIGN | WS_CHILD,
                              CRect(5, 5, 100, 30), this, IDC_SCROLLBARCTRL));

m_ScrollBarHorz.ShowScrollBar();

// Example 2:
// Create a vertical CScrollBar control as a child window of CMyDialog
// class (a CDialog-derived class). m_ScrollBarVert is of type CScrollBar
// class, and it is a member variable in CMyDialog class.
VERIFY(m_ScrollBarVert.Create(SBS_VERT | SBS_LEFTALIGN | WS_CHILD |
                                  WS_VISIBLE,
                              CRect(5, 30, 30, 130), this, IDC_SCROLLBARCTRL));

`CScrollBar::CScrollBar`

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

CScrollBar();

解説

オブジェクトを構築した後、 Create メンバー関数を呼び出して、Windows のスクロールバーを作成して初期化します。

例

CScrollBar m_ScrollBarHorz;

`CScrollBar::EnableScrollBar`

スクロールバーの矢印の一方または両方を有効または無効にします。

BOOL EnableScrollBar(UINT nArrowFlags = ESB_ENABLE_BOTH);

パラメーター

nArrowFlags
スクロール矢印を有効にするか無効にするか、どの矢印を有効または無効にするかを指定します。このパラメーターには、次の値のいずれかを指定できます。

ESB_ENABLE_BOTH スクロールバーの両方の矢印を有効にします。
ESB_DISABLE_LTUP 水平スクロールバーの左矢印または垂直スクロールバーの上矢印を無効にします。
ESB_DISABLE_RTDN 水平スクロールバーの右矢印または垂直スクロールバーの下矢印を無効にします。
ESB_DISABLE_BOTH スクロールバーの両方の矢印を無効にします。

戻り値

矢印が指定されたとおりに有効または無効になっている場合は 0 以外。それ以外の場合は 0。矢印が既に要求された状態であるか、エラーが発生したことを示します。

例

CScrollBar::SetScrollRange の例を参照してください。

`CScrollBar::GetScrollBarInfo`

SCROLLBARINFO 構造体がスクロールバーについて保持している情報を取得します。

BOOL GetScrollBarInfo(PSCROLLBARINFO pScrollInfo) const;

パラメーター

pScrollInfo
SCROLLBARINFO 構造体へのポインター。

戻り値

正常に終了した場合は、TRUE を返します。それ以外の場合は、FALSE を返します。

解説

このメンバー関数は、Windows SDK で説明されているように、 SBM_SCROLLBARINFO メッセージの機能をエミュレートします。

`CScrollBar::GetScrollInfo`

SCROLLINFO 構造体がスクロールバーについて保持している情報を取得します。

BOOL GetScrollInfo(
    LPSCROLLINFO lpScrollInfo,
    UINT nMask = SIF_ALL);

パラメーター

lpScrollInfo
SCROLLINFO 構造体へのポインター。この構造の詳細については、Windows SDK を参照してください。

nMask
取得するスクロールバーのパラメーターを指定します。一般的な使用法 SIF_ALL、 SIF_PAGE、 SIF_POS、 SIF_TRACKPOS、および SIF_RANGEの組み合わせを指定します。 nMask値の詳細については、SCROLLINFOを参照してください。

戻り値

メッセージが値を取得した場合、戻り値は TRUE。それ以外の場合は、FALSE となります。

解説

GetScrollInfo を使用すると、アプリケーションは 32 ビットのスクロール位置を使用できます。

SCROLLINFO構造体には、スクロールバーに関する情報 (スクロールの最小位置と最大位置、ページサイズ、スクロールボックスの位置 (つまみ) など) が含まれます。構造体の既定値の変更の詳細については、Windows SDK の SCROLLINFO 構造に関するトピックを参照してください。

スクロールバーの位置、 CWnd::OnHScroll、および CWnd::OnVScrollを示す MFC Windows メッセージハンドラーは、16 ビットの位置データのみを提供します。 GetScrollInfo 32 ビットのスクロールバー位置データを提供 SetScrollInfo 。したがって、アプリケーションは、CWnd::OnHScrollまたはCWnd::OnVScrollの処理中にGetScrollInfoを呼び出して、32 ビットのスクロールバー位置データを取得できます。

例

CWnd::OnHScroll の例を参照してください。

`CScrollBar::GetScrollLimit`

スクロールバーの最大スクロール位置を取得します。

int GetScrollLimit();

戻り値

成功した場合のスクロールバーの最大位置を指定します。それ以外の場合は 0。

例

CWnd::OnHScroll の例を参照してください。

`CScrollBar::GetScrollPos`

スクロールボックスの現在位置を取得します。

int GetScrollPos() const;

戻り値

成功した場合のスクロールボックスの現在位置を指定します。それ以外の場合は 0。

解説

現在の位置は、現在のスクロール範囲に依存する相対値です。たとえば、スクロール範囲が 100 ~ 200 で、スクロールボックスがバーの中央にある場合、現在の位置は 150 です。

例

CWnd::OnHScroll の例を参照してください。

`CScrollBar::GetScrollRange`

指定したスクロールバーの現在の最小および最大スクロールバーの位置を、 lpMinPos および lpMaxPosで指定された場所にコピーします。

void GetScrollRange(
    LPINT lpMinPos,
    LPINT lpMaxPos) const;

パラメーター

lpMinPos
最小位置を受け取る整数変数を指します。

lpMaxPos
最大位置を受け取る整数変数を指します。

解説

スクロールバーコントロールの既定の範囲は空です (両方の値は 0 です)。

例

CWnd::OnHScroll の例を参照してください。

`CScrollBar::SetScrollInfo`

SCROLLINFO構造体がスクロールバーに関して保持する情報を設定します。

BOOL SetScrollInfo(
    LPSCROLLINFO lpScrollInfo,
    BOOL bRedraw = TRUE);

パラメーター

lpScrollInfo
SCROLLINFO 構造体へのポインター。

bRedraw
新しい情報を反映するようにスクロールバーを再描画するかどうかを指定します。 bRedrawがTRUEされている場合は、スクロールバーが再描画されます。 FALSEされている場合は、再描画されません。既定では、スクロールバーが再描画されます。

戻り値

成功した場合、戻り値は TRUE。それ以外の場合は、FALSE となります。

解説

フラグ値を含め、 SCROLLINFO 構造体パラメーターに必要な値を指定する必要があります。

例

// Set SCROLLINFO for the scroll bar. m_ScrollBarHorz is of type
// CScrollBar class, and it is a member variable in CMyDialog class.
SCROLLINFO info;
info.cbSize = sizeof(SCROLLINFO);
info.fMask = SIF_ALL;
info.nMin = 0;
info.nMax = 10;
info.nPage = 2;
info.nPos = 5;
info.nTrackPos = 2;
m_ScrollBarHorz.SetScrollInfo(&info);

`CScrollBar::SetScrollPos`

スクロールボックスの現在位置を nPos で指定された位置に設定し、指定した場合は、新しい位置を反映するようにスクロールバーを再描画します。

int SetScrollPos(
    int nPos,
    BOOL bRedraw = TRUE);

パラメーター

nPos
スクロールボックスの新しい位置を指定します。スクロール範囲内である必要があります。

bRedraw
新しい位置を反映するようにスクロールバーを再描画するかどうかを指定します。 bRedrawがTRUEされている場合は、スクロールバーが再描画されます。 FALSEされている場合は、再描画されません。既定では、スクロールバーが再描画されます。

戻り値

成功した場合のスクロールボックスの前の位置を指定します。それ以外の場合は 0。

解説

スクロールバーが短い間隔で 2 回再描画されないように、スクロールバーが別の関数の後続の呼び出しによって再描画されるたびに、 bRedraw を FALSE に設定します。

例

CScrollBar::SetScrollRange の例を参照してください。

`CScrollBar::SetScrollRange`

指定されたスクロールバーの最小位置と最大位置の値を設定します。

void SetScrollRange(
    int nMinPos,
    int nMaxPos,
    BOOL bRedraw = TRUE);

パラメーター

nMinPos
最小スクロール位置を指定します。

nMaxPos
最大スクロール位置を指定します。

bRedraw
変更を反映するためにスクロールバーを再描画するかどうかを指定します。 bRedrawがTRUE場合、スクロールバーは再描画されます。FALSE場合は、再描画されません。既定では再描画されます。

解説

標準のスクロールバーを非表示にするには、 nMinPos と nMaxPos を 0 に設定します。

スクロールバー通知メッセージの処理中にスクロールバーを非表示にするには、この関数を呼び出さないでください。

SetScrollRangeの呼び出しが SetScrollPos メンバー関数の呼び出しの直後にある場合は、スクロールバーが 2 回再描画されないように、SetScrollPosのbRedrawを 0 に設定します。

nMinPosとnMaxPosで指定した値の差は、32,767 を超えてはなりません。スクロールバーコントロールの既定の範囲は空です ( nMinPos と nMaxPos の両方が 0 です)。

例

// Sets minimum (0) and maximum (10) position values for the
// CScrollBar control. m_ScrollBarVert is of type CScrollBar class,
// and it is a member variable in CMyDialog class.
m_ScrollBarVert.SetScrollRange(0, 10);

// Set the position of the scroll box.
m_ScrollBarVert.SetScrollPos(5);

// Disable the down arrow of the scroll bar. By default, both arrows
// are enabled.
m_ScrollBarVert.EnableScrollBar(ESB_DISABLE_DOWN);

`CScrollBar::ShowScrollBar`

スクロールバーの表示と非表示を切り替えます。

void ShowScrollBar(BOOL bShow = TRUE);

パラメーター

bShow
スクロールバーを表示するか非表示にするかを指定します。このパラメーターが TRUEされている場合、スクロールバーが表示されます。それ以外の場合は非表示になります。

解説

アプリケーションでは、スクロールバー通知メッセージの処理中にスクロールバーを非表示にするために、この関数を呼び出さないでください。

例

CScrollBar::Create の例を参照してください。

次の方法で共有

CScrollBar クラス

構文

メンバー

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

パブリック メソッド

解説

継承階層

要件

CScrollBar::Create

パラメーター

戻り値

解説

例

CScrollBar::CScrollBar

解説

例

CScrollBar::EnableScrollBar

パラメーター

戻り値

例

CScrollBar::GetScrollBarInfo

パラメーター

戻り値

解説

CScrollBar::GetScrollInfo

パラメーター

戻り値

解説

例

CScrollBar::GetScrollLimit

戻り値

例

CScrollBar::GetScrollPos

戻り値

解説

例

CScrollBar::GetScrollRange

パラメーター

解説

例

CScrollBar::SetScrollInfo

パラメーター

戻り値

解説

例

CScrollBar::SetScrollPos

パラメーター

戻り値

解説

例

CScrollBar::SetScrollRange

パラメーター

解説

例

CScrollBar::ShowScrollBar

パラメーター

解説

例

関連項目

フィードバック

その他のリソース

`CScrollBar` クラス

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

パブリックメソッド

`CScrollBar::Create`

`CScrollBar::CScrollBar`

`CScrollBar::EnableScrollBar`

`CScrollBar::GetScrollBarInfo`

`CScrollBar::GetScrollInfo`

`CScrollBar::GetScrollLimit`

`CScrollBar::GetScrollPos`

`CScrollBar::GetScrollRange`

`CScrollBar::SetScrollInfo`

`CScrollBar::SetScrollPos`

`CScrollBar::SetScrollRange`

`CScrollBar::ShowScrollBar`