Inheritance diagram

Collaboration diagram

Description

How to use

SFYFlatFrame is the abstract base class to define and implement a user-defined flat frame.

Flat frame is a frame which consists of a shadow region and a flat frame region as the figure below.

Figure 291. Flat frame

The union set of the shadow region and the flat frame region is the frame margin of flat frame. [i.e., SFXMargin(1, 1, 2, 2)]

Figure 292. Flat frame: Expanded Figure

The black line is the shadow region, and the blue line(default: black) is the flat frame region. The union set of these two regions is the frame margin of flat frame. And the rectangular region surrounded by the frame margin is the content region.

Each width of the shadow region and the flat frame 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.)
2. The flat frame region is drawn by calling the SFYFlatFrame::DrawFrame function. (The color of flat frame region is set with the SFYFlatFrame::SetFrameColor and SFYFlatFrame::SetFocusColor functions.)

	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 | SFYPlainFrame | SFYBevelFrame | SFZFlatFrame | SFZBevelFrame | SFZTitleFlatFrame | SFZTitleBevelFrame | SFXMargin | Real Region | SFYResponder::GetSuitableMargin | Frame

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYFlatFrame::CodeEnum | SFYFlatFrame::SetFocusColor | SFYFlatFrame::SetFrameColor | SFYFlatFrame::SetFrameEnable | SFXRGBColor Type

Description

This destructor does nothing.

Return value

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

Description

This function draws the flat frame region of flat frame.

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

The default implementation is as below.

This function draws the flat frame region of flat frame region in the color set with the SFYFlatFrame::SetFrameColor or SFYFlatFrame::SetFrameColor function, and then retruns the rectangular region obtained by excluding the flat frame region from the rectangular region specified in the argument.

In the focused state, it will be drawn in the color set with the SFYFlatFrame::SetFocusColor function. Otherwise it will be drawn in the color set with the SFYFlatFrame::SetFrameColor function.

The flat frame region of flat frame can be obtained by calling the SFYFlatFrame::GetFrameMargin function.

	The color of flat frame region in the "inactive" state
	In the "inactive" state, the flat frame 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.

Figure 293. Flat frame: Expanded Figure

The black line is the shadow region, and the blue line(default: black) is the flat frame region. The union set of these two region is the frame margin of flat frame. And the rectangular region surrounded by the frame margin is the content region.

Each width of the shadow region and the flat frame 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.)
2. The flat frame region is drawn by calling the SFYFlatFrame::DrawFrame function. (The color of flat frame region is set with the SFYFlatFrame::SetFrameColor and SFYFlatFrame::SetFocusColor functions.)

Internal Implementation

Internal implementation of the SFYFlatFrame::DrawFrame function is as follows:

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

    if (_frameEnable) {
        rgb.Set((GetStateFocus(true)) ? (_color.focus) : (_color.frame));
        if (!GetStateActive(true)) {
            if (rgb.GetBrightness() > 0x7F) {
                rgb.SubRGB(0x44);
            }
            else {
                rgb.AddRGB(0x44);
            }
        }
        graphics->DrawRectangle(result, rgb);
        result.Deflate(1, 1);
    }
    return result;
}// SFYFlatFrame::DrawFrame //

Reference

SFYFlatFrame::SetFrameColor | SFYFlatFrame::SetFocusColor | SFYFlatFrame::GetFrameMargin | SFXRGBColor | SFXRectangle | State

Return value

Color of flat frame region in the "focus" state.

Reference

SFYFlatFrame::SetFocusColor

Return value

Color of flat frame region in the "unfocus" state.

Reference

SFYFlatFrame::SetFrameColor

Return value

Description

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

Reference

SFYFlatFrame::SetFrameEnable | SFYFlatFrame::GetFrameMargin

Return value

Margin of flat frame region.

Description

This function gets the margin of flat frame region.

If the flat frame region is enabled, SFXMargin(1, 1, 1, 1) [i.e., four edges of the rectangle that the shadow region is excluded from the flat frame] will be returned.

Otherwise SFXMargin::EmptyInstance will be returned.

Reference

SFYFlatFrame::DrawFrame | SFXMargin

Description

This function sets the color(SFXRGBColor) of flat frame region when the flat frame is in the "focus" state to the specified value.

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

	The color of flat frame region in the "focus" state
	When In the focused state, the flat frame region will be drawn in the color set with the SFYFlatFrame::SetFocusColor function. It will not be drawn in the color set with the SFYFlatFrame::SetFrameColor function.

Reference

SFYFlatFrame::GetFocusColor | SFYFlatFrame::SetFrameColor | SFYFlatFrame::DrawFrame | SFXRGBColor | State

Description

This function sets the color(SFXRGBColor) of flat frame region when the flat frame is in the "unfocus" state to the specified value.

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

The color of flat frame region in the "inactive" state

In the "inactive" state, the flat frame region 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.

	The color of flat frame region in the "focus" state
	When In the focused state, the flat frame region will be drawn in the color set with the SFYFlatFrame::SetFocusColor function. It will not be drawn in the color set with the SFYFlatFrame::SetFrameColor function.

Reference

SFYFlatFrame::GetFrameColor | SFYFlatFrame::SetFocusColor | SFYFlatFrame::DrawFrame | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

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

Reference

SFYFlatFrame::GetFrameEnable | SFYFlatFrame::GetFrameMargin

Reference

SFYResponder::GetType | SFYResponder::SetType