Inheritance diagram

Collaboration diagram

Description

How to use

SFYPlainFrame is the abstract base class to define and implement a user-defined plain frame.

Plain frame is a frame which consists of a shadow region as the figure below.

Figure 298. Plain frame

The shadow region is the frame margin of plain frame. [i.e., SFXMargin(0, 0, 1, 1)]

Figure 299. Plain frame: Expanded Figure

The region (shadow region) where the black line is drawn is the frame margin of plain frame. And the rectangular region surrounded by the frame margin is the content region.

The width of the shadow region is 1 pixel.

1. The shadow region is drawn by calling the SFYPlainFrame::DrawShadow function. (The color of shadow region is set with the SFYPlainFrame::SetShadowColor function.)

	How to get a frame margin
	The frame margin of frame responder can be obtained by calling the SFYResponder::GetSuitableMargin function.

	Responder with a frame
	A window or dialog with a frame can be implemented by calling its SFYResponder::SetFrame function. A real region of a window or dialog is the content region surrounded by the frame margin.

Reference

SFYFrame | SFYFlatFrame | SFYBevelFrame | SFZPlainFrame | SFZFlatFrame | SFZBevelFrame | SFZTitlePlainFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | SFXMargin | Real Region | SFYResponder::GetSuitableMargin | Frame

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYPlainFrame::CodeEnum | SFYPlainFrame::SetShadowColor | SFYPlainFrame::SetShadowEnable | SFXRGBColor Type

Description

This destructor does nothing.

Return value

The rectangular region obtained by excluding the shadow region from the rectangular region specified in the argument.

Description

This function draws the shadow region of plain frame.

In case you want to perform your own processing, override this function.

The default implementation is as below.

This function draws the shadow region of plain frame in the color set with the SFYPlainFrame::SetShadowColor function, and then retruns the rectangular region obtained by excluding the shadow region from the rectangular region specified in the argument.

The shadow region of plain frame can be obtained by calling the SFYPlainFrame::GetShadowMargin function.

The color of shadow region in the "inactive" state

In the "inactive" state, the shadow region will be filled in the color of which each RGB value is subtracted 0x44 form the color set with the SFYPlainFrame::SetShadowColor function if the brightness of this color is greater than 0x7F. Otherwise it will be filled in the color of which each RGB value is added 0x44 on the color set with the SFYPlainFrame::SetShadowColor function. The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

Figure 300. Plain frame: Expanded Figure

The region (shadow region) where the black line is drawn is the frame margin of plain frame. And the rectangular region surrounded by the frame margin is the content region.

The width of the shadow region is 1 pixel.

1. The shadow region is drawn by calling the SFYPlainFrame::DrawShadow function. (The color of shadow region is set with the SFYPlainFrame::SetShadowColor function.)

Internal Implementation

Internal implementation of the SFYPlainFrame::DrawShadow function is as follows:

/*protected */SFXRectangle SFYPlainFrame::DrawShadow(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXRGBColor                                 rgb;
    SFXRectangle                                result(rectangle);

    if (_shadowEnable) {
        rgb.Set(_color.shadow);
        if (!GetStateActive(true)) {
            if (rgb.GetBrightness() > 0x7F) {
                rgb.SubRGB(0x44);
            }
            else {
                rgb.AddRGB(0x44);
            }
        }
        graphics->SetForeColor(rgb);
        graphics->DrawLine(result.GetEdgeRight());
        graphics->DrawLine(result.GetEdgeBottom());
        result.SubRightBottom(1, 1);
    }
    return result;
}// SFYPlainFrame::DrawShadow //

Reference

SFYPlainFrame::SetShadowColor | SFYPlainFrame::GetShadowMargin | SFXRGBColor | SFXRectangle | SFXRGBColor::GetBrightness | State

Return value

Color of shadow region.

Reference

SFYPlainFrame::SetShadowColor

Return value

Description

This function gets the value of flag indicating whether or not the shadow region is enabled.

Reference

SFYPlainFrame::SetShadowEnable | SFYPlainFrame::GetShadowMargin

Return value

Margin of shadow region.

Description

This function gets the margin of shadow region.

If the shadow region is enabled, SFXMargin(0, 0, 1, 1)[bottom edge and right edge of the region] will be returned.

Otherwise SFXMargin::EmptyInstance will be returned.

Reference

SFXMargin | SFYPlainFrame::DrawShadow | SFYPlainFrame::SetShadowColor

Description

This function sets the color of shadow region to the specified value.

Default: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[black color]

	Note
	Shadow region is the margin which is obtained by calling the SFYPlainFrame::GetShadowMargin function.

In the "inactive" state, the text will be drawn in the color of which each RGB value is subtracted 0x44 from the color set with this function if the brightness of this color is greater than 0x7F. Otherwise it will be drawn in the color of which each RGB value is added 0x44 on the color set with this function.

The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

Reference

SFYPlainFrame::GetShadowColor | SFYPlainFrame::GetShadowMargin | SFYPlainFrame::DrawShadow | SFXRGBColor | SFXRGBColor::GetBrightness | State

Description

This function sets the flag indicating whether or not the shadow region is enabled to the specified value.

Reference

SFYPlainFrame::GetShadowEnable | SFYPlainFrame::GetShadowMargin

Reference

SFYResponder::GetType | SFYResponder::SetType