継承図

協調図

解説

■ 仕様と使い方

コントロールは、コンテナ内に配置されるように設計されたレスポンダです。

SFYControl は、各種コントロールを実装するための起点（基底クラス）となります。

すべてのコントロールは SFYControl クラスを継承し、 最大値、最小値、現在値をプロパティとして保持しています。

	注意
	最大値、最小値、現在値が表す内容は、コントロールの種類により異なります。 必ずしも『最小値 ≦ 現在値 ≦ 最大値』ではないことに注意してください。 例えば、SFYTabControl では、 最小値は常に 0 であり、タブページが存在しない場合、現在値と最大値は -1 です。

■ イベントとハンドラ

SFYControl を継承するレスポンダでは、 SFYControl::SFYControl / SFYWidget::SFYWidget コンストラクタで登録されたハンドラの処理により、 下記のイベントを受信すると、対応する下記の仮想関数（ハンドラ）が最初に呼び出されます。 その後、開発者がレスポンダに登録したハンドラが呼び出されることになります。

	注意
	ハンドラの詳細については、 SFYControl::SFYControl / SFYWidget::SFYWidget コンストラクタの解説を参照してください。

	Tip
	ハンドラを登録する手間を省略できるので、 通常、これらのイベント処理は仮想関数をオーバーライドして記述します。

※デフォルトの動作にある "−" は何も実装していないことを表す。

	注釈
	※1. SFYResponder::SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize())) を実行します。つまり、仮想領域を実領域に一致させます。

ユーザー定義コントロールを作成するときに最低限必要なコードを示します。

SFMTYPEDEFRESPONDER(USRControl)
class USRControl : public SFYControl {
    SFMSEALRESPONDER(USRControl)
    SFMRESPONDERINSTANTIATETHREE(USRControl, SFYControl, SFYWidget, SFYResponder)
public:

    // レスポンダのタイプを定義する
    // 小文字と記号のみからなるタイプは予約されているので使えない
    enum CodeEnum {
        CODE_TYPE = four_char_code('U', 'C', 'N', 'T')
    };
    SFMTYPEDEFTYPE(CodeEnum)

public:
    static USRControlSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit USRControl(Void) static_throws;
    virtual ~USRControl(Void);

    // 親クラスで定義されている仮想関数のうち、実装が推奨される仮想関数
    virtual Void HandleBoundRequest(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundOptimize(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundVirtual(Void);
    virtual Void HandleRenderRequest(SFXGraphicsPtr graphics) const;
};

USRControl::USRControl(Void) static_throws
{
    if (static_try()) {

        // レスポンダのタイプを設定する
        SetType(CODE_TYPE);

        // 初期化処理を記述する
    }
}

USRControl::~USRControl(Void)
{
    // 終了処理を記述する
}

USRControlSmp USRControl::NewInstance(SFCErrorPtr exception)
{
    return static_pointer_cast<USRControl>(Factory(::new USRControl, exception));
}

Void USRControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // コントロールに最適な大きさを計算して rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // コントロールに最適な大きさを rectangle パラメータ内の大きさに
    // 収まるように計算し、rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRControl::HandleBoundVirtual(Void)
{
    // 仮想領域が変更された場合に再計算が必要なものがあれば、ここに記述する
    return;
}

Void USRControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // コントロールを描画する
    return;
}

参照

SFYControl::SFYControl | SFYWidget::SFYWidget | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | コントロール（基礎編）

メンバ

解説

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

内部実装

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

/*protected */SFYControl::SFYControl(Void) static_throws
{
    if (static_try()) {
        SetType(CODE_TYPE);
        _maximum = 0;
        _minimum = 0;
        _current = 0;
    }
}// SFYControl::SFYControl //

参照

SFYResponder::SetType | SFYControl::CodeEnum | SFYControl::SetMaximumValue | SFYControl::SetMinimumValue | SFYControl::SetCurrentValue | タイプ

解説

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

内部実装

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

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

戻り値

コントロールの現在値。

解説

この関数は、コントロールの現在値を取得します。

内部実装

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

/*public */inline SInt32 SFYControl::GetCurrentValue(Void) const
{
    return _current;
}// SFYControl::GetCurrentValue //

参照

SFYControl::SetCurrentValue

戻り値

コントロールの最大値。

解説

この関数は、コントロールの最大値を取得します。

内部実装

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

/*public */inline SInt32 SFYControl::GetMaximumValue(Void) const
{
    return _maximum;
}// SFYControl::GetMaximumValue //

参照

SFYControl::SetMaximumValue

戻り値

コントロールの最小値。

解説

この関数は、コントロールの最小値を取得します。

内部実装

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

/*public */inline SInt32 SFYControl::GetMinimumValue(Void) const
{
    return _minimum;
}// SFYControl::GetMinimumValue //

参照

SFYControl::SetMinimumValue

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] を受信したときに呼び出されます。

実領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、仮想領域を実領域に一致させます。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント]
	SFYResponder::SetRealBound 関数は、この関数内の処理により実領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundReal 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の実領域が設定されています。

	実領域が変化した時の処理
	SFYWidget::HandleBoundReal 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 実領域の変更処理は、最初に SFYWidget::HandleBoundReal 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。

内部実装

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

/*protected virtual */Void SFYControl::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFYControl::HandleBoundReal //

参照

SFYResponder::SetRealBound | 実領域 | 仮想領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、 指定された値がこのコントロールに現在設定されている現在値と異なる場合、 その値を新しい現在値として設定します。

同時に、自分自身に 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, "設定した現在値")] を送信します。

すでに設定されている最大値や最小値の範囲外の値でもそのまま設定されます。

デフォルト値: 0

	注意
	指定された値がこのコントロールに設定されている現在値と同じ場合は何も起こりません。

内部実装

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

/*public */Void SFYControl::SetCurrentValue(SInt32 param)
{
    if (param != _current) {
        _current = param;
        Invalidate();
        InvokeBackward(SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_CURRENT, _current), true);
    }
    return;
}// SFYControl::SetCurrentValue //

参照

SFYControl::GetCurrentValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFXEvent | イベント | 値イベント[SFEVT_RESPONDER_VALUE]

解説

この関数は、指定された値がこのコントロールに現在設定されている最大値と異なる場合、 その値をこのコントロールの最大値として設定します。

同時に、自分自身に 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_MAXIMUM, "設定した最大値")] を送信します。

すでに設定されている最小値や現在値が引数で指定される最大値よりも大きい場合でもそのまま設定されます。

デフォルト値: 0

	注意
	指定された値がこのコントロールに設定されている最大値と同じ場合は何も起こりません。

内部実装

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

/*public */Void SFYControl::SetMaximumValue(SInt32 param)
{
    if (param != _maximum) {
        _maximum = param;
        Invalidate();
        InvokeBackward(SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_MAXIMUM, _maximum), true);
    }
    return;
}// SFYControl::SetMaximumValue //

参照

SFYControl::GetMaximumValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFXEvent | イベント | 値イベント[SFEVT_RESPONDER_VALUE]

解説

この関数は、指定された値がこのコントロールに現在設定されている最小値と異なる場合、その値をこのコントロールの最小値として設定します。

同時に、自分自身に 値イベント [SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_MINIMUM, "設定した最小値")] を送信します。

すでに設定されている最大値や現在値が引数で指定される最小値よりも小さい場合でもそのまま設定されます。

デフォルト値: 0

	注意
	指定された値がこのコントロールに設定されている最小値と同じ場合は何も起こりません。

内部実装

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

/*public */Void SFYControl::SetMinimumValue(SInt32 param)
{
    if (param != _minimum) {
        _minimum = param;
        Invalidate();
        InvokeBackward(SFXEvent(SFEVT_RESPONDER_VALUE, SFP16_VALUE_MINIMUM, _minimum), true);
    }
    return;
}// SFYControl::SetMinimumValue //

参照

SFYControl::GetMinimumValue | SFYControl::SetMaximumValue | SFYControl::SetCurrentValue | SFXEvent | イベント | 値イベント[SFEVT_RESPONDER_VALUE]

参照

SFYResponder::GetType | SFYResponder::SetType