CWnd::OnHScroll

[アーティクル]
08/09/2011

ユーザーがウィンドウの水平スクロールバーをクリックしたときに、フレームワークからこのメンバー関数が呼び出されます。

afx_msg void OnHScroll(
   UINT nSBCode,
   UINT nPos,
   CScrollBar* pScrollBar 
);

パラメーター

nSBCode
スクロール要求を示すスクロールバーのコードを指定します。このパラメーターには、次のいずれかの値を指定できます。
- SB_LEFT 左端へスクロール。
- SB_ENDSCROLL スクロール終了。
- SB_LINELEFT 左へスクロール。
- SB_LINERIGHT 右へスクロール。
- SB_PAGELEFT 1 ページ左へスクロール。
- SB_PAGERIGHT 1 ページ右へスクロール。
- SB_RIGHT 右端へスクロール。
- SB_THUMBPOSITION 絶対位置へスクロール。現在位置はパラメーター nPos で指定されます。
- SB_THUMBTRACK スクロールボックスを指定位置へドラッグ。現在位置はパラメーター nPos で指定されます。
nPos
スクロールバーのコードが SB_THUMBPOSITION または SB_THUMBTRACK の場合は、スクロールボックスの位置を指定します。それ以外の場合は使いません。初期スクロール範囲によっては、nPos が負になることもあるので、必要に応じて int にキャストします。
pScrollBar
スクロールバーコントロールからメッセージが送られた場合は、コントロールへのポインターになります。ユーザーがウィンドウのスクロールバーをクリックした場合は、このパラメーターは NULL になります。このポインターは一時的である場合があるので、後で使用するために保持しておくことはできません。

解説

スクロールバーのコード SB_THUMBTRACK は、通常、スクロールボックスがドラッグされている間にそのフィードバックを与えるアプリケーションによって使われます。

アプリケーションがスクロールバーにより制御される内容をスクロールする場合は、スクロールボックスの位置も SetScrollPos メンバー関数を使って設定する必要があります。

注意

このメンバー関数は、アプリケーションが Windows メッセージを処理できるようにするためにフレームワークによって呼び出されます。この関数に渡されるパラメーターの値は、フレームワークがメッセージ受信時に受け取ったパラメーターの値に基づいています。この関数の基本クラスの実装を呼び出した場合は、関数に渡したパラメーターではなく、メッセージと共に渡されたパラメーター自体が使用されます。

使用例

void CMdiView::OnHScroll(UINT nSBCode, UINT nPos, CScrollBar* pScrollBar)
{
   // Get the minimum and maximum scroll-bar positions.
   int minpos;
   int maxpos;
   GetScrollRange(SB_HORZ, &minpos, &maxpos); 
   maxpos = GetScrollLimit(SB_HORZ);

   // Get the current position of scroll box.
   int curpos = GetScrollPos(SB_HORZ);

   // Determine the new position of scroll box.
   switch (nSBCode)
   {
   case SB_LEFT:      // Scroll to far left.
      curpos = minpos;
      break;

   case SB_RIGHT:      // Scroll to far right.
      curpos = maxpos;
      break;

   case SB_ENDSCROLL:   // End scroll.
      break;

   case SB_LINELEFT:      // Scroll left.
      if (curpos > minpos)
         curpos--;
      break;

   case SB_LINERIGHT:   // Scroll right.
      if (curpos < maxpos)
         curpos++;
      break;

   case SB_PAGELEFT:    // Scroll one page left.
   {
      // Get the page size. 
      SCROLLINFO   info;
      GetScrollInfo(SB_HORZ, &info, SIF_ALL);

      if (curpos > minpos)
      curpos = max(minpos, curpos - (int) info.nPage);
   }
      break;

   case SB_PAGERIGHT:      // Scroll one page right.
   {
      // Get the page size. 
      SCROLLINFO   info;
      GetScrollInfo(SB_HORZ, &info, SIF_ALL);

      if (curpos < maxpos)
         curpos = min(maxpos, curpos + (int) info.nPage);
   }
      break;

   case SB_THUMBPOSITION: // Scroll to absolute position. nPos is the position
      curpos = nPos;      // of the scroll box at the end of the drag operation.
      break;

   case SB_THUMBTRACK:   // Drag scroll box to specified position. nPos is the
      curpos = nPos;     // position that the scroll box has been dragged to.
      break;
   }

   // Set the new position of the thumb (scroll box).
   SetScrollPos(SB_HORZ, curpos);

   CView::OnHScroll(nSBCode, nPos, pScrollBar);
}