SFUMargin

マージンを表すクラスです。

#include <SFUMargin.hpp>

class SFUMargin;

typedef SFUMargin&          SFUMarginRef;
typedef SFUMargin*          SFUMarginPtr;
typedef SFUMargin**         SFUMarginHandle;
typedef const SFUMargin     ConstSFUMargin;
typedef const SFUMargin&    ConstSFUMarginRef;
typedef const SFUMargin*    ConstSFUMarginPtr;
typedef const SFUMargin**   ConstSFUMarginHandle;

解説

SFUMargin はマージンを表すクラスです。左マージン、上マージン、右マージン、下マージンの 4 つの変数を持ちます。

メンバ

コンストラクタ/デストラクタ
public	SFUMargin	SFUMargin のコンストラクタです。
public	~SFUMargin	SFUMargin クラスのデストラクタです。

パブリック変数
public	b	下のマージンです。
public	l	左のマージンです。
public	r	右のマージンです。
public	t	上のマージンです。

パブリック関数
public	Equal	4 つのマージンが等しいか比較します。
public	Set	マージンを設定します。
public	operator+	マージンを加算します。
public	operator-	マージンを減算します。
public	operator==	4 つのマージンが等しいか判定します。

SFUMargin::SFUMargin

SFUMargin のコンストラクタです。

[ public ]
SFUMargin(Void);

[ public ]
SFUMargin(
    SInt16 left     // 左のマージン
    SInt16 top      // 上のマージン
    SInt16 right    // 右のマージン
    SInt16 bottom   // 下のマージン
);

[ public ]
SFUMargin(
    SInt16 left                    // 左のマージン
    SInt16 top                     // 上のマージン
    ConstSFUSizeRef right_bottom   // 右と下のマージン
);

[ public ]
SFUMargin(
    ConstSFUSizeRef left_top   // 左と上のマージン
    SInt16 right               // 右のマージン
    SInt16 bottom              // 下のマージン
);

[ public ]
SFUMargin(
    ConstSFUSizeRef left_top       // 左と上のマージン
    ConstSFUSizeRef right_bottom   // 右と下のマージン
);

SFUMargin::~SFUMargin

SFUMargin クラスのデストラクタです。

[ public ]
~SFUMargin(Void);

SFUMargin::Equal

4 つのマージンが等しいか比較します。

[ public, const ]
Bool Equal(
    ConstSFUMarginRef margin   // 比較対象となるマージン
);

戻り値

2 つのマージンの上下左右がすべて等しい値の場合にのみ TRUE を返します。それ以外の場合は FALSE を返します。

参照

SFUMargin::operator==

SFUMargin::Set

マージンを設定します。

[ public ]
SFUMarginRef Set(
    SInt16 left     // 左のマージン
    SInt16 top      // 上のマージン
    SInt16 right    // 右のマージン
    SInt16 bottom   // 下のマージン
);

[ public ]
SFUMarginRef Set(
    SInt16 left                    // 左のマージン
    SInt16 top                     // 上のマージン
    ConstSFUSizeRef right_bottom   // 右と下のマージン
);

[ public ]
SFUMarginRef Set(
    ConstSFUSizeRef left_top   // 左と上のマージン
    SInt16 right               // 右のマージン
    SInt16 bottom              // 下のマージン
);

[ public ]
SFUMarginRef Set(
    ConstSFUSizeRef left_top       // 左と上のマージン
    ConstSFUSizeRef right_bottom   // 右と下のマージン
);

戻り値

自分自身を返します。

参照

SFUMargin::SFUMargin

SFUMargin::operator==

4 つのマージンが等しいか判定します。

[ public, friend ]
Bool operator==(
    ConstSFUMarginRef margin1   
    ConstSFUMarginRef margin2   
);

[ public, friend ]
Bool operator!=(
    ConstSFUMarginRef margin1r0   
    ConstSFUMarginRef margin2     
);

戻り値

2 つのマージンの上下左右がすべて等しい値の場合にのみ TRUE を返します。それ以外の場合は FALSE を返します。

参照

SFUMargin::Equal

SFUMargin::operator-

マージンを減算します。

[ public, friend ]
SFUMargin operator-(
    ConstSFUMarginRef margin   
);

[ public, friend ]
SFUMargin operator-(
    ConstSFUMarginRef margin1   
    ConstSFUMarginRef margin2   
);

[ public ]
SFUMarginRef operator-=(
    ConstSFUMarginRef margin   
);

解説

SFUMargin から SFUMargin を減算すると、それぞれの上下左右のマージンを減算した SFUMargin を返します。

参照

SFUMargin::operator+

SFUMargin::operator+

マージンを加算します。

[ public, friend ]
SFUMargin operator+(
    ConstSFUMarginRef margin   
);

[ public, friend ]
SFUMargin operator+(
    ConstSFUMarginRef margin1   
    ConstSFUMarginRef margin2   
);

[ public ]
SFUMarginRef operator+=(
    ConstSFUMarginRef margin   
);

解説

SFUMargin に SFUMargin を加算すると、それぞれの上下左右のマージンを加算した SFUMargin を返します。

参照

SFUMargin::operator-

SFUMargin::b

下のマージンです。

[ public ]
SInt16 b;

SFUMargin::l

左のマージンです。

[ public ]
SInt16 l;

SFUMargin::r

右のマージンです。

[ public ]
SInt16 r;

SFUMargin::t

上のマージンです。

[ public ]
SInt16 t;