SFRFrameFrame

Responder which represents a frame with simple frame.

#include <SFRFrameFrame.hpp>

class SFRFrameFrame : public SFRFrame;

SFMTYPEDEFCLASS(SFRFrameFrame)

Inheritance diagra

Collaboration diagram

Reference

SFRFrame | SFRFrameDialog | SFRFrameWindow

Member

Constructor/Destructor
SFRFrameFrame( `SFRResponderPtr` parent ) Constructor of the SFRFrameFrame class.
~SFRFrameFrame( `Void` ) Destructor of the SFRFrameFrame class.

Public Functions
`SFXRGBColorConstRef`	GetColor( `ColorType` index ) Get the color.
static `SFXMargin`	GetMargin( `Void` ) Get the margin between base and content region (in pixels).
`Void`	SetColor( `ColorType` index , `SFXRGBColorConstRef` color ) Set the color

Protected Functions
static `SFXRectangle`	AdjustBound( `SFXRectangleConstRef` rect ) Adjust the coordinate of region.
`Void`	BaseHandler( `SFXGraphicsPtr` g ) [Handler] Redraw the base region of responder.
`SFCError`	MakeHandler( `Void` ) Redraw the base region of responder.
`SFXRectangle`	AdjustBound( `SFXRectangleConstRef` rect , `AEEFont` font ) (inherits from SFRTitleFrame) Adjust the coordinate of region.
`Void`	ContentHandler( `SFXGraphicsPtr` g ) (inherits from SFRFrame) [Handler] Redraw the content region.
`SFRResponderPtr`	GetResponder( `Void` ) (inherits from SFRFrame) Get the responder.

Types
ColorEnum Constant that represents a specific part.

SFRFrameFrame::SFRFrameFrame

Constructor of the SFRFrameFrame class.

[ protected ]
SFRFrameFrame(
    SFRResponderPtr parent   // parent responder
);

Reference

SFRFrameFrame::~SFRFrameFrame

SFRFrameFrame::~SFRFrameFrame

Destructor of the SFRFrameFrame class.

[ protected, virtual ]
~SFRFrameFrame(Void);

Reference

SFRFrameFrame::SFRFrameFrame

SFRFrameFrame::AdjustBound

Adjust the coordinate of region.

[ protected, static ]
SFXRectangle AdjustBound(
    SFXRectangleConstRef rect   // the coordinate of region to adjust
);

SFRFrameFrame::BaseHandler

[Handler] Redraw the base region of responder.

[ protected ]
Void BaseHandler(
    SFXGraphicsPtr g   // SFXGraphics instance
);

Description

The SFRFrameFrame::BaseHandler function paints over parts of responder with a frame defined by the SFRFrameFrame::ColorEnum.

Each color of parts depends upon the Behaviour status of responder like the following table:

Parts \| Status of Behaviour	Targeted	Enable and Not-Focused	Not-Enable
COLOR_FRAME: four inner-edges of base region	purple defined by `SFXRGBColor`(0x66, 0x66, 0xFF, 0x00)	black defined by `SFXRGBColor`(0x00, 0x00, 0x00, 0x00)	gray defined by `SFXRGBColor`(0x44, 0x44, 0x44, 0x00)
COLOR_TARGET: bottom and right outer-edges of base region	black defined by `SFXRGBColor`(0x00, 0x00, 0x00, 0x00)	black defined by `SFXRGBColor`(0x00, 0x00, 0x00, 0x00)	gray defined by `SFXRGBColor`(0x44, 0x44, 0x44, 0x00)

Reference: Behaviour

Reference

SFXGraphics

SFRFrameFrame::GetColor

Get the color.

[ public, const ]
SFXRGBColorConstRef GetColor(
    ColorType index   // palette index
);

Argument

index: Specify the palette index of SFRFrameFrame::ColorEnum type.

Description

The behavior is not defined when the specified palette index is invalid.

Reference

SFRFrameFrame::SetColor | SFRFrameFrame::ColorEnum

SFRFrameFrame::GetMargin

Get the margin between base and content region (in pixels).

[ public, static ]
SFXMargin GetMargin(Void);

SFRFrameFrame::MakeHandler

Redraw the base region of responder.

[ protected ]
SFCError MakeHandler(Void);

Return value

If succeeds: SFERR_NO_ERROR
If insufficient memory: SFERR_NO_MEMORY

SFRFrameFrame::SetColor

Set the color

[ public ]
Void SetColor(
    ColorType index             // palette index
    SFXRGBColorConstRef color   // color
);

Argument

index: Specify the palette index of SFRFrameFrame::ColorEnum type.
color: Specity the color.

Description

The behavior is not defined when the specified palette index is invalid.

Reference

SFRFrameFrame::GetColor | SFRFrameFrame::ColorEnum

SFRFrameFrame::ColorEnum

Constant that represents a specific part.

enum ColorEnum {
  COLOR_FRAME = 0,  // four inner-edges of base region
  COLOR_TARGET      // bottom and right outer-edges of base region
};

Description

SFRFrameFrame::ColorEnum is used to set or get the color of specific part of SFRFrameFrame object.

Reference

SFRFrameFrame::SetColor | SFRFrameFrame::GetColor