第９９章 スクロールバー

「画面全体のコピー」をとっているのでクライアント領域には その画像が収まりきらない！

はい、そうです。当然スクロールバーが必要になります。 非常に基本的なものですが、結構面倒くさいです。 できることなら避けて通りたいものですね。 スクロールバーを避けて通るには、エジットコントロールなどの スクロールバーを自動的に付けてくれるものを利用するのも一つの手です。 しかし、そうも言っていられない場合もあります。

スクロールバーを付けるには、 CreateWindow関数のウィンドウスタイルにWS_VSCROLLやWS_HSCROLLを 加えます。しかし、これだけではスクロール・バーがつくだけで 何の機能も果たしません。スクロール・バーのつまみ等が操作された 時は、そのメッセージを捕まえてアプリケーション側で操作しなくては いけません。

その基本なるものには、従来の方法と３２ビット版の方法で若干の 違いがあります。今回はまず従来の方法でやってみます。

見かけ上の違いは、スクロールつまみの大きさです。 ３２ビット版になってからスクロールつまみの大きさは、現在表示されている 内容が全体のどの位に当たるかを表しています。たとえば、ある文書を 表示しているときその大部分がクライアント領域に表示されているならば スクロールつまみの大きさは相当大きく（長く）なります。 また、現在表示されている部分が全体のほんの一部である場合はスクロールつまみも 小さくなります。ユーザーは、つまみの大きさを見て、見えない部分が どの位あるのかを知ることができます。（しかし、筆者の周りの人たちを見ていると 気が付いている人は少ない！）

まず、よく使う関数とメッセージについて解説します。

BOOL SetScrollRange(
    HWND hWnd,    // スクロールバーを持ったウィンドウのハンドル
    int nBar,    // スクロールバーフラグ
    int nMinPos,    // スクロール位置の最小値
    int nMaxPos,    // 最大値
    BOOL bRedraw     // 再描画フラグ
   );

スクロール位置の最小値、最大値はつまみが一番上、下にある時の 値です。最小値を０、最大値を１０にするとつまみは０，１，．．．１０ の位置に止まることができます。

再描画フラグをTRUEにするとスクロールバーの再描画します。

成功するとTRUE、失敗するとFALSEを返します。

int SetScrollPos(
    HWND hWnd,    // スクロールバーをもつウィンドウのハンドル
    int nBar,    // スクロールバーフラグ
    int nPos,    // 新しいスクロール位置
    BOOL bRedraw     // 再描画フラグ
   );

成功すると以前のスクロール位置を返します。失敗すると０を返します。

次に処理しなくてはならないメッセージには次のようなものがあります。

WM_VSCROLL  
nScrollCode = (int) LOWORD(wParam); // スクロールコード
nPos = (short int) HIWORD(wParam);  // スクロールボックス（つまみ）の位置 
hwndScrollBar = (HWND) lParam;      // スクロールバーのハンドル 

この時、wParamの下位は、スクロールバーに対して行っている操作を表します。 スクロール矢印（スクロール・バーの両端にある三角形のついたボタン）が 押されているとSB_LINEUPやSB_LINEDOWNとなります。スクロールシャフト （スクロール矢印とスクロールつまみの間）が押されているとSB_PAGEUPや SB_PAGEDOWNとなります。また、スクロールつまみが押されたときはSB_THUMBTRACK となり、離されたときはSB_THUMBPOSITIONとなります。小さい量のスクロールなら SB_THUMBTRACKを処理しますが膨大なものをスクロールすると画面がちらつくので SB_THUMBPOSITIONを処理します。この場合つまみをドラッグ中はクライアント領域の 再描画は行われず、つまみを離したときのみに再描画が起こります。

WM_HSCROLL  
nScrollCode = (int) LOWORD(wParam);
nPos = (short int) HIWORD(wParam);
hwndScrollBar = (HWND) lParam;

さて、スクロールバーを付けて、処理すべきメッセージもわかりました。 では、具体的にどうすればよいのでしょうか。垂直スクロールを 例に取ると

１．位置y、最大スクロール幅range、表示したいものの全体の大きさwy（高さ）
　　一回のスクロール量dy、現在のクライアント領域の高さclientyを
　　staticな変数で用意する
２．WM_SIZEメッセージが来たらクライアント領域の高さを調べる
　　また、スクロール範囲を計算する range=wy-clienty
　　現在の位置をセットする SetScrollPos();
３．WM_VSCROLLメッセージが来たらLOWORD(wParam)を調べる
４．LOWORD(wParam)がSB_LINEUPなら、スクロール量を−１にする
    SB_LINEDOWNなら、スクロール量を１にする
５．SB_PAGEUPならスクロール量を１ページ分または適当量を負の値でセットする
　　SB_PAGEDOWNなら正の値でセット
６．SB_THUMBPOSITON（つまみを動かして手を離した）なら
　　スクロール量をHIWORD(wParam)-yにする
７．以上で仮に決めたスクロール量が妥当かどうか検討し補正する
　　一般には　dy = max(-y, min(dy, range - y));
　　がよく使われる
８．スクロール量が０でないときは
　　新しい現在位置を y += dy;とする
　　ScrollWindow(hWnd, 0, -dy, NULL, NULL);でクライアント領域を
　　スクロールさせる
　　新しい現在位置をSetScrollPosで表示させる
　　必要があればUpdateWindowを実行
９．WM_PAINT側でしかるべき対応をする

SB_THUMBPOSITONの時HIWORD(wParam)は現在の位置なので HIWORD(wp)-yでスクロールしなくてはいけない距離がわかります。

もっともわかりにくいのが７．の意味でしょう。 これをチェックしなくてもスクロールバーは正常に動きます。 しかし、つまみが一番上とか下に行った後もスクロールを続けてしまいます。 スクロールつまみが一番上にあるときさらに上矢印を押したとします。 yは０です。上矢印が押されたのでスクロール量は−１となります。 min(dy, range-y)は当然dyとなります。次にmax(-y, dy)は０となります これでスクロールは起こりません。
次にスクロールつまみが一番下にあるのにさらに下矢印を押した時を 考えます。この時y=rangeで下矢印が押されたのでdy=1となります min(dy, rang-y)は０となります。max(-y, 0)は０となりdy=0になり スクロールは起きません。
では、スクロールつまみがかなり下の方にありにあり、スクロール量だけスクロールすると スクロール範囲を逸脱するときはmin(dy, range-y)はrange-yとなります。 この時max(-y, range-y)はrange-yとなりスクロール後ちょうど一番下に来ます。
スクロールつまみがかなり上の方にあって、スクロール量だけスクロールすると スクロール範囲を逸脱するときもちょうど一番上に来るように調整されます。 これを自分で考えるのは至難の業です。if文などで解決できそうに思うかもしれませんが かなり面倒なことになります。腕に自信のある人は試みてください。

BOOL ScrollWindow(
    HWND hWnd,    // スクロールさせるウィンドウのハンドル
    int XAmount,    // 水平方向のスクロール量
    int YAmount,    // 素直方向のスクロール量
    CONST RECT *lpRect,    // スクロールする矩形構造体のアドレス
    CONST RECT *lpClipRect     // クリップする矩形構造体のアドレス
   );    

さて、これでスクロールが解決したわけではありません。 ScrollWindow関数は確かにクライアント領域をスクロールしてくれますが、 スクロール前にクライアント領域外にあった部分まで面倒をみてくれるわけではありません。 したがって、WM_PAINTメッセージの処理にも一工夫いります。

前章では

BitBlt(hdc, 0, 0, wx, wy, hdc_mem, 0, 0, SRCCOPY);

により、メモリデバイスコンテキストのビットマップをhdcの(0,0)に 転送していました。画面がyだけ垂直スクロールした場合転送は (0, -y)に行う必要があります。これもyの正・負に気をつけてください。 (0,0)のまま、(0,y)の時どのようになるか実験してみてください。 なかなか興味深いことが起こります。
説明が長くなってしまいました。サンプルをみてみましょう。 今回は一気に表示します。リソーススクリプトは前回と全く同じなので 省略してソースファイルのみ示します。

//        scroll01.cpp

#define STRICT
#include <windows.h>
#include "resource.h"

LRESULT CALLBACK WndProc(HWND, UINT, WPARAM, LPARAM);
BOOL InitApp(HINSTANCE);
BOOL InitInstance(HINSTANCE, int);

char szClassName[] = "scroll01";//ウィンドウクラス

int WINAPI WinMain(HINSTANCE hCurInst, HINSTANCE hPrevInst,
                   LPSTR lpsCmdLine, int nCmdShow)
{
    MSG msg;
    
    if (!InitApp(hCurInst))
        return FALSE;
    if (!InitInstance(hCurInst, nCmdShow)) 
        return FALSE;
    while (GetMessage(&msg, NULL, 0, 0)) {
        TranslateMessage(&msg);
        DispatchMessage(&msg);
    }
    return msg.wParam;
}

//ウィンドウ・クラスの登録

BOOL InitApp(HINSTANCE hInst)
{
    WNDCLASSEX wc;
    wc.cbSize = sizeof(WNDCLASSEX);
    wc.style = CS_HREDRAW | CS_VREDRAW;
    wc.lpfnWndProc = WndProc;    //プロシージャ名
    wc.cbClsExtra = 0;
    wc.cbWndExtra = 0;
    wc.hInstance = hInst;        //インスタンス
    wc.hIcon = LoadIcon(NULL, IDI_APPLICATION);
    wc.hCursor = LoadCursor(NULL, IDC_ARROW);
    wc.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH);
    wc.lpszMenuName = "MYMENU";    //メニュー名
    wc.lpszClassName = (LPCSTR)szClassName;
    wc.hIconSm = LoadIcon(NULL, IDI_APPLICATION);
    return (RegisterClassEx(&wc));
}

//ウィンドウの生成

BOOL InitInstance(HINSTANCE hInst, int nCmdShow)
{
    HWND hWnd;

    hWnd = CreateWindow(szClassName,
            "猫でもわかるスクロールバー",//タイトルバーにこの名前が表示されます
            WS_OVERLAPPEDWINDOW | WS_VSCROLL,//ウィンドウの種類
            CW_USEDEFAULT,    //Ｘ座標
            CW_USEDEFAULT,    //Ｙ座標
            CW_USEDEFAULT,    //幅
            CW_USEDEFAULT,    //高さ
            NULL,            //親ウィンドウのハンドル、親を作るときはNULL
            NULL,            //メニューハンドル、クラスメニューを使うときはNULL
            hInst,            //インスタンスハンドル
            NULL);
    if (!hWnd)
        return FALSE;
    ShowWindow(hWnd, nCmdShow);
    UpdateWindow(hWnd);
    return TRUE;
}

//ウィンドウプロシージャ

LRESULT CALLBACK WndProc(HWND hWnd, UINT msg, WPARAM wp, LPARAM lp)
{
    int id;
    static RECT rc;
    HDC hdc, hdcScreen, hdc_mem, hdc_mem_screen;
    static HBITMAP hBitmap;
    static int wx, wy;//画面の大きさ
    PAINTSTRUCT ps;
    static int y;//スクロール位置
    static int dy;//増分
    static int range;//最大スクロール範囲
    static int yclient;//現在のクライアント領域の高さ

    switch (msg) {
        case WM_SIZE:
            yclient = HIWORD(lp);
            range = wy - yclient;
            y = min(y, range);
            SetScrollRange(hWnd, SB_VERT, 0, range, FALSE);
            SetScrollPos(hWnd, SB_VERT, y, TRUE);
            break;
        case WM_CREATE:
            wx = GetSystemMetrics(SM_CXSCREEN);
            wy = GetSystemMetrics(SM_CYSCREEN);
            break;
        case WM_VSCROLL:
            switch (LOWORD(wp)) {
                case SB_LINEUP:
                    dy = -1;
                    break;
                case SB_LINEDOWN:
                    dy = 1;
                    break;
                case SB_THUMBPOSITION:
                    dy = HIWORD(wp)-y;
                    break;
                case SB_PAGEDOWN:
                    dy = 10;
                    break;
                case SB_PAGEUP:
                    dy = -10;
                    break;
                default:
                    dy = 0;
                    break;
            }
            dy = max(-y, min(dy, range - y));
            if (dy != 0) {
                y += dy;
                ScrollWindow(hWnd, 0, -dy, NULL, NULL);
                SetScrollPos(hWnd, SB_VERT, y, TRUE);
                UpdateWindow(hWnd);
            }
            break;
        case WM_PAINT:
            if (hBitmap) {
                hdc = BeginPaint(hWnd, &ps);
                
                hdc_mem = CreateCompatibleDC(hdc);
                SelectObject(hdc_mem, hBitmap);
                BitBlt(hdc, 0, 0-y, wx, wy, hdc_mem, 0, 0, SRCCOPY);
                DeleteDC(hdc_mem);
                EndPaint(hWnd, &ps);
            } else {
                return DefWindowProc(hWnd, msg, wp, lp);
            }
            break;
        case WM_COMMAND:
            switch (LOWORD(wp)) {
                case IDM_END:
                    SendMessage(hWnd, WM_CLOSE, 0, 0);
                    break;
                case IDM_GET:
                    GetClientRect(hWnd, &rc);
                    ShowWindow(hWnd, SW_HIDE);
                    Sleep(500);
                    hdcScreen = CreateDC("DISPLAY", NULL, NULL, NULL);
                    hdc_mem_screen = CreateCompatibleDC(hdcScreen);
                    hBitmap = CreateCompatibleBitmap(hdcScreen, wx, wy);
                    SelectObject(hdc_mem_screen, hBitmap);
                    BitBlt(hdc_mem_screen, 0, 0, wx, wy, hdcScreen, 0, 0, SRCCOPY);
                    if(OpenClipboard(hWnd) != 0) {
                        EmptyClipboard();
                        SetClipboardData(CF_BITMAP, hBitmap);
                        CloseClipboard();
                    }
                    DeleteDC(hdc_mem_screen);
                    DeleteDC(hdcScreen);
                    ShowWindow(hWnd, SW_SHOWNORMAL);
                    break;
            }
            break;
        case WM_CLOSE:
            id = MessageBox(hWnd,
                (LPCSTR)"終了してもよいですか",
                (LPCSTR)"終了確認",
                MB_YESNO | MB_ICONQUESTION);
            if (id == IDYES) {
                DestroyWindow(hWnd);
            }
            break;
        case WM_DESTROY:
            PostQuitMessage(0);
            break;
        default:
            return (DefWindowProc(hWnd, msg, wp, lp));
    }
    return 0L;
}

水平方向のスクロールバーもつけてみてください。基本的な考え方は同じです。