文字の表示その2

文字列に書式を指定する

前ページで使用したTextOut関数は、文字列を手軽に描画できる関数です。
その代わり機能が少なく、実は改行することさえできません。
改行文字(\n)は奇妙な記号に化けますし、ウィンドウの右端を超えても自動改行などはされません。
(超えた分は画面に表示されません)

もう少し高機能な文字列出力関数にDrawText関数があります。
その説明の前に、この関数を使いやすくするためのGetClientRect関数を説明します。

GetClientRect関数

BOOL GetClientRect(
 HWND hWnd,
 LPRECT lpRect
);

ウィンドウhWndのクライアント領域の座標情報をlpRectに格納する。
成功した場合は0以外を返す。

GetClientRect関数は、指定したウィンドウのクライアント領域全体の矩形をRECT構造体で取得できます。
第二引数はRECT構造体のポインタであることに注意してください。

基準点はクライアント領域の左上なので、RECT構造体のleftメンバとtopメンバは常に0です。
rightメンバはクライアント領域の幅、bottomメンバは高さを表します。

DrawText関数

int DrawTextW(
 HDC hdc,
 LPCWSTR lpchText,
 int cchText,
 LPRECT lprc,
 UINT format
);

書式formatに従い、矩形lprc内に文字列lpchTextをcchText文字分描画する。
戻り値は描画した文字列の高さ。

第一引数hdcは、TextOut関数と同じくデバイスコンテキストハンドルを指定します。
第二引数lpchTextは、出力したい文字列を指定します。
第三引数cchTextは出力する文字数の指定です。
ここに-1を指定すると、lpchTextから自動的に文字数を計算してくれます。

第四引数lprcは描画する領域の矩形情報を格納するRECT構造体のポインタを指定します。
DrawText関数は、この矩形領域内に文字列を描画しようとします。
サンプルコードではクライアント領域全体に描画しています。

第五引数formatは文字列の書式です。
これは以下の定数の組み合わせを指定します。

数が多いですが、DT_WORDBREAK(複数行表示)やDT_LEFT、DT_CENTER、DT_SINGLELINEによるテキストの左/中央/右揃えあたりがよく使用されます。
「&」という文字はDrawText関数では特殊な意味を持ちます。
&自体を表示したい場合は「&&」と二つ続けて記述するか、DT_NOPREFIXフラグを使用します。

戻り値は描画したテキストの高さです。

サンプルコード1

#include <windows.h>

//ウィンドウの生成等は省略

#define BUFFERSIZE 128

//ウィンドウプロシージャ
LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
	HDC hdc;
	PAINTSTRUCT ps;

	RECT rect;
	WCHAR buf[BUFFERSIZE];
	static const WCHAR* format = L"クライアント領域のRECT情報\n"
		L"left  : %ld\n"
		L"top   : %ld\n"
		L"right : %ld\n"
		L"bottom: %ld";

	switch (message)
	{
	case WM_PAINT: //ウィンドウの描画発生
		//クライアント領域のサイズを取得
		GetClientRect(hWnd, &rect);
		StringCchPrintf(buf, BUFFERSIZE, format,
			rect.left,
			rect.top,
			rect.right,
			rect.bottom);

		hdc = BeginPaint(hWnd, &ps);
		DrawText(hdc, buf, -1, &rect, DT_WORDBREAK);
		EndPaint(hWnd, &ps);
		break;

	case WM_DESTROY: //ウィンドウの破棄
		PostQuitMessage(0);
		break;

	default:
		return DefWindowProc(hWnd, message, wParam, lParam);
	}
	return 0;
}

このコードはクライアント領域のサイズ情報(RECT構造体)を表示します。
ウィンドウサイズを変更すると数値がリアルタイムに更新されます。
(サイズ変更毎にWM_PAINTメッセージが発行されているということです)
DT_WORDBREAKフラグを指定しているので、文字列が領域幅内に収まりきらない場合は自動的に改行されます。

また、文字列に改行(\n)が含まれていることにも注目してください。
ウィンドウ右端での自動改行のほか、任意の位置での改行も可能です。

//以下はすべて同じ文字列
char str1[] = "abcdef";
char str2[] = "abc""def";
char str3[] = "abc" "def";
char str4[] = "abc"
	"def";

サンプルコード2

DrawText関数の戻り値を利用して、文字列を出力した次の行に別の文字列を出力するサンプルです。

LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
	HDC hdc;
	PAINTSTRUCT ps;
	RECT rect;

	static const WCHAR* str1 = L"長～～～～～～～～～い文字列";
	static const WCHAR* str2 = L"短い文字列";

	switch (message)
	{
	case WM_PAINT: //ウィンドウの描画発生
		GetClientRect(hWnd, &rect);

		hdc = BeginPaint(hWnd, &ps);
		rect.top += DrawText(hdc, str1, -1, &rect, DT_WORDBREAK);
		rect.top += DrawText(hdc, str2, -1, &rect, DT_WORDBREAK);
		EndPaint(hWnd, &ps);
		break;

	case WM_DESTROY: //ウィンドウの破棄
		PostQuitMessage(0);
		break;

	default:
		return DefWindowProc(hWnd, message, wParam, lParam);
	}
	return 0;
}

一行目が改行によって複数行になった場合でも、二行目はそのすぐ下に表示されます。

DrawTextEx関数

DrawText関数の拡張版にDrawTextEx関数というものもあります。

int DrawTextExW(
 HDC hdc,
 LPWSTR lpchText,
 int cchText,
 LPRECT lprc,
 UINT format,
 LPDRAWTEXTPARAMS lpdtp
);

書式formatに従い、矩形lprc内に文字列lpchTextをcchText文字分描画する。
lpdtpで拡張フォーマットを指定できる。
戻り値は描画した文字列の高さ。

DrawText関数との違いは、引数の最後に拡張フォーマットの指定が追加されている点です。
拡張フォーマットはDRAWTEXTPARAMS構造体を使用して指定します。
(LPDRAWTEXTPARAMSはDRAWTEXTPARAMSのポインタ型です)

typedef struct tagDRAWTEXTPARAMS {
 UINT cbSize;
 int iTabLength;
 int iLeftMargin;
 int iRightMargin;
 UINT uiLengthDrawn;
} DRAWTEXTPARAMS, *LPDRAWTEXTPARAMS;

DrawTextEx関数の拡張フォーマットを格納する構造体。

cbSizeメンバはこの構造体のサイズです。
つまりsizeof(DRAWTEXTPARAMS)の戻り値を指定します。

iTabLengthメンバは文字列中のタブ文字の幅を指定します。
使用するにはDT_EXPANDTABSとDT_TABSTOPフラグを同時に指定します。
ちなみに初期値は8です。
(文字8つ分)

iLeftMarginメンバは左マージン、iRightMarginメンバは右マージンの設定です。
マージンというのは余白のことです。
この数値の単位はピクセル数のようです。
(Microsoft Docsには「平均文字幅」と書かれていますが)

uiLengthDrawnメンバはDrawTextEx関数の実行後に、出力した文字列の文字数が格納されます。

ちなみに拡張フォーマットを使用しない場合はDrawTextEx関数のlpdtpはNULLを指定できます。

#include <windows.h>
#include <strsafe.h>

//ウィンドウの生成等は省略

#define BUFFERSIZE 128

//ウィンドウプロシージャ
LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
	HDC hdc;
	PAINTSTRUCT ps;

	RECT rect;
	DRAWTEXTPARAMS dtp;

	WCHAR buf[BUFFERSIZE];
	static const WCHAR* format = L"クライアント領域のRECT情報\n"
		L"left\t: %ld\n"
		L"top\t: %ld\n"
		L"right\t: %ld\n"
		L"bottom\t: %ld";

	switch (message)
	{
	case WM_PAINT: //ウィンドウの描画発生
		GetClientRect(hWnd, &rect);
		StringCchPrintf(buf, BUFFERSIZE, format,
			rect.left,
			rect.top,
			rect.right,
			rect.bottom);

		dtp.cbSize = sizeof(DRAWTEXTPARAMS);
		dtp.iTabLength = 16;
		dtp.iLeftMargin = 20;
		dtp.iRightMargin = 20;

		hdc = BeginPaint(hWnd, &ps);
		DrawTextEx(hdc, buf, -1, &rect,
			DT_WORDBREAK | DT_EXPANDTABS | DT_TABSTOP,
			&dtp);
		EndPaint(hWnd, &ps);
		break;

	case WM_DESTROY: //ウィンドウの破棄
		PostQuitMessage(0);
		break;

	default:
		return DefWindowProc(hWnd, message, wParam, lParam);
	}
	return 0;
}

タブ文字幅を16に、左右のマージンを20に設定しています。

文字を描画する関数は他にもいくつかありますが、TextOut関数かDrawText(Ex)関数で大抵は対応できます。