CMFCRibbonStatusBarPane クラス
CMFCRibbonStatusBarPane
クラスは、リボン ステータス バーに追加できるリボン要素を実装します。
構文
class CMFCRibbonStatusBarPane : public CMFCRibbonButton
メンバー
パブリック コンストラクター
名前 | 説明 |
---|---|
CMFCRibbonStatusBarPane::CMFCRibbonStatusBarPane | CMFCRibbonStatusBarPane オブジェクトを構築して初期化します。 |
パブリック メソッド
名前 | 説明 |
---|---|
CMFCRibbonStatusBarPane::GetAlmostLargeText | 切り捨てなしでペインに表示できる最長のテキスト文字列を定義する文字列を返します。 |
CMFCRibbonStatusBarPane::GetTextAlign | テキストの配置の現在の設定を返します。 |
CMFCRibbonStatusBarPane::IsAnimation | アニメーションが進行中かどうかを判断します。 |
CMFCRibbonStatusBarPane::IsExtended | ウィンドウがリボンのステータス バーの拡張領域に配置されているかどうかを確認します。 |
CMFCRibbonStatusBarPane::OnDrawBorder | ( をオーバーライドしますCMFCRibbonButton::OnDrawBorder.) |
CMFCRibbonStatusBarPane::OnFillBackground | ( をオーバーライドしますCMFCRibbonButton::OnFillBackground.) |
CMFCRibbonStatusBarPane::SetAlmostLargeText | 切り捨てなしでペインに表示できる最長のテキスト文字列を定義します。 |
CMFCRibbonStatusBarPane::SetAnimationList | アニメーションに使用できるイメージ リストをペインに割り当てます。 |
CMFCRibbonStatusBarPane::SetTextAlign | テキストの配置を設定します。 |
CMFCRibbonStatusBarPane::StartAnimation | ペインに割り当てられているアニメーションを開始します。 |
CMFCRibbonStatusBarPane::StopAnimation | ペインに割り当てられているアニメーションを停止します。 . |
保護メソッド
名前 | 説明 |
---|---|
CMFCRibbonStatusBarPane::OnFinishAnimation | ウィンドウに割り当てられているアニメーションが停止すると、フレームワークによって呼び出されます。 |
例
次の例は、CMFCRibbonStatusBarPane
クラスのさまざまなメソッドの使用方法を説明しています。 この例では、 CMFCRibbonStatusBarPane
オブジェクトの構築、ステータス バー ウィンドウのラベルのテキスト配置の設定、切り捨てなしでステータス バー ウィンドウに表示できる最長のテキストの定義、ステータス バー ウィンドウへのアニメーションに使用できるイメージ リストのアタッチ、アニメーションの開始を行う方法を示します。
CString strTitlePane1;
CString strTitlePane2;
strTitlePane1.LoadString(IDS_STATUS_PANE1);
strTitlePane2.LoadString(IDS_STATUS_PANE2);
CMFCRibbonStatusBarPane* rsbp = new CMFCRibbonStatusBarPane( ID_STATUSBAR_PANE1, strTitlePane1, TRUE );
rsbp->SetTextAlign( TA_CENTER );
rsbp->SetAlmostLargeText( _T( "Status bar" ) );
CBitmap bitmap;
bitmap.LoadBitmapW( IDB_FILESMALL );
rsbp->SetAnimationList( (HBITMAP)bitmap );
rsbp->StartAnimation();
継承階層
要件
Header: afxribbonstatusbarpane.h
CMFCRibbonStatusBarPane::CMFCRibbonStatusBarPane
ステータス バーでペイン オブジェクトを作成します。
CMFCRibbonStatusBarPane(
UINT nCmdID,
LPCTSTR lpszText,
BOOL bIsStatic=FALSE,
HICON hIcon=NULL,
LPCTSTR lpszAlmostLargeText=NULL);
CMFCRibbonStatusBarPane(
UINT nCmdID,
LPCTSTR lpszText,
HBITMAP hBmpAnimationList,
int cxAnimation=16,
COLORREF clrTrnsp=RGB(192,192 1,192) 1,
HICON hIcon=NULL,
BOOL bIsStatic=FALSE);
CMFCRibbonStatusBarPane(
UINT nCmdID,
LPCTSTR lpszText,
UINT uiAnimationListResID,
int cxAnimation=16,
COLORREF clrTrnsp=RGB(192, 192 1, 192) 1,
HICON hIcon=NULL,
BOOL bIsStatic=FALSE);
パラメーター
nCmdID
[in]ペインのコマンド ID を指定します。
lpszText
[in]ペインに表示するテキスト文字列を指定します。
bIsStatic
[in]TRUE の場合、状態ウィンドウをクリックして強調表示または選択することはできません。
hIcon
[in]ウィンドウに表示するアイコンのハンドルを指定します。
lpszAlmostLargeText
[in]ウィンドウで表示できる最長のテキスト文字列を指定します。
hBmpAnimationList
[in]アニメーションに使用されるイメージ リストのハンドルを指定します。
cxAnimation
[in]アニメーションに使用されるイメージ リスト内のアイコンの幅をピクセル単位で指定します。
clrTrnsp
[in]アニメーションに使用するイメージ リスト内のイメージの透明な色を指定します。
uiAnimationListResID
[in]アニメーションに使用されるイメージ リストのリソース ID を指定します。
CMFCRibbonStatusBarPane::GetAlmostLargeText
ステータス バー ウィンドウに表示できる最長のテキスト文字列を取得します。
LPCTSTR GetAlmostLargeText() const;
戻り値
ステータス バー ウィンドウに表示できる最も長いテキスト文字列。
CMFCRibbonStatusBarPane::GetTextAlign
ステータス バー ウィンドウのラベルのテキスト配置の現在の設定を取得します。
int GetTextAlign() const;
戻り値
現在のテキストの配置は、次のいずれかになります。
TA_LEFT
TA_CENTER
TA_RIGHT。
CMFCRibbonStatusBarPane::IsAnimation
アニメーションが進行中かどうかを判断します。
BOOL IsAnimation() const;
戻り値
アニメーションが進行中の場合は TRUE。それ以外の場合は FALSE。
CMFCRibbonStatusBarPane::IsExtended
ウィンドウがリボン ステータス バーの拡張領域に配置されているかどうかを確認します。
BOOL IsExtended() const;
戻り値
ペインがステータス バーの拡張領域にある場合は TRUE。 それ以外の場合は FALSE。
CMFCRibbonStatusBarPane::OnDrawBorder
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
virtual void OnDrawBorder(CDC*);
パラメーター
[入力] CDC*
解説
CMFCRibbonStatusBarPane::OnFillBackground
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
virtual COLORREF OnFillBackground(CDC* pDC);
パラメーター
[入力] pDC
戻り値
解説
CMFCRibbonStatusBarPane::OnFinishAnimation
フレームワークは、ペインに割り当てられているアニメーションが終了したときに、このメソッドを呼び出します。
virtual void OnFinishAnimation();
解説
StopAnimation
メソッドは OnFinishAnimation
メソッドを呼び出します。このメソッドを使用すると、アニメーションの終了時にデータをクリーンアップできます。
CMFCRibbonStatusBarPane::SetAlmostLargeText
切り捨てなしでステータス バー ウィンドウに表示できる最長のテキストを定義します。
void SetAlmostLargeText(LPCTSTR lpszAlmostLargeText);
パラメーター
lpszAlmostLargeText
[in]切り捨てなしでステータス バー ウィンドウに表示できる最長の文字列を指定します。
解説
ライブラリは、 lpszAlmostLargeText が指定するテキストのサイズを計算し、それに応じてウィンドウのサイズを変更します。 ウィンドウに収まらない場合、テキストは切り捨てられます。
CMFCRibbonStatusBarPane::SetAnimationList
アニメーションに使用できるイメージ リストをステータス バー ウィンドウにアタッチします。
void SetAnimationList(
HBITMAP hBmpAnimationList,
int cxAnimation=16,
COLORREF clrTransp=RGB(192, 192 1, 192) 1);
BOOL SetAnimationList(
UINT uiAnimationListResID,
int cxAnimation=16,
COLORREF clrTransp=RGB(192, 192 1, 192) 1);
パラメーター
hBmpAnimationList
[in]イメージ リストへのハンドルを指定します。
cxAnimation
[in]イメージ リスト内のフレームの幅をピクセル単位で指定します。
clrTransp
[in]イメージ リストの透明な色を指定します。
uiAnimationListResID
[in]イメージ リストのリソース ID を指定します。
戻り値
イメージの一覧がステータス バー ウィンドウに正常にアタッチされている場合は TRUE。それ以外の場合は FALSE。
CMFCRibbonStatusBarPane::SetTextAlign
ステータス バー ウィンドウのラベルのテキストの配置を設定します。
void SetTextAlign(int nAlign);
パラメーター
nAlign
[in]テキストの配置を指定します。
解説
nAlign には、次のいずれかの値を指定できます。
TA_LEFT: 左揃え
TA_CENTER: 中央揃え
TA_RIGHT: 右揃え
CMFCRibbonStatusBarPane::StartAnimation
ペインに割り当てるアニメーションを開始します。
void StartAnimation(
UINT nFrameDelay=500,
UINT nDuration=-1);
パラメーター
nFrameDelay
[in]アニメーション フレーム レートをミリ秒単位で指定します。
nDuration
[in]アニメーションを再生する時間をミリ秒単位で指定します。 無限ループには -1 を使用します。
解説
SetAnimationList
を使用してStartAnimation
を呼び出す前に、イメージ リストのハンドルを指定する必要があります。
CMFCRibbonStatusBarPane::StopAnimation
ステータス バー ウィンドウに割り当てたアニメーションを停止します。
void StopAnimation();