CStatusBar クラス

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

テキスト出力用のペインまたは "インジケーター" の行を持つコントロールバーです。

構文

class CStatusBar : public CControlBar

メンバー

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

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

パブリックメソッド

名前	説明
CStatusBar::CommandToIndex	指定されたインジケーター ID のインデックスを取得します。
CStatusBar::Create	ステータスバーを作成し、 `CStatusBar` オブジェクトにアタッチし、初期フォントとバーの高さを設定します。
CStatusBar::CreateEx	埋め込み`CStatusBarCtrl` オブジェクトの追加のスタイルを持つ`CStatusBar` オブジェクトを作成します。
CStatusBar::D rawItem	所有者描画ステータスバーコントロールの視覚的な側面が変更されたときに呼び出されます。
CStatusBar::GetItemID	特定のインデックスのインジケーター ID を取得します。
CStatusBar::GetItemRect	指定したインデックスの表示四角形を取得します。
CStatusBar::GetPaneInfo	特定のインデックスのインジケーター ID、スタイル、および幅を取得します。
CStatusBar::GetPaneStyle	特定のインデックスのインジケータースタイルを取得します。
CStatusBar::GetPaneText	特定のインデックスのインジケーターテキストを取得します。
CStatusBar::GetStatusBarCtrl	基になる共通コントロールへの直接アクセスを許可します。
CStatusBar::SetIndicators	インジケーター ID を設定します。
CStatusBar::SetPaneInfo	指定したインデックスのインジケーター ID、スタイル、および幅を設定します。
CStatusBar::SetPaneStyle	特定のインデックスのインジケータースタイルを設定します。
CStatusBar::SetPaneText	特定のインデックスのインジケーターテキストを設定します。

解説

出力ペインは、通常、メッセージ行およびステータスインジケーターとして使用されます。たとえば、選択したメニューコマンドを簡単に説明するメニューヘルプメッセージ行や、SCROLL LOCK、NUM LOCK、その他のキーの状態を示すインジケーターなどがあります。

MFC 4.0 に新しく追加されたメンバー関数 CStatusBar::GetStatusBarCtrl を使用すると、ステータスバーのカスタマイズと追加機能に対する Windows コモンコントロールのサポートを利用できます。 CStatusBar メンバー関数は、Windows 共通コントロールのほとんどの機能を提供します。ただし、 GetStatusBarCtrlを呼び出すと、ステータスバーに Windows 95/98 ステータスバーの特性をさらに追加できます。 GetStatusBarCtrl を呼び出す場合は、CStatusBarCtrl オブジェクトへの参照が返されます。 Windows 共通コントロールを使用したツールバーの設計の詳細については、「 CStatusBarCtrl を参照してください。一般的なコントロールの詳細については、Windows SDK の「 Common Controls 」を参照してください。

フレームワークは、左端のインジケーターが位置 0 の配列にインジケーター情報を格納します。ステータスバーを作成するときは、フレームワークが対応するインジケーターに関連付ける文字列 ID の配列を使用します。その後、文字列 ID またはインデックスを使用してインジケーターにアクセスできます。

既定では、最初のインジケーターは "エラスティック" です。他のインジケーターウィンドウでは使用されていないステータスバーの長さが使用されるため、他のペインは右揃えになります。

ステータスバーを作成するには、次の手順に従います。

CStatusBar オブジェクトを構築します。
Create (または CreateEx) 関数を呼び出して、ステータスバーウィンドウを作成し、CStatusBar オブジェクトにアタッチします。
SetIndicators を呼び出して、各インジケーターに文字列 ID を関連付けます。

ステータスバーウィンドウでテキストを更新するには、次の 3 つの方法があります。

CWnd::SetWindowText を呼び出して、ペイン 0 内のテキストのみを更新します。
ステータスバーのON_UPDATE_COMMAND_UI ハンドラーで CCmdUI::SetText を呼び出します。
SetPaneText を呼び出して、任意のペインのテキストを更新します。

SetPaneStyle を呼び出して、ステータスバーウィンドウのスタイルを更新します。

CStatusBarの使用方法の詳細については、「MFC でのStatus Bar の実装およびテクニカルノート 31: コントロールバー」を参照してください。

継承階層

CStatusBar

要件

Header: afxext.h

CStatusBar::CommandToIndex

指定された ID のインジケーターインデックスを取得します。

int CommandToIndex(UINT nIDFind) const;

パラメーター

nIDFind
インデックスを取得するインジケーターの文字列 ID。

戻り値

成功した場合のインジケーターのインデックス。成功しなかった場合は -1。

解説

最初のインジケーターのインデックスは 0 です。

CStatusBar::Create

ステータスバー (子ウィンドウ) を作成し、 CStatusBar オブジェクトに関連付けます。

virtual BOOL Create(
    CWnd* pParentWnd,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_BOTTOM,
    UINT nID = AFX_IDW_STATUS_BAR);

パラメーター

pParentWnd
Windows ウィンドウがステータスバーの親である CWnd オブジェクトへのポインター。

dwStyle
ステータスバーのスタイル。標準の Windows stylesに加えて、これらのスタイルがサポートされています。

CBRS_TOPコントロールバーはフレームウィンドウの上部にあります。
CBRS_BOTTOMコントロールバーはフレームウィンドウの下部にあります。
CBRS_NOALIGNコントロールバーは、親のサイズを変更しても再配置されません。

nID
ツールバーの子ウィンドウ ID。

戻り値

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

解説

また、初期フォントを設定し、ステータスバーの高さを既定値に設定します。

CStatusBar::CreateEx

この関数を呼び出してステータスバー (子ウィンドウ) を作成し、 CStatusBar オブジェクトに関連付けます。

virtual BOOL CreateEx(
    CWnd* pParentWnd,
    DWORD dwCtrlStyle = 0,
    DWORD dwStyle = WS_CHILD | WS_VISIBLE | CBRS_BOTTOM,
    UINT nID = AFX_IDW_STATUS_BAR);

パラメーター

pParentWnd
Windows ウィンドウがステータスバーの親である CWnd オブジェクトへのポインター。

dwCtrlStyle
埋め込み CStatusBarCtrl オブジェクトを作成するための追加のスタイル。既定では、サイズ変更グリップまたはツールヒントがサポートされていないステータスバーを指定します。サポートされているステータスバーのスタイルは次のとおりです。

SBARS_SIZEGRIP ステータスバーコントロールには、ステータスバーの右端にサイズ変更グリップが含まれています。サイズ変更グリップは、サイズ変更境界線に似ています。これは、ユーザーがクリックしてドラッグして親ウィンドウのサイズを変更できる四角形の領域です。
SBT_TOOLTIPS ステータスバーはツールヒントをサポートします。

これらのスタイルの詳細については、「CStatusBarCtrl の Settingsを参照してください。

dwStyle
ステータスバーのスタイル。既定値は、フレームウィンドウの下部に表示されるステータスバーを作成することを指定します。 Window スタイルと CDialogBar::Create に一覧表示されているステータスバーコントロールスタイルの任意の組み合わせを適用します。ただし、このパラメーターには常にWS_CHILDスタイルとWS_VISIBLEスタイルを含める必要があります。

nID
ステータスバーの子ウィンドウ ID。

戻り値

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

解説

この関数は、初期フォントも設定し、ステータスバーの高さを既定値に設定します。

埋め込みステータスバーコントロールの作成時に特定のスタイルが存在する必要がある場合は、Create の代わりに、CreateExを使用します。たとえば、 dwCtrlStyle をSBT_TOOLTIPSに設定して、ステータスバーオブジェクトにヒントを表示します。

CStatusBar::CStatusBar

CStatusBar オブジェクトを作成し、必要に応じて既定のステータスバーフォントを作成し、フォントの特性を既定値に設定します。

CStatusBar();

CStatusBar::D rawItem

このメンバー関数は、所有者が描画したステータスバーの視覚的な側面が変わると、フレームワークによって呼び出されます。

virtual void DrawItem(LPDRAWITEMSTRUCT lpDrawItemStruct);

パラメーター

lpDrawItemStruct
必要な描画の種類に関する情報を含む DRAWITEMSTRUCT 構造体へのポインター。

解説

DRAWITEMSTRUCT構造体のitemAction メンバーは、実行する描画アクションを定義します。このメンバー関数をオーバーライドして、所有者描画 CStatusBar オブジェクトの描画を実装します。アプリケーションは、このメンバー関数が終了する前に、 lpDrawItemStruct で指定された表示コンテキストに対して選択されているすべてのグラフィックスデバイスインターフェイス (GDI) オブジェクトを復元する必要があります。

CStatusBar::GetItemID

nIndex で指定されたインジケーターの ID を返します。

UINT GetItemID(int nIndex) const;

パラメーター

nIndex
ID が取得されるインジケーターのインデックス。

戻り値

nIndex で指定されたインジケーターの ID。

CStatusBar::GetItemRect

nIndex で指定されたインジケーターの座標を、lpRect が指す構造体にコピーします。

void GetItemRect(
    int nIndex,
    LPRECT lpRect) const;

パラメーター

nIndex
四角形の座標を取得するインジケーターのインデックス。

lpRect
RECT構造体またはCRect オブジェクトを指します。このオブジェクトは、nIndex で指定されたインジケーターの座標を受け取ります。

解説

座標は、ステータスバーの左上隅を基準としたピクセル単位です。

CStatusBar::GetPaneInfo

nID、nStyle、および cxWidth を、nIndex で指定された位置にあるインジケーターウィンドウの ID、スタイル、および幅に設定します。

void GetPaneInfo(
    int nIndex,
    UINT& nID,
    UINT& nStyle,
    int& cxWidth) const;

パラメーター

nIndex
情報を取得するペインのインデックス。

nID
ウィンドウの ID に設定されている UINT への参照。

nStyle
ウィンドウのスタイルに設定されている UINT への参照。

cxWidth
ウィンドウの幅に設定されている整数への参照。

CStatusBar::GetPaneStyle

ステータスバーのウィンドウのスタイルを取得するには、このメンバー関数を呼び出します。

UINT GetPaneStyle(int nIndex) const;

パラメーター

nIndex
スタイルを取得するペインのインデックス。

戻り値

nIndex で指定されたステータスバーウィンドウのスタイル。

解説

ペインのスタイルによって、ペインの表示方法が決まります。

ステータスバーで使用できるスタイルの一覧については、「 Create」を参照してください。

CStatusBar::GetPaneText

このメンバー関数を呼び出して、ステータスバーウィンドウに表示されるテキストを取得します。

CString GetPaneText(int nIndex) const;  void GetPaneText(int nIndex, CString& rString) const;

パラメーター

nIndex
テキストを取得するペインのインデックス。

rString
取得するテキストを含む CString オブジェクトへの参照。

戻り値

ウィンドウのテキストを含む CString オブジェクト。

解説

このメンバー関数の 2 番目の形式は、 CString オブジェクトに文字列テキストを入力します。

CStatusBar::GetStatusBarCtrl

このメンバー関数を使用すると、基になる共通コントロールに直接アクセスできます。

CStatusBarCtrl& GetStatusBarCtrl() const;

戻り値

CStatusBarCtrl オブジェクトへの参照を格納します。

解説

GetStatusBarCtrlを使用して、Windows ステータスバーの共通コントロールの機能を利用し、ステータスバーのカスタマイズCStatusBarCtrl サポートを利用します。たとえば、共通コントロールを使用して、ステータスバーにサイズ変更グリップを含むスタイルを指定したり、ステータスバーを親ウィンドウのクライアント領域の上部に表示するスタイルを指定したりできます。

一般的なコントロールの詳細については、Windows SDK の「 Common コントロール」を参照してください。

CStatusBar::SetIndicators

各インジケーターの ID を配列の対応する要素 lpIDArrayで指定された値に設定し、各 ID で指定された文字列リソースを読み込み、インジケーターのテキストを文字列に設定します。

BOOL SetIndicators(
    const UINT* lpIDArray,
    int nIDCount);

パラメーター

lpIDArray
ID の配列へのポインター。

nIDCount
lpIDArray が指す配列内の要素の数。

戻り値

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

CStatusBar::SetPaneInfo

指定したインジケーターウィンドウを新しい ID、スタイル、幅に設定します。

void SetPaneInfo(
    int nIndex,
    UINT nID,
    UINT nStyle,
    int cxWidth);

パラメーター

nIndex
スタイルを設定するインジケーターウィンドウのインデックス。

nID
インジケーターウィンドウの新しい ID。

nStyle
インジケーターウィンドウの新しいスタイル。

cxWidth
インジケーターウィンドウの新しい幅。

解説

次のインジケータースタイルがサポートされています。

SBPS_NOBORDERSウィンドウの周囲に 3-D 罫線がありません。
[逆引き] 罫線をSBPS_POPOUTして、テキストが "ポップアウト" されるようにします。
SBPS_DISABLED テキストを描画しません。
[Stretch]\(ストレッチ\) ウィンドウをSBPS_STRETCHして、未使用の領域を塗りつぶします。このスタイルを使用できるのは、ステータスバーごとに 1 つのペインのみです。
SBPS_NORMAL ストレッチ、罫線、またはポップアウトなし。

CStatusBar::SetPaneStyle

ステータスバーのウィンドウのスタイルを設定するには、このメンバー関数を呼び出します。

void SetPaneStyle(
    int nIndex,
    UINT nStyle);

パラメーター

nIndex
スタイルを設定するペインのインデックス。

nStyle
スタイルを設定するペインのスタイル。

解説

ペインのスタイルによって、ペインの表示方法が決まります。

ステータスバーで使用できるスタイルの一覧については、「 SetPaneInfoを参照してください。

CStatusBar::SetPaneText

このメンバー関数を呼び出して、ウィンドウテキストを lpszNewText が指す文字列に設定します。

BOOL SetPaneText(
    int nIndex,
    LPCTSTR lpszNewText,
    BOOL bUpdate = TRUE);

パラメーター

nIndex
テキストを設定するペインのインデックス。

lpszNewText
新しいペインテキストへのポインター。

bUpdate
TRUE の場合、テキストが設定された後、ペインは無効になります。

戻り値

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

解説

SetPaneTextを呼び出した後、ステータスバーに新しいテキストを表示する UI 更新ハンドラーを追加する必要があります。

例

//Sets and displays text for pane index 3 and id ID_INDICATOR_SCRL
m_wndStatusBar.SetPaneText(3, _T("My New Status Bar Text"), TRUE);

//UI handler in the message map updates the status bar text:
ON_UPDATE_COMMAND_UI(ID_INDICATOR_SCRL, &CMainFrame::OnUpdatePane)

void CMainFrame::OnUpdatePane(CCmdUI* pCmdUI)
{
   pCmdUI->Enable();
}

次の方法で共有

CStatusBar クラス

構文

メンバー

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

パブリック メソッド

解説

継承階層

要件

CStatusBar::CommandToIndex

パラメーター

戻り値

解説

CStatusBar::Create

パラメーター

戻り値

解説

CStatusBar::CreateEx

パラメーター

戻り値

解説

CStatusBar::CStatusBar

CStatusBar::D rawItem

パラメーター

解説

CStatusBar::GetItemID

パラメーター

戻り値

CStatusBar::GetItemRect

パラメーター

解説

CStatusBar::GetPaneInfo

パラメーター

CStatusBar::GetPaneStyle

パラメーター

戻り値

解説

CStatusBar::GetPaneText

パラメーター

戻り値

解説

CStatusBar::GetStatusBarCtrl

戻り値

解説

CStatusBar::SetIndicators

パラメーター

戻り値

CStatusBar::SetPaneInfo

パラメーター

解説

CStatusBar::SetPaneStyle

パラメーター

解説

CStatusBar::SetPaneText

パラメーター

戻り値

解説

例

関連項目

フィードバック

その他のリソース

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

パブリックメソッド