PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFXMargin
Class which 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 the SFXMargin class.
SFXMargin( SFXMarginConstRef param )
Constructor of the SFXMargin class.
SFXMargin( SFXSizeConstRef lt , SFXSizeConstRef rb )
Constructor of the SFXMargin class.
SFXMargin( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Constructor of the SFXMargin class.
SFXMargin( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Constructor of the SFXMargin class.
SFXMargin( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Constructor of the SFXMargin class.
SFXMargin( SInt16 horizontal , SInt16 vertical )
Constructor of the SFXMargin class.
Public Functions
SFXMarginRef Add( SFXMarginConstRef param )
Add the specified value to the margin.
SFXMarginRef Add( SFXSizeConstRef lt , SFXSizeConstRef rb )
Add the specified value to the margin.
SFXMarginRef Add( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Add the specified value to the margin.
SFXMarginRef Add( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Add the specified value to the margin.
SFXMarginRef Add( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Add the specified value to the margin.
SFXMarginRef Add( SInt16 horizontal , SInt16 vertical )
Add the specified value to the margin.
SFXMarginRef AddBottom( SInt16 param )
Add the specified value to the bottom margin.
SFXMarginRef AddLeft( SInt16 param )
Add the specified value to the left margin.
SFXMarginRef AddLeftBottom( SFXSizeConstRef param )
Add the specified value to the left margin and bottom margin.
SFXMarginRef AddLeftBottom( SInt16 width , SInt16 height )
Add the specified value to the left margin and bottom margin.
SFXMarginRef AddLeftTop( SFXSizeConstRef param )
Add the specified value to the left margin and top margin.
SFXMarginRef AddLeftTop( SInt16 width , SInt16 height )
Add the specified value to the left margin and top margin.
SFXMarginRef AddRight( SInt16 param )
Add the specified value to the right margin.
SFXMarginRef AddRightBottom( SFXSizeConstRef param )
Add the specified value to the right margin and bottom margin.
SFXMarginRef AddRightBottom( SInt16 width , SInt16 height )
Add the specified value to the right margin and bottom margin.
SFXMarginRef AddRightTop( SFXSizeConstRef param )
Add the specified value to the right margin and top margin.
SFXMarginRef AddRightTop( SInt16 width , SInt16 height )
Add the specified value to the right margin and top margin.
SFXMarginRef AddTop( SInt16 param )
Add the specified value to the top margin.
SFXMarginRef Div( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Divide the margin by the specified value.
SFXMarginRef Div( SInt16 horizontal , SInt16 vertical )
Divide the margin by the specified value.
SFXMarginRef Div( SInt16 param )
Divide the margin by the specified value.
SFXMarginRef DivBottom( SInt16 param )
Divide the bottom margin by the specified value.
SFXMarginRef DivLeft( SInt16 param )
Divide the left margin by the specified value.
SFXMarginRef DivLeftBottom( SInt16 width , SInt16 height )
Divide the left margin and bottom margin by the specified value.
SFXMarginRef DivLeftBottom( SInt16 param )
Divide the left margin and bottom margin by the specified value.
SFXMarginRef DivLeftTop( SInt16 width , SInt16 height )
Divide the left margin and top margin by the specified value.
SFXMarginRef DivLeftTop( SInt16 param )
Divide the left margin and top margin by the specified value.
SFXMarginRef DivRight( SInt16 param )
Divide the right margin by the specified value.
SFXMarginRef DivRightBottom( SInt16 width , SInt16 height )
Divide the right margin and bottom margin by the specified value.
SFXMarginRef DivRightBottom( SInt16 param )
Divide the right margin and bottom margin by the specified value.
SFXMarginRef DivRightTop( SInt16 width , SInt16 height )
Divide the right margin and top margin by the specified value.
SFXMarginRef DivRightTop( SInt16 param )
Divide the right margin and top margin by the specified value.
SFXMarginRef DivTop( SInt16 param )
Divide the top margin by the specified value.
static
SFXMarginConstRef
EmptyInstance( Void )
Get an empty margin.
Bool Equals( SFXMarginConstRef param )
Check whether this margin equals the specified margin or not.
Bool Equals( SFXSizeConstRef lt , SFXSizeConstRef rb )
Check whether this margin equals the specified margin or not.
Bool Equals( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Check whether this margin equals the specified margin or not.
Bool Equals( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Check whether this margin equals the specified margin or not.
Bool Equals( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Check whether this margin equals the specified margin or not.
Bool Equals( SInt16 horizontal , SInt16 vertical )
Check whether this margin equals the 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 )
Set the margins to the remainder of the division of the margins by the specified value.
SFXMarginRef Mod( SInt16 horizontal , SInt16 vertical )
Set the margins to the remainder of the division of the margins by the specified value.
SFXMarginRef Mod( SInt16 param )
Set the margins to the remainder of the division of the margins by the specified value.
SFXMarginRef ModBottom( SInt16 param )
Set the bottom margin to the remainder of the division of bottom margin by the specified value.
SFXMarginRef ModLeft( SInt16 param )
Set the left margin to the remainder of the division of left margin by the specified value.
SFXMarginRef ModLeftBottom( SInt16 width , SInt16 height )
Set the left margin and bottom margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModLeftBottom( SInt16 param )
Set the left margin and bottom margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModLeftTop( SInt16 width , SInt16 height )
Set the left margin and top margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModLeftTop( SInt16 param )
Set the left margin and top margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModRight( SInt16 param )
Set the right margin to the remainder of the division of right margin by the specified value.
SFXMarginRef ModRightBottom( SInt16 width , SInt16 height )
Set the right margin and bottom margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModRightBottom( SInt16 param )
Set the right margin and bottom margin to the remainder of the division of the margins by the specified value.
SFXMarginRef ModRightTop( SInt16 width , SInt16 height )
Set the right margin and top margin to the remainder of the division of xxx by the specified value.
SFXMarginRef ModRightTop( SInt16 param )
Set the right margin and top margin to the remainder of the division of xxx by the specified value.
SFXMarginRef ModTop( SInt16 param )
Set the top margin to the remainder of the division of top margin by the specified value.
SFXMarginRef Mul( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Multiply the margins by the specified value.
SFXMarginRef Mul( SInt16 horizontal , SInt16 vertical )
Multiply the margins by the specified value.
SFXMarginRef Mul( SInt16 param )
Multiply the margins by the specified value.
SFXMarginRef MulBottom( SInt16 param )
Multiply the bottom margin by the specified value.
SFXMarginRef MulLeft( SInt16 param )
Multiply the left margin by the specified value.
SFXMarginRef MulLeftBottom( SInt16 width , SInt16 height )
Multiply the left margin and bottom margin by the specified value.
SFXMarginRef MulLeftBottom( SInt16 param )
Multiply the left margin and bottom margin by the specified value.
SFXMarginRef MulLeftTop( SInt16 width , SInt16 height )
Multiply the left margin and top margin by the specified value.
SFXMarginRef MulLeftTop( SInt16 param )
Multiply the left margin and top margin by the specified value.
SFXMarginRef MulRight( SInt16 param )
Multiply the right margin by the specified value.
SFXMarginRef MulRightBottom( SInt16 width , SInt16 height )
Multiply the right margin and bottom margin by the specified value.
SFXMarginRef MulRightBottom( SInt16 param )
Multiply the right margin and bottom margin by the specified value.
SFXMarginRef MulRightTop( SInt16 width , SInt16 height )
Multiply the right margin and top margin by the specified value.
SFXMarginRef MulRightTop( SInt16 param )
Multiply the right margin and top margin by the specified value.
SFXMarginRef MulTop( SInt16 param )
Multiply the top margin by the 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 the margin.
SFXMarginRef Set( SFXSizeConstRef lt , SFXSizeConstRef rb )
Set the margin.
SFXMarginRef Set( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Set the margin.
SFXMarginRef Set( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Set the margin.
SFXMarginRef Set( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Set the margin.
SFXMarginRef Set( SInt16 horizontal , SInt16 vertical )
Set the margin.
SFXMarginRef SetBottom( SInt16 param )
Set the bottom margin.
SFXMarginRef SetLeft( SInt16 param )
Set the left margin.
SFXMarginRef SetLeftBottom( SFXSizeConstRef param )
Set the left margin and bottom margin.
SFXMarginRef SetLeftBottom( SInt16 width , SInt16 height )
Set the left margin and bottom margin.
SFXMarginRef SetLeftTop( SFXSizeConstRef param )
Set the left margin and top margin.
SFXMarginRef SetLeftTop( SInt16 width , SInt16 height )
Set the left margin and top margin.
SFXMarginRef SetRight( SInt16 param )
Set the right margin.
SFXMarginRef SetRightBottom( SFXSizeConstRef param )
Set the right margin and bottom margin.
SFXMarginRef SetRightBottom( SInt16 width , SInt16 height )
Set the right margin and bottom margin.
SFXMarginRef SetRightTop( SFXSizeConstRef param )
Set the right margin and top margin.
SFXMarginRef SetRightTop( SInt16 width , SInt16 height )
Set the right margin and top margin.
SFXMarginRef SetTop( SInt16 param )
Set the top margin.
SFXMarginRef Sub( SFXMarginConstRef param )
Subtract the specified value from the margin.
SFXMarginRef Sub( SFXSizeConstRef lt , SFXSizeConstRef rb )
Subtract the specified value from the margin.
SFXMarginRef Sub( SFXSizeConstRef lt , SInt16 right , SInt16 bottom )
Subtract the specified value from the margin.
SFXMarginRef Sub( SInt16 left , SInt16 top , SFXSizeConstRef rb )
Subtract the specified value from the margin.
SFXMarginRef Sub( SInt16 left , SInt16 top , SInt16 right , SInt16 bottom )
Subtract the specified value from the margin.
SFXMarginRef Sub( SInt16 horizontal , SInt16 vertical )
Subtract the specified value from the margin.
SFXMarginRef SubBottom( SInt16 param )
Subtract the specified value from the bottom margin.
SFXMarginRef SubLeft( SInt16 param )
Subtract the specified value from the left margin.
SFXMarginRef SubLeftBottom( SFXSizeConstRef param )
Subtract the specified value from the left margin and bottom margin.
SFXMarginRef SubLeftBottom( SInt16 width , SInt16 height )
Subtract the specified value from the left margin and bottom margin.
SFXMarginRef SubLeftTop( SFXSizeConstRef param )
Subtract the specified value from the left margin and top margin.
SFXMarginRef SubLeftTop( SInt16 width , SInt16 height )
Subtract the specified value from the left margin and top margin.
SFXMarginRef SubRight( SInt16 param )
Subtract the specified value from the right margin.
SFXMarginRef SubRightBottom( SFXSizeConstRef param )
Subtract the specified value from the right margin and bottom margin.
SFXMarginRef SubRightBottom( SInt16 width , SInt16 height )
Subtract the specified value from the right margin and bottom margin.
SFXMarginRef SubRightTop( SFXSizeConstRef param )
Subtract the specified value from the right margin and top margin.
SFXMarginRef SubRightTop( SInt16 width , SInt16 height )
Subtract the specified value from the right margin and top margin.
SFXMarginRef SubTop( SInt16 param )
Subtract the 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 the specified value.
SFXMarginRef operator*=( SInt16 param )
Multiply the margin by the specified value.
SFXMarginRef operator+=( SFXMarginConstRef param )
Add the specified value to the margin.
SFXMarginRef operator-=( SFXMarginConstRef param )
Subtract the specified value from the margin.
SFXMarginRef operator/=( SInt16 param )
Divide the margin by the 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 )
Divide the margin by the specified value.
Bool operator==( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "==" relation.
SFXMargin operator-( Void )
Subtract the specified value from the margin.
SFXMargin operator-( SFXMarginConstRef left , SFXMarginConstRef right )
Subtract the specified value from the margin.
SFXMargin operator%( SFXMarginConstRef left , SInt16 right )
Set the margin to the remainder of the division of the margin by the specified value.
SFXMargin operator*( SFXMarginConstRef left , SInt16 right )
Multiply the margin by the specified value.
Bool operator!=( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "!=" relation.
SFXMargin operator+( Void )
Add the specified value to the margin.
SFXMargin operator+( SFXMarginConstRef left , SFXMarginConstRef right )
Add the 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 )
Divide the margin by the specified value.
Bool operator==( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "==" relation.
SFXMargin operator-( Void )
Subtract the specified value from the margin.
SFXMargin operator-( SFXMarginConstRef left , SFXMarginConstRef right )
Subtract the specified value from the margin.
SFXMargin operator%( SFXMarginConstRef left , SInt16 right )
Set the margin to the remainder of the division of the margin by the specified value.
SFXMargin operator*( SFXMarginConstRef left , SInt16 right )
Multiply the margin by the specified value.
Bool operator!=( SFXMarginConstRef left , SFXMarginConstRef right )
Check the "!=" relation.
SFXMargin operator+( Void )
Add the specified value to the margin.
SFXMargin operator+( SFXMarginConstRef left , SFXMarginConstRef right )
Add the specified value to the margin.

SFXMargin::SFXMargin
Constructor of the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 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 the specified value.
[ public ]
SFXMarginRef DivBottom(
    SInt16 param   // divide the bottom margin by this value
);

Description

The behaviour is not defined when the value of 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 the specified value.
[ public ]
SFXMarginRef DivLeft(
    SInt16 param   // divide the left margin by this value
);

Description

The behaviour is not defined when the value of 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 the 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 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 the 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 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 the specified value.
[ public ]
SFXMarginRef DivRight(
    SInt16 param   // divide the right margin by this value
);

Description

The behaviour is not defined when the value of 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 the 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 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 the 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 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 the specified value.
[ public ]
SFXMarginRef DivTop(
    SInt16 param   // divide the top margin by this value
);

Description

The behaviour is not defined when the value of 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 the 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 the 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 the specified value.
[ public ]
SFXMarginRef ModBottom(
    SInt16 param   // divide the bottom margin by this value
);

Description

The behaviour is not defined when the value of 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 the specified value.
[ public ]
SFXMarginRef ModLeft(
    SInt16 param   // divide the left margin by this value
);

Description

The behaviour is not defined when the value of 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 the 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 the 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

SFXMargin::AddLeftTop | SFXMargin::SubLeftTop | SFXMargin::MulLeftTop | SFXMargin::DivLeftTop | SFXMargin::ModTop | SFXMargin::ModLeft | SFXMargin::NegLeftTop


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

Description

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

Reference

SFXMargin::AddRight | SFXMargin::SubRight | SFXMargin::MulRight | SFXMargin::DivRight | SFXMargin::ModTop | SFXMargin::ModBottom | SFXMargin::ModLeft | SFXMargin::ModLeftTop | SFXMargin::ModRightTop | SFXMargin::ModLeftBottom | SFXMargin::ModRightBottom | SFXMargin::NegRight


SFXMargin::ModRightBottom
Set the right margin and bottom margin to the remainder of the division of the margins by the specified value.
[ public ]
SFXMarginRef ModRightBottom(
    SInt16 width    // divide the right margin by this value
    SInt16 height   // divide the bottom margin by this value
);
[ public ]
SFXMarginRef ModRightBottom(
    SInt16 param   // divide the right 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::AddRightBottom | SFXMargin::SubRightBottom | SFXMargin::MulRightBottom | SFXMargin::DivRightBottom | SFXMargin::ModBottom | SFXMargin::ModRight | SFXMargin::NegRightBottom


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

Description

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

Reference

SFXMargin::AddRightTop | SFXMargin::SubRightTop | SFXMargin::MulRightTop | SFXMargin::DivRightTop | SFXMargin::ModTop | SFXMargin::ModLeft | SFXMargin::ModRight | SFXMargin::NegRightTop


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

Description

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

Reference

SFXMargin::AddTop | SFXMargin::SubTop | SFXMargin::MulTop | SFXMargin::DivTop | SFXMargin::ModBottom | SFXMargin::ModLeft | SFXMargin::ModRight | SFXMargin::ModLeftTop | SFXMargin::ModRightTop | SFXMargin::ModLeftBottom | SFXMargin::ModRightBottom | SFXMargin::NegTop


SFXMargin::Mul
Multiply the margins by the specified value.
[ public ]
SFXMarginRef Mul(
    SInt16 left     // value to multiply with the left margin
    SInt16 top      // value to multiply with the top margin
    SInt16 right    // value to multiply with the right margin
    SInt16 bottom   // value to multiply with the  bottom margin
);
[ public ]
SFXMarginRef Mul(
    SInt16 horizontal   // value to multiply with the left margin and right margin
    SInt16 vertical     // value to multiply with the top margin and bottom margin
);
[ public ]
SFXMarginRef Mul(
    SInt16 param   // value to multiply with every margin
);

Reference

SFXMargin::Add | SFXMargin::Sub | SFXMargin::MulBottom | SFXMargin::MulLeft | SFXMargin::MulLeftBottom | SFXMargin::MulLeftTop | SFXMargin::MulRight | SFXMargin::MulRightBottom | SFXMargin::MulRightTop | SFXMargin::MulTop | SFXMargin::Div | SFXMargin::Mod | SFXMargin::Neg | operator* | SFXMargin::operator*=


SFXMargin::MulBottom
Multiply the bottom margin by the specified value.
[ public ]
SFXMarginRef MulBottom(
    SInt16 param   // value to multiply with the bottom margin
);

Reference

SFXMargin::AddBottom | SFXMargin::SubBottom | SFXMargin::MulTop | SFXMargin::MulLeft | SFXMargin::MulRight | SFXMargin::MulLeftTop | SFXMargin::MulRightTop | SFXMargin::MulLeftBottom | SFXMargin::MulRightBottom | SFXMargin::DivBottom | SFXMargin::ModBottom | SFXMargin::NegBottom


SFXMargin::MulLeft
Multiply the left margin by the specified value.
[ public ]
SFXMarginRef MulLeft(
    SInt16 param   // value to multiply with the left margin
);

Reference

SFXMargin::AddLeft | SFXMargin::SubLeft | SFXMargin::MulTop | SFXMargin::MulBottom | SFXMargin::MulRight | SFXMargin::MulLeftTop | SFXMargin::MulRightTop | SFXMargin::MulLeftBottom | SFXMargin::MulRightBottom | SFXMargin::DivLeft | SFXMargin::ModLeft | SFXMargin::NegLeft


SFXMargin::MulLeftBottom
Multiply the left margin and bottom margin by the specified value.
[ public ]
SFXMarginRef MulLeftBottom(
    SInt16 width    // value to multiply with the left margin
    SInt16 height   // value to multiply with the bottom margin
);
[ public ]
SFXMarginRef MulLeftBottom(
    SInt16 param   // value to multiply with the left margin and bottom margin
);

Reference

SFXMargin::AddLeftBottom | SFXMargin::SubLeftBottom | SFXMargin::MulBottom | SFXMargin::MulLeft | SFXMargin::DivLeftBottom | SFXMargin::ModLeftBottom | SFXMargin::NegLeftBottom


SFXMargin::MulLeftTop
Multiply the left margin and top margin by the specified value.
[ public ]
SFXMarginRef MulLeftTop(
    SInt16 width    // value to multiply with the  left margin
    SInt16 height   // value to multiply with the  top margin
);
[ public ]
SFXMarginRef MulLeftTop(
    SInt16 param   // value to multiply with the  left margin and top margin
);

Reference

SFXMargin::AddLeftTop | SFXMargin::SubLeftTop | SFXMargin::MulTop | SFXMargin::MulLeft | SFXMargin::DivLeftTop | SFXMargin::ModLeftTop | SFXMargin::NegLeftTop


SFXMargin::MulRight
Multiply the right margin by the specified value.
[ public ]
SFXMarginRef MulRight(
    SInt16 param   // value to multiply with the right margin
);

Reference

SFXMargin::AddRight | SFXMargin::SubRight | SFXMargin::MulTop | SFXMargin::MulBottom | SFXMargin::MulLeft | SFXMargin::MulLeftTop | SFXMargin::MulRightTop | SFXMargin::MulLeftBottom | SFXMargin::MulRightBottom | SFXMargin::DivRight | SFXMargin::ModRight | SFXMargin::NegRight


SFXMargin::MulRightBottom
Multiply the right margin and bottom margin by the specified value.
[ public ]
SFXMarginRef MulRightBottom(
    SInt16 width    // value to multiply with the  right margin
    SInt16 height   // value to multiply with the  bottom margin
);
[ public ]
SFXMarginRef MulRightBottom(
    SInt16 param   // value to multiply with the  right margin and bottom margin
);

Reference

SFXMargin::AddRightBottom | SFXMargin::SubRightBottom | SFXMargin::MulBottom | SFXMargin::MulRight | SFXMargin::DivRightBottom | SFXMargin::ModRightBottom | SFXMargin::NegRightBottom


SFXMargin::MulRightTop
Multiply the right margin and top margin by the specified value.
[ public ]
SFXMarginRef MulRightTop(
    SInt16 width    // value to multiply with the right margin
    SInt16 height   // value to multiply with the top margin
);
[ public ]
SFXMarginRef MulRightTop(
    SInt16 param   // value to multiply with the right margin and top margin
);

Reference

SFXMargin::AddRightTop | SFXMargin::SubRightTop | SFXMargin::MulTop | SFXMargin::MulLeft | SFXMargin::MulRight | SFXMargin::DivRightTop | SFXMargin::ModRightTop | SFXMargin::NegRightTop


SFXMargin::MulTop
Multiply the top margin by the specified value.
[ public ]
SFXMarginRef MulTop(
    SInt16 param   // value to multiply with the  top margin
);

Reference

SFXMargin::AddTop | SFXMargin::SubTop | SFXMargin::MulBottom | SFXMargin::MulLeft | SFXMargin::MulRight | SFXMargin::MulLeftTop | SFXMargin::MulRightTop | SFXMargin::MulLeftBottom | SFXMargin::MulRightBottom | SFXMargin::DivTop | SFXMargin::ModTop | SFXMargin::NegTop


SFXMargin::Neg
Negate the sign of the margin.
[ public ]
SFXMarginRef Neg(Void);

Reference

SFXMargin::Add | SFXMargin::Sub | SFXMargin::Mul | SFXMargin::Div | SFXMargin::Mod | SFXMargin::NegBottom | SFXMargin::NegLeft | SFXMargin::NegLeftBottom | SFXMargin::NegLeftTop | SFXMargin::NegRight | SFXMargin::NegRightBottom | SFXMargin::NegRightTop | SFXMargin::NegTop


SFXMargin::NegBottom
Negate the sign of the bottom margin.
[ public ]
SFXMarginRef NegBottom(Void);

Reference

SFXMargin::AddBottom | SFXMargin::SubBottom | SFXMargin::MulBottom | SFXMargin::DivBottom | SFXMargin::ModBottom | SFXMargin::NegTop | SFXMargin::NegLeft | SFXMargin::NegRight | SFXMargin::NegLeftTop | SFXMargin::NegRightTop | SFXMargin::NegLeftBottom | SFXMargin::NegRightBottom


SFXMargin::NegLeft
Negate the sign of the left margin.
[ public ]
SFXMarginRef NegLeft(Void);

Reference

SFXMargin::AddLeft | SFXMargin::SubLeft | SFXMargin::MulLeft | SFXMargin::DivLeft | SFXMargin::ModLeft | SFXMargin::NegTop | SFXMargin::NegBottom | SFXMargin::NegRight | SFXMargin::NegLeftTop | SFXMargin::NegRightTop | SFXMargin::NegLeftBottom | SFXMargin::NegRightBottom


SFXMargin::NegLeftBottom
Negate the sign of the left margin and bottom margin.
[ public ]
SFXMarginRef NegLeftBottom(Void);

Reference

SFXMargin::AddLeftBottom | SFXMargin::SubLeftBottom | SFXMargin::MulLeftBottom | SFXMargin::DivLeftBottom | SFXMargin::ModLeftBottom | SFXMargin::NegBottom | SFXMargin::NegLeft


SFXMargin::NegLeftTop
Negate the sign of the left margin and top margin.
[ public ]
SFXMarginRef NegLeftTop(Void);

Reference

SFXMargin::AddLeftTop | SFXMargin::SubLeftTop | SFXMargin::MulLeftTop | SFXMargin::DivLeftTop | SFXMargin::ModLeftTop | SFXMargin::NegTop | SFXMargin::NegLeft


SFXMargin::NegRight
Negate the sign of the right margin.
[ public ]
SFXMarginRef NegRight(Void);

Reference

SFXMargin::AddRight | SFXMargin::SubRight | SFXMargin::MulRight | SFXMargin::DivRight | SFXMargin::ModRight | SFXMargin::NegTop | SFXMargin::NegBottom | SFXMargin::NegLeft | SFXMargin::NegLeftTop | SFXMargin::NegRightTop | SFXMargin::NegLeftBottom | SFXMargin::NegRightBottom


SFXMargin::NegRightBottom
Negate the sign of the right margin and bottom margin.
[ public ]
SFXMarginRef NegRightBottom(Void);

Reference

SFXMargin::AddRightBottom | SFXMargin::SubRightBottom | SFXMargin::MulRightBottom | SFXMargin::DivRightBottom | SFXMargin::ModRightBottom | SFXMargin::NegBottom | SFXMargin::NegRight


SFXMargin::NegRightTop
Negate the sign of the right margin and top margin.
[ public ]
SFXMarginRef NegRightTop(Void);

Reference

SFXMargin::AddRightTop | SFXMargin::SubRightTop | SFXMargin::MulRightTop | SFXMargin::DivRightTop | SFXMargin::ModRightTop | SFXMargin::NegTop | SFXMargin::NegLeft | SFXMargin::NegRight


SFXMargin::NegTop
Negate the sign of the top margin.
[ public ]
SFXMarginRef NegTop(Void);

Reference

SFXMargin::AddTop | SFXMargin::SubTop | SFXMargin::MulTop | SFXMargin::DivTop | SFXMargin::ModTop | SFXMargin::NegBottom | SFXMargin::NegLeft | SFXMargin::NegRight | SFXMargin::NegLeftTop | SFXMargin::NegRightTop | SFXMargin::NegLeftBottom | SFXMargin::NegRightBottom


SFXMargin::Set
Set the margin.
[ public ]
SFXMarginRef Set(
    SFXMarginConstRef param   // source margin
);
[ public ]
SFXMarginRef Set(
    SFXSizeConstRef lt   // size of left margin and top margin to set
    SFXSizeConstRef rb   // size of right margin and bottom margin to set
);
[ public ]
SFXMarginRef Set(
    SFXSizeConstRef lt   // size of left margin and top margin to set
    SInt16 right         // width of right margin to set
    SInt16 bottom        // height of bottom margin to set
);
[ public ]
SFXMarginRef Set(
    SInt16 left          // width of left margin to set
    SInt16 top           // height of top margin to set
    SFXSizeConstRef rb   // size of right margin and bottom margin to set
);
[ public ]
SFXMarginRef Set(
    SInt16 left     // width of left margin to set
    SInt16 top      // height of top margin to set
    SInt16 right    // width of right margin to set
    SInt16 bottom   // height of bottom margin to set
);
[ public ]
SFXMarginRef Set(
    SInt16 horizontal   // width of left margin and right margin to set
    SInt16 vertical     // height of top margin and bottom margin to set
);

Reference

SFXMargin::operator=


SFXMargin::SetBottom
Set the bottom margin.
[ public ]
SFXMarginRef SetBottom(
    SInt16 param   // bottom margin to set
);

Reference

SFXMargin::GetBottom | SFXMargin::SetTop | SFXMargin::SetLeft | SFXMargin::SetRight | SFXMargin::SetLeftTop | SFXMargin::SetRightTop | SFXMargin::SetLeftBottom | SFXMargin::SetRightBottom


SFXMargin::SetLeft
Set the left margin.
[ public ]
SFXMarginRef SetLeft(
    SInt16 param   // left margin to set
);

Reference

SFXMargin::GetLeft | SFXMargin::SetTop | SFXMargin::SetBottom | SFXMargin::SetRight | SFXMargin::SetLeftTop | SFXMargin::SetRightTop | SFXMargin::SetLeftBottom | SFXMargin::SetRightBottom


SFXMargin::SetLeftBottom
Set the left margin and bottom margin.
[ public ]
SFXMarginRef SetLeftBottom(
    SFXSizeConstRef param   // size of left margin and bottom margin to set
);
[ public ]
SFXMarginRef SetLeftBottom(
    SInt16 width    // left margin to set
    SInt16 height   // bottom margin to set
);

Reference

SFXMargin::GetLeftBottom | SFXMargin::SetBottom | SFXMargin::SetLeft


SFXMargin::SetLeftTop
Set the left margin and top margin.
[ public ]
SFXMarginRef SetLeftTop(
    SFXSizeConstRef param   // left margin and top margin to set
);
[ public ]
SFXMarginRef SetLeftTop(
    SInt16 width    // width of left margin to set
    SInt16 height   // height of top margin to set
);

Reference

SFXMargin::GetLeftTop | SFXMargin::SetTop | SFXMargin::SetLeft


SFXMargin::SetRight
Set the right margin.
[ public ]
SFXMarginRef SetRight(
    SInt16 param   // right margin to set
);

Reference

SFXMargin::GetRight | SFXMargin::SetTop | SFXMargin::SetBottom | SFXMargin::SetLeft | SFXMargin::SetLeftTop | SFXMargin::SetRightTop | SFXMargin::SetLeftBottom | SFXMargin::SetRightBottom


SFXMargin::SetRightBottom
Set the right margin and bottom margin.
[ public ]
SFXMarginRef SetRightBottom(
    SFXSizeConstRef param   // size of right margin and bottom margin to set
);
[ public ]
SFXMarginRef SetRightBottom(
    SInt16 width    // width of right margin to set
    SInt16 height   // height of bottom margin to set
);

Reference

SFXMargin::GetRightBottom | SFXMargin::SetBottom | SFXMargin::SetRight


SFXMargin::SetRightTop
Set the right margin and top margin.
[ public ]
SFXMarginRef SetRightTop(
    SFXSizeConstRef param   // size of right margin and top margin to set
);
[ public ]
SFXMarginRef SetRightTop(
    SInt16 width    // width of right margin to set
    SInt16 height   // height of top margin to set
);

Reference

SFXMargin::GetRightTop | SFXMargin::SetTop | SFXMargin::SetLeft | SFXMargin::SetRight


SFXMargin::SetTop
Set the top margin.
[ public ]
SFXMarginRef SetTop(
    SInt16 param   // top margin to set
);

Reference

SFXMargin::GetTop | SFXMargin::SetBottom | SFXMargin::SetLeft | SFXMargin::SetRight | SFXMargin::SetLeftTop | SFXMargin::SetRightTop | SFXMargin::SetLeftBottom | SFXMargin::SetRightBottom


SFXMargin::Sub
Subtract the specified value from the margin.
[ public ]
SFXMarginRef Sub(
    SFXMarginConstRef param   // value to subtract from every margin
);
[ public ]
SFXMarginRef Sub(
    SFXSizeConstRef lt   // size of left margin and top margin
    SFXSizeConstRef rb   // size of right margin and bottom margin
);
[ public ]
SFXMarginRef Sub(
    SFXSizeConstRef lt   // left margin and top margin
    SInt16 right         // width of right margin
    SInt16 bottom        // height of bottom margin
);
[ public ]
SFXMarginRef Sub(
    SInt16 left          // width of left margin
    SInt16 top           // height of top margin
    SFXSizeConstRef rb   // size of right margin and bottom margin
);
[ public ]
SFXMarginRef Sub(
    SInt16 left     // width of left margin
    SInt16 top      // height of top margin
    SInt16 right    // width of right margin
    SInt16 bottom   // height of bottom margin
);
[ public ]
SFXMarginRef Sub(
    SInt16 horizontal   // width of left margin and right margin
    SInt16 vertical     // height of top margin and bottom margin
);

Reference

SFXMargin::Add | SFXMargin::SubBottom | SFXMargin::SubLeft | SFXMargin::SubLeftBottom | SFXMargin::SubLeftTop | SFXMargin::SubRight | SFXMargin::SubRightBottom | SFXMargin::SubRightTop | SFXMargin::SubTop | SFXMargin::Mul | SFXMargin::Div | SFXMargin::Mod | SFXMargin::Neg


SFXMargin::SubBottom
Subtract the specified value from the bottom margin.
[ public ]
SFXMarginRef SubBottom(
    SInt16 param   // height value to subtract from the bottom margin
);

Reference

SFXMargin::AddBottom | SFXMargin::SubTop | SFXMargin::SubLeft | SFXMargin::SubRight | SFXMargin::SubLeftTop | SFXMargin::SubRightTop | SFXMargin::SubLeftBottom | SFXMargin::SubRightBottom | SFXMargin::MulBottom | SFXMargin::DivBottom | SFXMargin::ModBottom | SFXMargin::NegBottom


SFXMargin::SubLeft
Subtract the specified value from the left margin.
[ public ]
SFXMarginRef SubLeft(
    SInt16 param   // value to subtract from the left margin
);

Reference

SFXMargin::AddLeft | SFXMargin::SubTop | SFXMargin::SubBottom | SFXMargin::SubRight | SFXMargin::SubLeftTop | SFXMargin::SubRightTop | SFXMargin::SubLeftBottom | SFXMargin::SubRightBottom | SFXMargin::MulLeft | SFXMargin::DivLeft | SFXMargin::ModLeft | SFXMargin::NegLeft


SFXMargin::SubLeftBottom
Subtract the specified value from the left margin and bottom margin.
[ public ]
SFXMarginRef SubLeftBottom(
    SFXSizeConstRef param   // size to subtract from the left margin and bottom margin
);
[ public ]
SFXMarginRef SubLeftBottom(
    SInt16 width    // width to subtract from the left margin
    SInt16 height   // height to subtract from the bottom margin
);

Reference

SFXMargin::AddLeftBottom | SFXMargin::SubBottom | SFXMargin::SubLeft | SFXMargin::MulLeftBottom | SFXMargin::DivLeftBottom | SFXMargin::ModLeftBottom | SFXMargin::NegLeftBottom


SFXMargin::SubLeftTop
Subtract the specified value from the left margin and top margin.
[ public ]
SFXMarginRef SubLeftTop(
    SFXSizeConstRef param   // value to subtract from the left margin and top margin
);
[ public ]
SFXMarginRef SubLeftTop(
    SInt16 width    // width to subtract from the left margin
    SInt16 height   // height to subtract from the top margin
);

Reference

SFXMargin::AddLeftTop | SFXMargin::SubTop | SFXMargin::SubLeft | SFXMargin::MulLeftTop | SFXMargin::DivLeftTop | SFXMargin::ModLeftTop | SFXMargin::NegLeftTop


SFXMargin::SubRight
Subtract the specified value from the right margin.
[ public ]
SFXMarginRef SubRight(
    SInt16 param   // width to subtract from the right margin
);

Reference

SFXMargin::AddRight | SFXMargin::SubTop | SFXMargin::SubBottom | SFXMargin::SubLeft | SFXMargin::SubLeftTop | SFXMargin::SubRightTop | SFXMargin::SubLeftBottom | SFXMargin::SubRightBottom | SFXMargin::MulRight | SFXMargin::DivRight | SFXMargin::ModRight | SFXMargin::NegRight


SFXMargin::SubRightBottom
Subtract the specified value from the right margin and bottom margin.
[ public ]
SFXMarginRef SubRightBottom(
    SFXSizeConstRef param   // to subtract from the right margin and bottom margin
);
[ public ]
SFXMarginRef SubRightBottom(
    SInt16 width    // width to subtract from the right margin
    SInt16 height   // height to subtract from the bottom margin
);

Reference

SFXMargin::AddRightBottom | SFXMargin::SubBottom | SFXMargin::SubRight | SFXMargin::MulRightBottom | SFXMargin::DivRightBottom | SFXMargin::ModRightBottom | SFXMargin::NegRightBottom


SFXMargin::SubRightTop
Subtract the specified value from the right margin and top margin.
[ public ]
SFXMarginRef SubRightTop(
    SFXSizeConstRef param   // value to subtract from the right margin and top margin
);
[ public ]
SFXMarginRef SubRightTop(
    SInt16 width    // width to subtract from the right margin
    SInt16 height   // height to subtract from the top margin
);

Reference

SFXMargin::AddRightTop | SFXMargin::SubTop | SFXMargin::SubLeft | SFXMargin::SubRight | SFXMargin::MulRightTop | SFXMargin::DivRightTop | SFXMargin::ModRightTop | SFXMargin::NegRightTop


SFXMargin::SubTop
Subtract the specified value from the top margin.
[ public ]
SFXMarginRef SubTop(
    SInt16 param   // height to subtract from the top margin
);

Reference

SFXMargin::AddTop | SFXMargin::SubBottom | SFXMargin::SubLeft | SFXMargin::SubRight | SFXMargin::SubLeftTop | SFXMargin::SubRightTop | SFXMargin::SubLeftBottom | SFXMargin::SubRightBottom | SFXMargin::MulTop | SFXMargin::DivTop | SFXMargin::ModTop | SFXMargin::NegTop


SFXMargin::ZeroInstance
Get the instance that represents 0.
[ public, static ]
SFXMarginConstRef ZeroInstance(Void);

Description

This function returns the 0 instance, which means that 0 or null is set to all the member variables of its corresponding AtomRec struct.

Example

SFXMargin margin(10, 20, 10, 30);

margin =  SFXMargin::ZeroInstance();   // initialize margin
TRACE("left = %d, top = %d, right = %d, bottom = %d", margin.GetLeft(), margin.GetTop(), margin.GetRight(), margin.GetBottom());  // left = 0, top = 0, right = 0, bottom = 0

Reference

SFXMargin::AtomRec


atomic_cast
Convert SFXMargin into SFXMargin::AtomRec.
[ public, friend ]
SFXMargin::AtomRec * atomic_cast(
    SFXMargin * param   // margin to cast
);
[ public, friend ]
SFXMargin::AtomRec const * atomic_cast(
    SFXMargin const * param   // margin to cast
);

Reference

SFXMargin::AtomRec


SFXMargin::operator=
Assign a margin.
[ public ]
SFXMarginRef operator=(
    SFXMarginConstRef param   // source margin
);

Reference

SFXMargin::Set


SFXMargin::operator/=
Divide the margin by the specified value.
[ public ]
SFXMarginRef operator/=(
    SInt16 param   // divide every margin by this value
);

Description

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

Reference

SFXMargin::Div | operator/ | SFXMargin::operator*= | SFXMargin::operator%=


operator/
Divide the margin by the specified value.
[ public, friend ]
SFXMargin operator/(
    SFXMarginConstRef left   // SFXMargin object to divide
    SInt16 right             // divide every margin by this value
);

Description

The operation when the right is 0 has not been defined yet.

Reference

SFXMargin::Div | SFXMargin::operator/= | operator* | operator%


operator==
Check the "==" relation.
[ public, friend ]
Bool operator==(
    SFXMarginConstRef left    // margin to compare
    SFXMarginConstRef right   // margin to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXMargin::Equals | operator!=


SFXMargin::operator-=
Subtract the specified value from the margin.
[ public ]
SFXMarginRef operator-=(
    SFXMarginConstRef param   // value to subtract from every margin
);

Reference

operator- | SFXMargin::operator+=


operator-
Subtract the specified value from the margin.
[ public, const ]
SFXMargin operator-(Void);
[ public, friend ]
SFXMargin operator-(
    SFXMarginConstRef left    // the target SFXMargin object
    SFXMarginConstRef right   // to subtract from every margin
);

Reference

SFXMargin::operator-= | operator+


SFXMargin::operator%=
Set the margin to the remainder of the division of the margin by the specified value.
[ public ]
SFXMarginRef operator%=(
    SInt16 param   // divide every margin by this value
);

Description

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

Reference

SFXMargin::Mod | SFXMargin::operator/= | SFXMargin::operator*= | operator%


operator%
Set the margin to the remainder of the division of the margin by the specified value.
[ public, friend ]
SFXMargin operator%(
    SFXMarginConstRef left   // SFXMargin object to divide
    SInt16 right             // divide every margin by this value
);

Description

The operation when the right is 0 has not been defined yet.

Reference

SFXMargin::Mod | operator/ | operator* | SFXMargin::operator%=


SFXMargin::operator*=
Multiply the margin by the specified value.
[ public ]
SFXMarginRef operator*=(
    SInt16 param   // value to multiply with the  every margin
		
);

Reference

SFXMargin::Mul | SFXMargin::operator/= | operator* | SFXMargin::operator%=


operator*
Multiply the margin by the specified value.
[ public, friend ]
SFXMargin operator*(
    SFXMarginConstRef left   // SFXMargin object to multiply 
    SInt16 right             // value to multiply with every margin
);

Reference

SFXMargin::Mul | operator/ | SFXMargin::operator*= | operator%


operator!=
Check the "!=" relation.
[ public, friend ]
Bool operator!=(
    SFXMarginConstRef left    // margin to compare
    SFXMarginConstRef right   // margin to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXMargin::Equals | operator==


SFXMargin::operator+=
Add the specified value to the margin.
[ public ]
SFXMarginRef operator+=(
    SFXMarginConstRef param   // value to add to every margin
);

Reference

SFXMargin::operator-= | operator+


operator+
Add the specified value to the margin.
[ public, const ]
SFXMargin operator+(Void);
[ public, friend ]
SFXMargin operator+(
    SFXMarginConstRef left    // the target SFXMargin object
    SFXMarginConstRef right   // value to add to every margin
);

Reference

operator- | SFXMargin::operator+=


SFXMargin::AtomRec
Structure that represents a margin.
struct AtomRec {
  SInt16  left;    // left margin
  SInt16  top;     // top margin
  SInt16  right;   // right margin
  SInt16  bottom;  // bottom margin
};