PrevNextUpHome BREW C++ Class Library & GUI Framework & XML Middleware : SophiaFramework 4.1
SFXMargin
Class that represents the top, bottom, left and right margins of rectangle.
#include <SFXMargin.h.hpp>
class SFXMargin;
SFMTYPEDEFCLASS(SFXMargin)

Member

Constructor/Destructor
SFXMargin( Void )
Constructor of SFXMargin class.
SFXMargin( SFXMarginConstRef param )
Constructor of SFXMargin class.
SFXMargin( SFXSizeConstRef lt , SFXSizeConstRef rb )
Constructor of SFXMargin class.
SFXMargin( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Constructor of SFXMargin class.
SFXMargin( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Constructor of SFXMargin class.
SFXMargin( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Constructor of SFXMargin class.
SFXMargin( SInt16 horizontal , SInt16 vertical )
Constructor of SFXMargin class.
Public Functions
SFXMarginRef Add( SFXMarginConstRef param )
Add( SInt16 horizontal , SInt16 vertical )
Add( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Add( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Add( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Add( SFXSizeConstRef lt , SFXSizeConstRef rb )
Add a specified value to the margin.
SFXMarginRef AddBottom( SInt16 param )
Add a specified value to the bottom margin.
SFXMarginRef AddLeft( SInt16 param )
Add a specified value to the left margin.
SFXMarginRef AddLeftBottom( SFXSizeConstRef param )
AddLeftBottom( SInt16 width , SInt16 height )
Add a specified value to the left margin and bottom margin.
SFXMarginRef AddLeftTop( SFXSizeConstRef param )
AddLeftTop( SInt16 width , SInt16 height )
Add a specified value to the left margin and top margin.
SFXMarginRef AddRight( SInt16 param )
Add a specified value to the right margin.
SFXMarginRef AddRightBottom( SFXSizeConstRef param )
AddRightBottom( SInt16 width , SInt16 height )
Add a specified value to the right margin and bottom margin.
SFXMarginRef AddRightTop( SFXSizeConstRef param )
AddRightTop( SInt16 width , SInt16 height )
Add a specified value to the right margin and top margin.
SFXMarginRef AddTop( SInt16 param )
Add a specified value to the top margin.
SFXMarginRef Div( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Div( SInt16 param )
Div( SInt16 horizontal , SInt16 vertical )
Divide the margin by a specified value.
SFXMarginRef DivBottom( SInt16 param )
Divide the bottom margin by a specified value.
SFXMarginRef DivLeft( SInt16 param )
Divide the left margin by a specified value.
SFXMarginRef DivLeftBottom( SInt16 width , SInt16 height )
DivLeftBottom( SInt16 param )
Divide the left margin and bottom margin by a specified value.
SFXMarginRef DivLeftTop( SInt16 width , SInt16 height )
DivLeftTop( SInt16 param )
Divide the left margin and top margin by a specified value.
SFXMarginRef DivRight( SInt16 param )
Divide the right margin by a specified value.
SFXMarginRef DivRightBottom( SInt16 width , SInt16 height )
DivRightBottom( SInt16 param )
Divide the right margin and bottom margin by a specified value.
SFXMarginRef DivRightTop( SInt16 width , SInt16 height )
DivRightTop( SInt16 param )
Divide the right margin and top margin by a specified value.
SFXMarginRef DivTop( SInt16 param )
Divide the top margin by a specified value.
static
SFXMarginConstRef 		EmptyInstance( Void )
Get an empty margin.
Bool Equals( SFXMarginConstRef param )
Equals( SInt16 horizontal , SInt16 vertical )
Equals( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Equals( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Equals( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Equals( SFXSizeConstRef lt , SFXSizeConstRef rb )
Check whether this margin equals a specified margin or not.
SInt16 GetBottom( Void )
Get the bottom margin.
SInt16 GetLeft( Void )
Get the left margin.
SFXSize GetLeftBottom( Void )
Get the left margin and bottom margin.
SFXSize GetLeftTop( Void )
Get the left margin and top margin.
SInt16 GetRight( Void )
Get the right margin.
SFXSize GetRightBottom( Void )
Get the right margin and bottom margin.
SFXSize GetRightTop( Void )
Get the right margin and top margin.
SInt16 GetTop( Void )
Get the top margin.
Bool IsEmpty( Void )
Check whether this margin is empty or not.
SFXMarginRef Mod( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Mod( SInt16 param )
Mod( SInt16 horizontal , SInt16 vertical )
Set the margins to the remainder of the division of the margins by a specified value.
SFXMarginRef ModBottom( SInt16 param )
Set the bottom margin to the remainder of the division of bottom margin by a specified value.
SFXMarginRef ModLeft( SInt16 param )
Set the left margin to the remainder of the division of left margin by a specified value.
SFXMarginRef ModLeftBottom( SInt16 width , SInt16 height )
ModLeftBottom( SInt16 param )
Set the left margin and bottom margin to the remainder of the division of the margins by a specified value.
SFXMarginRef ModLeftTop( SInt16 width , SInt16 height )
ModLeftTop( SInt16 param )
Set the left margin and top margin to the remainder of the division of the margins by a specified value.
SFXMarginRef ModRight( SInt16 param )
Set the right margin to the remainder of the division of right margin by a specified value.
SFXMarginRef ModRightBottom( SInt16 width , SInt16 height )
ModRightBottom( SInt16 param )
Set the right margin and bottom margin to the remainder of the division of the margins by a specified value.
SFXMarginRef ModRightTop( SInt16 width , SInt16 height )
ModRightTop( SInt16 param )
Set the right margin and top margin to the remainder of the division of xxx by a specified value.
SFXMarginRef ModTop( SInt16 param )
Set the top margin to the remainder of the division of top margin by a specified value.
SFXMarginRef Mul( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Mul( SInt16 param )
Mul( SInt16 horizontal , SInt16 vertical )
Multiply the margins by a specified value.
SFXMarginRef MulBottom( SInt16 param )
Multiply the bottom margin by a specified value.
SFXMarginRef MulLeft( SInt16 param )
Multiply the left margin by a specified value.
SFXMarginRef MulLeftBottom( SInt16 width , SInt16 height )
MulLeftBottom( SInt16 param )
Multiply the left margin and bottom margin by a specified value.
SFXMarginRef MulLeftTop( SInt16 width , SInt16 height )
MulLeftTop( SInt16 param )
Multiply the left margin and top margin by a specified value.
SFXMarginRef MulRight( SInt16 param )
Multiply the right margin by a specified value.
SFXMarginRef MulRightBottom( SInt16 width , SInt16 height )
MulRightBottom( SInt16 param )
Multiply the right margin and bottom margin by a specified value.
SFXMarginRef MulRightTop( SInt16 width , SInt16 height )
MulRightTop( SInt16 param )
Multiply the right margin and top margin by a specified value.
SFXMarginRef MulTop( SInt16 param )
Multiply the top margin by a specified value.
SFXMarginRef Neg( Void )
Negate the sign of the margin.
SFXMarginRef NegBottom( Void )
Negate the sign of the bottom margin.
SFXMarginRef NegLeft( Void )
Negate the sign of the left margin.
SFXMarginRef NegLeftBottom( Void )
Negate the sign of the left margin and bottom margin.
SFXMarginRef NegLeftTop( Void )
Negate the sign of the left margin and top margin.
SFXMarginRef NegRight( Void )
Negate the sign of the right margin.
SFXMarginRef NegRightBottom( Void )
Negate the sign of the right margin and bottom margin.
SFXMarginRef NegRightTop( Void )
Negate the sign of the right margin and top margin.
SFXMarginRef NegTop( Void )
Negate the sign of the top margin.
SFXMarginRef Set( SFXMarginConstRef param )
Set( SInt16 horizontal , SInt16 vertical )
Set( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Set( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Set( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Set( SFXSizeConstRef lt , SFXSizeConstRef rb )
Set the margin.
SFXMarginRef SetBottom( SInt16 param )
Set the bottom margin.
SFXMarginRef SetLeft( SInt16 param )
Set the left margin.
SFXMarginRef SetLeftBottom( SFXSizeConstRef param )
SetLeftBottom( SInt16 width , SInt16 height )
Set the left margin and bottom margin.
SFXMarginRef SetLeftTop( SFXSizeConstRef param )
SetLeftTop( SInt16 width , SInt16 height )
Set the left margin and top margin.
SFXMarginRef SetRight( SInt16 param )
Set the right margin.
SFXMarginRef SetRightBottom( SFXSizeConstRef param )
SetRightBottom( SInt16 width , SInt16 height )
Set the right margin and bottom margin.
SFXMarginRef SetRightTop( SFXSizeConstRef param )
SetRightTop( SInt16 width , SInt16 height )
Set the right margin and top margin.
SFXMarginRef SetTop( SInt16 param )
Set the top margin.
SFXMarginRef Sub( SFXMarginConstRef param )
Sub( SInt16 horizontal , SInt16 vertical )
Sub( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Sub( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Sub( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Sub( SFXSizeConstRef lt , SFXSizeConstRef rb )
Subtract a specified value from the margin.
SFXMarginRef SubBottom( SInt16 param )
Subtract a specified value from the bottom margin.
SFXMarginRef SubLeft( SInt16 param )
Subtract a specified value from the left margin.
SFXMarginRef SubLeftBottom( SFXSizeConstRef param )
SubLeftBottom( SInt16 width , SInt16 height )
Subtract a specified value from the left margin and bottom margin.
SFXMarginRef SubLeftTop( SFXSizeConstRef param )
SubLeftTop( SInt16 width , SInt16 height )
Subtract a specified value from the left margin and top margin.
SFXMarginRef SubRight( SInt16 param )
Subtract a specified value from the right margin.
SFXMarginRef SubRightBottom( SFXSizeConstRef param )
SubRightBottom( SInt16 width , SInt16 height )
Subtract a specified value from the right margin and bottom margin.
SFXMarginRef SubRightTop( SFXSizeConstRef param )
SubRightTop( SInt16 width , SInt16 height )
Subtract a specified value from the right margin and top margin.
SFXMarginRef SubTop( SInt16 param )
Subtract a specified value from the top margin.
static
SFXMarginConstRef 		ZeroInstance( Void )
Get the instance that represents 0.
SFXMarginRef operator%=( SInt16 param )
Set the margin to the remainder of the division of the margin by a specified value.
SFXMarginRef operator*=( SInt16 param )
Multiply the margin by a specified value.
SFXMarginRef operator+=( SFXMarginConstRef param )
Add a specified value to the margin.
SFXMarginRef operator-=( SFXMarginConstRef param )
Subtract a specified value from the margin.
SFXMarginRef operator/=( SInt16 param )
Divide the margin by a specified value.
SFXMarginRef operator=( SFXMarginConstRef param )
Assign a margin.
SFXMargin::AtomRec * atomic_cast( SFXMargin * param )
Convert SFXMargin into SFXMargin::AtomRec.
SFXMargin::AtomRec const * atomic_cast( SFXMargin const * param )
Convert SFXMargin into SFXMargin::AtomRec.
SFXMargin operator%( SFXMarginConstRef left , SInt16 right )
Set the margin to the remainder of the division of the margin by a specified value.
SFXMargin operator/( SFXMarginConstRef left , SInt16 right )
Divide the margin by a specified value.
Bool operator==( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "==" relation.
SFXMargin operator-( Void )
operator-( SFXMarginConstRef left , SFXMarginConstRef right )
Subtract a specified value from the margin.
SFXMargin operator*( SFXMarginConstRef left , SInt16 right )
Multiply the margin by a specified value.
Bool operator!=( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "!=" relation.
SFXMargin operator+( Void )
operator+( SFXMarginConstRef left , SFXMarginConstRef right )
Add a specified value to the margin.
Types
AtomRec
Structure that represents a margin.
Global Functions
SFXMargin::AtomRec * atomic_cast( SFXMargin * param )
Convert SFXMargin into SFXMargin::AtomRec.
SFXMargin::AtomRec const * atomic_cast( SFXMargin const * param )
Convert SFXMargin into SFXMargin::AtomRec.
SFXMargin operator%( SFXMarginConstRef left , SInt16 right )
Set the margin to the remainder of the division of the margin by a specified value.
SFXMargin operator/( SFXMarginConstRef left , SInt16 right )
Divide the margin by a specified value.
Bool operator==( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "==" relation.
SFXMargin operator-( Void )
operator-( SFXMarginConstRef left , SFXMarginConstRef right )
Subtract a specified value from the margin.
SFXMargin operator*( SFXMarginConstRef left , SInt16 right )
Multiply the margin by a specified value.
Bool operator!=( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "!=" relation.
SFXMargin operator+( Void )
operator+( SFXMarginConstRef left , SFXMarginConstRef right )
Add a specified value to the margin.
SFXMargin::SFXMargin
Constructor of SFXMargin class. 
[ public, explicit ]
SFXMargin(Void);
[ public ]
SFXMargin(
    SFXMarginConstRef param   // source margin
);
[ public, explicit ]
SFXMargin(
    SFXSizeConstRef lt   // size of left margin and top margin
    SFXSizeConstRef rb   // size of right margin and bottom margin
);
[ public, explicit ]
SFXMargin(
    SFXSizeConstRef lt   // size of left margin and top margin
    SInt16 right         // width of right margin
    SInt16 bottom        // height of bottom margin
);
[ public, explicit ]
SFXMargin(
    SInt16 left          // width of left margin
    SInt16 top           // hright of top margin
    SFXSizeConstRef rb   // size of right margin and bottom margin
);
[ public, explicit ]
SFXMargin(
    SInt16 left     // width of left margin
    SInt16 top      // hright of top margin
    SInt16 right    // width of right margin
    SInt16 bottom   // height of bottom margin
);
[ public, explicit ]
SFXMargin(
    SInt16 horizontal   // width of left margin and right margin
    SInt16 vertical     // height of top margin and bottom margin
);
SFXMargin::Add
Add a specified value to the margin.
[ public ]
SFXMarginRef Add(
    SFXMarginConstRef param   // value to add to every margin
);
[ public ]
SFXMarginRef Add(
    SFXSizeConstRef lt   // size to add to the left margin and top margin
    SFXSizeConstRef rb   // size to add to the right margin and bottom margin
);
[ public ]
SFXMarginRef Add(
    SFXSizeConstRef lt   // size to add to the left margin and top margin
    SInt16 right         // width to add to the right margin
    SInt16 bottom        // height to add to the bottom margin
);
[ public ]
SFXMarginRef Add(
    SInt16 left          // width to add to the left margin
    SInt16 top           // height to add to the top margin
    SFXSizeConstRef rb   // size to add to the right margin and bottom margin
);
[ public ]
SFXMarginRef Add(
    SInt16 left     // width to add to the left margin
    SInt16 top      // height to add to the top margin
    SInt16 right    // width to add to the right margin
    SInt16 bottom   // height to add to the bottom margin
);
[ public ]
SFXMarginRef Add(
    SInt16 horizontal   // width to add to the left margin and right margin
    SInt16 vertical     // height to add to the top margin and bottom margin
);

Reference

SFXMargin::AddBottom | SFXMargin::AddLeft | SFXMargin::AddLeftBottom | SFXMargin::AddLeftTop | SFXMargin::AddRight | SFXMargin::AddRightBottom | SFXMargin::AddRightTop | SFXMargin::AddTop | SFXMargin::Sub | SFXMargin::Mul | SFXMargin::Div | SFXMargin::Mod | SFXMargin::Neg

SFXMargin::AddBottom
Add a specified value to the bottom margin.
[ public ]
SFXMarginRef AddBottom(
    SInt16 param   // height value to add to the bottom margin
);

Reference

SFXMargin::AddTop | SFXMargin::AddLeft | SFXMargin::AddRight | SFXMargin::AddLeftTop | SFXMargin::AddRightTop | SFXMargin::AddLeftBottom | SFXMargin::AddRightBottom | SFXMargin::SubBottom | SFXMargin::MulBottom | SFXMargin::DivBottom | SFXMargin::ModBottom | SFXMargin::NegBottom

SFXMargin::AddLeft
Add a specified value to the left margin.
[ public ]
SFXMarginRef AddLeft(
    SInt16 param   // value to add to the left margin
);

Reference

SFXMargin::AddTop | SFXMargin::AddBottom | SFXMargin::AddRight | SFXMargin::AddLeftTop | SFXMargin::AddRightTop | SFXMargin::AddLeftBottom | SFXMargin::AddRightBottom | SFXMargin::SubLeft | SFXMargin::MulLeft | SFXMargin::DivLeft | SFXMargin::ModLeft | SFXMargin::NegLeft

SFXMargin::AddLeftBottom
Add a specified value to the left margin and bottom margin.
[ public ]
SFXMarginRef AddLeftBottom(
    SFXSizeConstRef param   // value to add to the left margin and bottom margin
);
[ public ]
SFXMarginRef AddLeftBottom(
    SInt16 width    // width to add to the left margin
    SInt16 height   // height to add to the bottom margin
);

Reference

SFXMargin::AddBottom | SFXMargin::AddLeft | SFXMargin::SubLeftBottom | SFXMargin::MulLeftBottom | SFXMargin::DivLeftBottom | SFXMargin::ModLeftBottom | SFXMargin::NegLeftBottom

SFXMargin::AddLeftTop
Add a specified value to the left margin and top margin.
[ public ]
SFXMarginRef AddLeftTop(
    SFXSizeConstRef param   // left margin and value to add to the top margin
);
[ public ]
SFXMarginRef AddLeftTop(
    SInt16 width    // width to add to the left margin
    SInt16 height   // height to add to the top margin
);

Reference

SFXMargin::AddTop | SFXMargin::AddLeft | SFXMargin::SubLeftTop | SFXMargin::MulLeftTop | SFXMargin::DivLeftTop | SFXMargin::ModLeftTop | SFXMargin::NegLeftTop

SFXMargin::AddRight
Add a specified value to the right margin.
[ public ]
SFXMarginRef AddRight(
    SInt16 param   // value to add to the right margin
);

Reference

SFXMargin::AddTop | SFXMargin::AddBottom | SFXMargin::AddLeft | SFXMargin::AddLeftTop | SFXMargin::AddRightTop | SFXMargin::AddLeftBottom | SFXMargin::AddRightBottom | SFXMargin::SubRight | SFXMargin::MulRight | SFXMargin::DivRight | SFXMargin::ModRight | SFXMargin::NegRight

SFXMargin::AddRightBottom
Add a specified value to the right margin and bottom margin.
[ public ]
SFXMarginRef AddRightBottom(
    SFXSizeConstRef param   // value to add to the right margin and bottom margin
);
[ public ]
SFXMarginRef AddRightBottom(
    SInt16 width    // width to add to the right margin
    SInt16 height   // height to add to the bottom margin
);

Reference

SFXMargin::AddBottom | SFXMargin::AddRight | SFXMargin::SubRightBottom | SFXMargin::MulRightBottom | SFXMargin::DivRightBottom | SFXMargin::ModRightBottom | SFXMargin::NegRightBottom

SFXMargin::AddRightTop
Add a specified value to the right margin and top margin.
[ public ]
SFXMarginRef AddRightTop(
    SFXSizeConstRef param   // value to add to right margin and top margin
);
[ public ]
SFXMarginRef AddRightTop(
    SInt16 width    // width to add to the right margin
    SInt16 height   // height to add to the top margin
);

Reference

SFXMargin::AddTop | SFXMargin::AddLeft | SFXMargin::AddRight | SFXMargin::SubRightTop | SFXMargin::MulRightTop | SFXMargin::DivRightTop | SFXMargin::ModRightTop | SFXMargin::NegRightTop

SFXMargin::AddTop
Add a specified value to the top margin.
[ public ]
SFXMarginRef AddTop(
    SInt16 param   // value to add to the top margin
);

Reference

SFXMargin::AddBottom | SFXMargin::AddLeft | SFXMargin::AddRight | SFXMargin::AddLeftTop | SFXMargin::AddRightTop | SFXMargin::AddLeftBottom | SFXMargin::AddRightBottom | SFXMargin::SubTop | SFXMargin::MulTop | SFXMargin::DivTop | SFXMargin::ModTop | SFXMargin::NegTop

SFXMargin::Div
Divide the margin by a specified value.
[ public ]
SFXMarginRef Div(
    SInt16 left     // divide the left margin by this value
    SInt16 top      // divide the top margin by this value
    SInt16 right    // divide the right margin by this value
    SInt16 bottom   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef Div(
    SInt16 horizontal   // divide the left margin and right margin by this value
    SInt16 vertical     // divide the top margin and bottom margin by this value
);
[ public ]
SFXMarginRef Div(
    SInt16 param   // divide every margin by this value
);

Description

The behaviour is not defined when the value of the left, top, right, bottom, horizontal, vertical or param argument is 0.

Reference

SFXMargin::Add | SFXMargin::Sub | SFXMargin::Mul | SFXMargin::DivBottom | SFXMargin::DivLeft | SFXMargin::DivLeftBottom | SFXMargin::DivLeftTop | SFXMargin::DivRight | SFXMargin::DivRightBottom | SFXMargin::DivRightTop | SFXMargin::DivTop | SFXMargin::Mod | SFXMargin::Neg | operator/ | SFXMargin::operator/=

SFXMargin::DivBottom
Divide the bottom margin by a specified value.
[ public ]
SFXMarginRef DivBottom(
    SInt16 param   // divide the bottom margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddBottom | SFXMargin::SubBottom | SFXMargin::MulBottom | SFXMargin::DivTop | SFXMargin::DivLeft | SFXMargin::DivRight | SFXMargin::DivLeftTop | SFXMargin::DivRightTop | SFXMargin::DivLeftBottom | SFXMargin::DivRightBottom | SFXMargin::ModBottom | SFXMargin::NegBottom

SFXMargin::DivLeft
Divide the left margin by a specified value.
[ public ]
SFXMarginRef DivLeft(
    SInt16 param   // divide the left margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddLeft | SFXMargin::SubLeft | SFXMargin::MulLeft | SFXMargin::DivTop | SFXMargin::DivBottom | SFXMargin::DivRight | SFXMargin::DivLeftTop | SFXMargin::DivRightTop | SFXMargin::DivLeftBottom | SFXMargin::DivRightBottom | SFXMargin::ModLeft | SFXMargin::NegLeft

SFXMargin::DivLeftBottom
Divide the left margin and bottom margin by a specified value.
[ public ]
SFXMarginRef DivLeftBottom(
    SInt16 width    // divide the left margin by this value
    SInt16 height   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef DivLeftBottom(
    SInt16 param   // divide the left margin and bottom margin by this value
);

Description

The behaviour is not defined when the value of the width, height, or param argument is 0.

Reference

SFXMargin::AddLeftBottom | SFXMargin::SubLeftBottom | SFXMargin::MulLeftBottom | SFXMargin::DivBottom | SFXMargin::DivLeft | SFXMargin::ModLeftBottom | SFXMargin::NegLeftBottom

SFXMargin::DivLeftTop
Divide the left margin and top margin by a specified value.
[ public ]
SFXMarginRef DivLeftTop(
    SInt16 width    // divide the left margin by this value
    SInt16 height   // divide the top margin by this value
);
[ public ]
SFXMarginRef DivLeftTop(
    SInt16 param   // divide the left margin and top margin by this value
);

Description

The behaviour is not defined when the value of the width, height, or param argument is 0.

Reference

SFXMargin::AddLeftTop | SFXMargin::SubLeftTop | SFXMargin::MulLeftTop | SFXMargin::DivTop | SFXMargin::DivLeft | SFXMargin::ModLeftTop | SFXMargin::NegLeftTop

SFXMargin::DivRight
Divide the right margin by a specified value.
[ public ]
SFXMarginRef DivRight(
    SInt16 param   // divide the right margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddRight | SFXMargin::SubRight | SFXMargin::MulRight | SFXMargin::DivTop | SFXMargin::DivBottom | SFXMargin::DivLeft | SFXMargin::DivLeftTop | SFXMargin::DivRightTop | SFXMargin::DivLeftBottom | SFXMargin::DivRightBottom | SFXMargin::ModRight | SFXMargin::NegRight

SFXMargin::DivRightBottom
Divide the right margin and bottom margin by a specified value.
[ public ]
SFXMarginRef DivRightBottom(
    SInt16 width    // divide the right margin by this value
    SInt16 height   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef DivRightBottom(
    SInt16 param   // divide the right margin and bottom margin by this value
);

Description

The behaviour is not defined when the value of the width, height, or param argument is 0.

Reference

SFXMargin::AddRightBottom | SFXMargin::SubRightBottom | SFXMargin::MulRightBottom | SFXMargin::DivBottom | SFXMargin::DivRight | SFXMargin::ModRightBottom | SFXMargin::NegRightBottom

SFXMargin::DivRightTop
Divide the right margin and top margin by a specified value.
[ public ]
SFXMarginRef DivRightTop(
    SInt16 width    // divide the right margin by this value
    SInt16 height   // divide the top margin by this value
);
[ public ]
SFXMarginRef DivRightTop(
    SInt16 param   // divide the right margin by this value and top margin 
);

Description

The behaviour is not defined when the value of the width, height, or param argument is 0.

Reference

SFXMargin::AddRightTop | SFXMargin::SubRightTop | SFXMargin::MulRightTop | SFXMargin::DivTop | SFXMargin::DivLeft | SFXMargin::DivRight | SFXMargin::ModRightTop | SFXMargin::NegRightTop

SFXMargin::DivTop
Divide the top margin by a specified value.
[ public ]
SFXMarginRef DivTop(
    SInt16 param   // divide the top margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddTop | SFXMargin::SubTop | SFXMargin::MulTop | SFXMargin::DivBottom | SFXMargin::DivLeft | SFXMargin::DivRight | SFXMargin::DivLeftTop | SFXMargin::DivRightTop | SFXMargin::DivLeftBottom | SFXMargin::DivRightBottom | SFXMargin::ModTop | SFXMargin::NegTop

SFXMargin::EmptyInstance
Get an empty margin.
[ public, static ]
SFXMarginConstRef EmptyInstance(Void);

Return value

Return an empty SFXMargin instance, which means this shape has no area.

Description

A shape has no area if the value of a length-related variable is less than or equals 0. This instance is used mainly as initial value of the assignment statement or return value of the shape-related function.

SFXMargin::Equals
Check whether this margin equals a specified margin or not.
[ public, const ]
Bool Equals(
    SFXMarginConstRef param   // margin to compare
);
[ public, const ]
Bool Equals(
    SFXSizeConstRef lt   // size of left margin and top margin to compare
    SFXSizeConstRef rb   // size of right margin and bottom margin to compare
);
[ public, const ]
Bool Equals(
    SFXSizeConstRef lt   // size of left margin and top margin to compare
    SInt16 right         // width of right margin to compare
    SInt16 bottom        // height of bottom margin to compare
);
[ public, const ]
Bool Equals(
    SInt16 left          // width of left margin to compare
    SInt16 top           // height of top margin to compare
    SFXSizeConstRef rb   // size of right margin and bottom margin to compare
);
[ public, const ]
Bool Equals(
    SInt16 left     // width of left margin to compare
    SInt16 top      // height of top margin to compare
    SInt16 right    // width of right margin to compare
    SInt16 bottom   // height of bottom margin to compare
);
[ public, const ]
Bool Equals(
    SInt16 horizontal   // width of left margin and right margin to compare
    SInt16 vertical     // height of top margin and bottom margin to compare
);

Return value

  • If yes : true
  • Otherwise : false

Reference

operator== | operator!=

SFXMargin::GetBottom
Get the bottom margin.
[ public, const ]
SInt16 GetBottom(Void);

Reference

SFXMargin::GetTop | SFXMargin::GetLeft | SFXMargin::GetRight | SFXMargin::GetLeftTop | SFXMargin::GetRightTop | SFXMargin::GetLeftBottom | SFXMargin::GetRightBottom | SFXMargin::SetBottom

SFXMargin::GetLeft
Get the left margin.
[ public, const ]
SInt16 GetLeft(Void);

Reference

SFXMargin::GetTop | SFXMargin::GetBottom | SFXMargin::GetRight | SFXMargin::GetLeftTop | SFXMargin::GetRightTop | SFXMargin::GetLeftBottom | SFXMargin::GetRightBottom | SFXMargin::SetLeft

SFXMargin::GetLeftBottom
Get the left margin and bottom margin.
[ public, const ]
SFXSize GetLeftBottom(Void);

Reference

SFXMargin::GetBottom | SFXMargin::GetLeft | SFXMargin::SetLeftBottom

SFXMargin::GetLeftTop
Get the left margin and top margin.
[ public, const ]
SFXSize GetLeftTop(Void);

Reference

SFXMargin::GetTop | SFXMargin::GetLeft | SFXMargin::SetLeftTop

SFXMargin::GetRight
Get the right margin.
[ public, const ]
SInt16 GetRight(Void);

Reference

SFXMargin::GetTop | SFXMargin::GetBottom | SFXMargin::GetLeft | SFXMargin::GetLeftTop | SFXMargin::GetRightTop | SFXMargin::GetLeftBottom | SFXMargin::GetRightBottom | SFXMargin::SetRight

SFXMargin::GetRightBottom
Get the right margin and bottom margin.
[ public, const ]
SFXSize GetRightBottom(Void);

Reference

SFXMargin::GetBottom | SFXMargin::GetRight | SFXMargin::SetRightBottom

SFXMargin::GetRightTop
Get the right margin and top margin.
[ public, const ]
SFXSize GetRightTop(Void);

Reference

SFXMargin::GetTop | SFXMargin::GetLeft | SFXMargin::GetRight | SFXMargin::SetRightTop

SFXMargin::GetTop
Get the top margin.
[ public, const ]
SInt16 GetTop(Void);

Reference

SFXMargin::GetBottom | SFXMargin::GetLeft | SFXMargin::GetRight | SFXMargin::GetLeftTop | SFXMargin::GetRightTop | SFXMargin::GetLeftBottom | SFXMargin::GetRightBottom | SFXMargin::SetTop

SFXMargin::IsEmpty
Check whether this margin is empty or not.
[ public, const ]
Bool IsEmpty(Void);

Description

  • If yes : true
  • Otherwise : false
SFXMargin::Mod
Set the margins to the remainder of the division of the margins by a specified value.
[ public ]
SFXMarginRef Mod(
    SInt16 left     // divide the left margin by this value
    SInt16 top      // divide the top margin by this value
    SInt16 right    // divide the right margin by this value
    SInt16 bottom   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef Mod(
    SInt16 horizontal   // divide the left margin and right margin by this value
    SInt16 vertical     // divide the top margin and bottom margin by this value
);
[ public ]
SFXMarginRef Mod(
    SInt16 param   // divide every margin by this value
);

Description

The operation when the left, top, right, bottom, horizontal, vertical, or param is 0 has not been defined yet.

Reference

SFXMargin::Add | SFXMargin::Sub | SFXMargin::Mul | SFXMargin::Div | SFXMargin::ModBottom | SFXMargin::ModLeft | SFXMargin::ModLeftBottom | SFXMargin::ModLeftTop | SFXMargin::ModRight | SFXMargin::ModRightBottom | SFXMargin::ModRightTop | SFXMargin::ModTop | SFXMargin::Neg | operator% | SFXMargin::operator%=

SFXMargin::ModBottom
Set the bottom margin to the remainder of the division of bottom margin by a specified value.
[ public ]
SFXMarginRef ModBottom(
    SInt16 param   // divide the bottom margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddBottom | SFXMargin::SubBottom | SFXMargin::MulBottom | SFXMargin::DivBottom | SFXMargin::ModTop | SFXMargin::ModLeft | SFXMargin::ModRight | SFXMargin::ModLeftTop | SFXMargin::ModRightTop | SFXMargin::ModLeftBottom | SFXMargin::ModRightBottom | SFXMargin::NegBottom

SFXMargin::ModLeft
Set the left margin to the remainder of the division of left margin by a specified value.
[ public ]
SFXMarginRef ModLeft(
    SInt16 param   // divide the left margin by this value
);

Description

The behaviour is not defined when the value of the param argument is 0.

Reference

SFXMargin::AddLeft | SFXMargin::SubLeft | SFXMargin::MulLeft | SFXMargin::DivLeft | SFXMargin::ModTop | SFXMargin::ModBottom | SFXMargin::ModRight | SFXMargin::ModLeftTop | SFXMargin::ModRightTop | SFXMargin::ModLeftBottom | SFXMargin::ModRightBottom | SFXMargin::NegLeft

SFXMargin::ModLeftBottom
Set the left margin and bottom margin to the remainder of the division of the margins by a specified value.
[ public ]
SFXMarginRef ModLeftBottom(
    SInt16 width    // divide the left margin by this value
    SInt16 height   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef ModLeftBottom(
    SInt16 param   // divide the left margin and bottom margin by this value
);

Description

The operation when the width, height, or param is 0 has not been defined yet.

Reference

SFXMargin::AddLeftBottom | SFXMargin::SubLeftBottom | SFXMargin::MulLeftBottom | SFXMargin::DivLeftBottom | SFXMargin::ModBottom | SFXMargin::ModLeft | SFXMargin::NegLeftBottom

SFXMargin::ModLeftTop
Set the left margin and top margin to the remainder of the division of the margins by a specified value.
[ public ]
SFXMarginRef ModLeftTop(
    SInt16 width    // divide the left margin by this value
    SInt16 height   // divide the top margin by this value
);
[ public ]
SFXMarginRef ModLeftTop(
    SInt16 param   // divide the left margin and top margin by this value
);

Description

The operation when the width, height, or param is 0 has not been defined yet.

Reference