Inheritance diagram

Collaboration diagram

Description

How to use

SFYBevelFrame is the abstract base class to define and implement a user-defined bevel frame.

Bevel frame is a frame which consists of a shadow region, a flat frame region, and a bevel region as the figure below.

Figure 268. Bevel frame

The union set of the shadow region(bottom edge and right edge of 1 pixel width), the flat frame region(1 pixel width), and the bevel frame region(1 pixel width) in the figure is the frame margin of bevel frame. [i.e., SFXMargin(2, 2, 3, 3)].

In the SFYBevelFrame class, settings of bevel color(SFXBevelColor) of bevel frame region of 1 pixel width and drawing of this region is done.

Figure 269. Bevel frame: Expanded Figure

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

Each width of the shadow region, the flat frame region, and the bevel 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.)
3. The bevel frame region is drawn by calling the SFYBevelFrame::DrawBevel function. (The color of flat frame region is set with the SFYBevelFrame::SetBevelColor 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 | SFYPlainFrame | SFYFlatFrame | SFZBevelFrame | SFZTitleBevelFrame | SFXMargin | Real Region | SFYResponder::GetSuitableMargin | Frame

Member

Description

This constructor performs the initializations as follows:

Reference

SFYResponder::SetType | SFYBevelFrame::CodeEnum | SFYBevelFrame::SetBevelColor | SFYBevelFrame::SetBevelEnable | SFXBevelColor | SFXRGBColor Type

Description

This destructor does nothing.

Return value

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

Description

This function draws the bevel frame region of bevel frame.

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

The default implementation is as below.

This function draws the bevel frame region of bevel frame in the bevel color set with the SFYBevelFrame::SetBevelColor function, and then retruns the rectangular region obtained by excluding the bevel frame region from the rectangular region specified in the argument.

The bevel frame region of bevel frame can be obtained by calling the SFYBevelFrame::GetBevelMargin function.

	The color of bevel frame region in the "inactive" state
	In the "inactive" state, the light color and the dark color of bevel color(SFXBevelColor) is set with the base color of bevel color. Since the bevel frame region is drawn only in the base color, it will be the 2D looking region.

Figure 270. Bevel frame: Expanded Figure

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

Each width of the shadow region, the flat frame region, and the bevel 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.)
3. The bevel frame region is drawn by calling the SFYBevelFrame::DrawBevel function. (The color of flat frame region is set with the SFYBevelFrame::SetBevelColor function.)

Internal Implementation

Internal implementation of the SFYBevelFrame::DrawBevel function is as follows:

/*protected */SFXRectangle SFYBevelFrame::DrawBevel(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SFXBevelColor                               bevel;
    SFXRectangle                                result(rectangle);

    if (_bevelEnable) {
        bevel.Set(_color.bevel);
        if (!GetStateActive(true)) {
            bevel.SetLight(bevel.GetBase());
            bevel.SetDark(bevel.GetBase());
        }
        graphics->DrawBevelRectangle(result, bevel);
        result.Deflate(1, 1);
    }
    return result;
}// SFYBevelFrame::DrawBevel //

Reference

SFYBevelFrame::SetBevelColor | SFYBevelFrame::GetBevelMargin | SFXBevelColor | SFXRGBColor | SFXRectangle | State

Return value

Bevel color of bevel frame region.

Description

This function gets the bevel color of bevel frame region.

Reference

SFYBevelFrame::SetBevelColor | SFYBevelFrame::DrawBevel | SFXBevelColor | SFXRGBColor

Return value

Description

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

Reference

SFYBevelFrame::SetBevelEnable | SFYBevelFrame::GetBevelMargin

Return value

Margin of bevel frame region.

Description

This function gets the margin of bevel frame region.

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

Otherwise SFXMargin::EmptyInstance will be returned.

Reference

SFYBevelFrame::DrawBevel | SFXMargin

Description

This function sets the color(SFXBevelColor) of bevel frame region to the specified value.

Default setting is as follows:

static SFXBevelColor::AtomRecConst bevel[] = {
      {{{{0x00, 0xFF, 0xFF, 0xFF}}},     // light color
      {{{0x00, 0xEE, 0xEE, 0xEE}}},      // base color
      {{{0x00, 0x99, 0x99, 0x99}}}}      // dark color
};

	The color of bevel frame region in the "inactive" state
	In the "inactive" state, the light color and the dark color of bevel color(SFXBevelColor) is set with the base color of bevel color. Since the bevel frame region is drawn only in the base color, it will be the 2D looking region.

Reference

SFYBevelFrame::GetBevelColor | SFYBevelFrame::DrawBevel | SFXBevelColor | SFXRGBColor | State

Description

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

Reference

SFYBevelFrame::GetBevelEnable | SFYBevelFrame::GetBevelMargin

Reference

SFYResponder::GetType | SFYResponder::SetType