継承図

協調図

解説

■ 仕様と使い方

フラットフレームクラスの抽象クラスです。

フラットフレームとは影領域とフラットフレーム領域を枠領域とするフレームです。

	枠領域の取得方法
	フレームの枠領域は、SFYResponder::GetSuitableMargin 関数を呼び出すことで取得できます。

図 309. フラットフレーム動作例

影領域とフラットフレーム領域の和集合が、フラットフレームの枠領域です[SFXMargin(1, 1, 2, 2)]。

図 310. フラットフレーム拡大図

黒色の線が影領域、青色（デフォルトは黒色）の線がフラットフレーム領域です。 この２つの領域の和集合がフラットフレームの枠領域です。そして、枠領域で囲まれた矩形領域はコンテンツ領域です。

影領域、フラットフレーム領域の幅は、それぞれ１ピクセルです。

1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します（影領域の色は SFYPlainFrame::SetShadowColor 関数で設定）。
2. フラットフレーム領域は SFYFlatFrame::DrawFrame 関数が描画します（フラットフレーム領域の色は SFYFlatFrame::SetFrameColor / SFYFlatFrame::SetFocusColor 関数で設定）。

	枠付きのレスポンダ
	フラットフレームをウィンドウやダイアログに装着することで、枠付きウィンドウや枠付きダイアログを実現することが可能になります。 装着はウィンドウやダイアログの SFYResponder::SetFrame 関数を呼び出すことによって行います。 ウィンドウやダイアログの実領域はフラットフレームの枠(マージン領域)で囲まれるコンテンツ領域となります。

参照

SFYFrame | SFYPlainFrame | SFYBevelFrame | SFZFlatFrame | SFZBevelFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | SFXMargin | 実領域 | SFYResponder::GetSuitableMargin | フレーム

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*protected */SFYFlatFrame::SFYFlatFrame(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0x00, 0x00, 0x00}}},
        {{{0x00, 0x00, 0x00, 0x00}}}
    };

    if (static_try()) {
        SetType(CODE_TYPE);
        _color.focus.Set(rgb[0]);
        _color.frame.Set(rgb[1]);
        _frameEnable = true;
    }
}// SFYFlatFrame::SFYFlatFrame //

参照

SFYResponder::SetType | SFYFlatFrame::CodeEnum | SFYFlatFrame::SetFocusColor | SFYFlatFrame::SetFrameColor | SFYFlatFrame::SetFrameEnable | SFXRGBColor | タイプ

解説

このデストラクタは、何も行いません。

内部実装

このデストラクタの内部実装は以下の通りです。

/*protected virtual */SFYFlatFrame::~SFYFlatFrame(Void)
{
}// SFYFlatFrame::~SFYFlatFrame //

戻り値

引数で渡した矩形領域からフラットフレーム領域を取り除いた矩形領域。

解説

この関数は、フラットフレーム領域を描画します。

独自の処理を行う場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

引数で指定された矩形領域のフラットフレーム領域を状態に応じた色で描画し、 引数で指定された矩形領域からフラットフレーム領域を取り除いた矩形領域を返します。

フォーカス状態のときは SFYFlatFrame::SetFocusColor 関数で設定した色、 それ以外の状態のときは SFYFlatFrame::SetFrameColor 関数で設定した色になります。

フラットフレーム領域は SFYFlatFrame::GetFrameMargin 関数で取得できるマージン領域のことです。

	非活性状態にあるときのフラットフレーム領域の色
	非活性状態にあるときは、SFYFlatFrame::SetFrameColor 関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でフラットフレーム領域は描画されます。

図 311. フラットフレーム拡大図

黒色の線が影領域、青色（デフォルトは黒色）の線がフラットフレーム領域です。 この２つの領域の和集合がフラットフレームの枠領域です。そして、枠領域で囲まれた矩形領域はコンテンツ領域です。

影領域、フラットフレーム領域の幅は、それぞれ１ピクセルです。

1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します（影領域の色は SFYPlainFrame::SetShadowColor 関数で設定）。
2. フラットフレーム領域は SFYFlatFrame::DrawFrame 関数が描画します（フラットフレーム領域の色は SFYFlatFrame::SetFrameColor / SFYFlatFrame::SetFocusColor 関数で設定）。

内部実装

この関数の内部実装は以下の通りです。

/*protected */SFXRectangle SFYFlatFrame::DrawFrame(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRGBColor                                 rgb;
    SFXRectangle                                result(rectangle);

    if (_frameEnable) {
        rgb.Set((GetStateFocus(true)) ? (_color.focus) : (_color.frame));
        if (!GetStateActive(true)) {
            if (rgb.GetBrightness() > 0x7F) {
                rgb.SubRGB(0x44);
            }
            else {
                rgb.AddRGB(0x44);
            }
        }
        graphics->DrawRectangle(result, rgb);
        result.Deflate(1, 1);
    }
    return result;
}// SFYFlatFrame::DrawFrame //

参照

SFYFlatFrame::SetFrameColor | SFYFlatFrame::SetFocusColor | SFYFlatFrame::GetFrameMargin | SFXRGBColor | SFXRectangle | 状態

戻り値

フラットフレームがフォーカス状態のときのフラットフレーム領域の色。

解説

この関数は、フラットフレームがフォーカス状態にあるときに描画される枠線の色（SFXRGBColor）を取得します。

	フォーカス状態にあるときの枠線の色
	フラットフレームがフォーカス状態にあるときは、 SFYFlatFrame::SetFocusColor 関数で設定した色でフラットフレーム領域は描画さます。 SFYFlatFrame::SetFrameColor 関数で設定した色でフラットフレーム領域は描画されません。

参照

SFYFlatFrame::SetFocusColor

戻り値

フラットフレーム領域の色。

解説

この関数は、 フレームの枠線を描画する色（SFXRGBColor）を取得します。

	非活性状態にあるときの枠線の色
	非活性状態にあるときの枠線の色は、 SFYFlatFrame::SetFrameColor 関数によって設定された色の明度を基準にして計算された色で枠線は描画されます。 基準となる色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色で枠線は描画されます。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

	フォーカス状態にあるときの枠線の色
	フラットフレームがフォーカス状態にあるときは、 SFYFlatFrame::SetFocusColor 関数で設定した色で枠線は描画さます。 SFYFlatFrame::SetFrameColor 関数で設定した色で枠線は描画されません。

参照

SFYFlatFrame::SetFrameColor

戻り値

解説

この関数は、フレームの有無を取得します。

参照

SFYFlatFrame::SetFrameEnable | SFYFlatFrame::GetFrameMargin

戻り値

フラットフレーム領域のマージン。

解説

この関数は、フラットフレーム領域として設定されているマージン領域を取得します。

フレームが有効な時は SFXMargin(1, 1, 1, 1) （フレームから影領域を除いた四辺）、

フレームが無効な時は SFXMargin::EmptyInstance が返されます。

参照

SFYFlatFrame::DrawFrame | SFXMargin

解説

この関数は、 フラットフレームがフォーカス状態にあるとき、 フラットフレーム領域を描画する色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

	フォーカス状態にあるときのフラットフレーム領域の色
	フォーカス状態にあるときは、 SFYFlatFrame::SetFocusColor 関数で設定した色でフラットフレーム領域は描画さます。 SFYFlatFrame::SetFrameColor 関数で設定した色でフラットフレーム領域は描画されません。

参照

SFYFlatFrame::GetFocusColor | SFYFlatFrame::SetFrameColor | SFYFlatFrame::DrawFrame | SFXRGBColor | 状態

解説

この関数は、フラットフレーム領域を描画する色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

	非活性状態にあるときのフラットフレーム領域の色
	非活性状態にあるときのフラットフレーム領域の色は、 SFYFlatFrame::SetFrameColor 関数によって設定された色の明度を基準にして計算された色になります。 基準となる色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色で枠線は描画されます。 色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

	フォーカス状態にあるときのフラットフレーム領域の色
	フォーカス状態にあるときは、 SFYFlatFrame::SetFocusColor 関数で設定した色でフラットフレーム領域は描画さます。 SFYFlatFrame::SetFrameColor 関数で設定した色でフラットフレーム領域は描画されません。

参照

SFYFlatFrame::GetFrameColor | SFYFlatFrame::SetFocusColor | SFYFlatFrame::DrawFrame | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、フレームの有無を設定します。

参照

SFYFlatFrame::GetFrameEnable | SFYFlatFrame::GetFrameMargin

参照

SFYResponder::GetType | SFYResponder::SetType