Inheritance diagram

Collaboration diagram

Description

How to use

Plain frame with a title is a frame which consists of a shadow region and a header region for title.

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

Figure 402. Plain frame with a title [SFZTitlePlainFrame]

The union of the shadow region and the header region for title is the frame margin of plain frame with a title.

Figure 403. Plain frame with a title: Expanded Figure[SFZTitlePlainFrame]

The black line is the shadow region and the bevel color rectangular region in gray where the "Title" string is drawn at the center is the header region. The union set of these two regions is the frame margin of bevel frame with a title. And the rectangular region surrounded by the frame margin is the content region.

The height of the header region "HeaderHeight" is given as below.

HeaderHeight = FontHeight + 2 * FrameMarginSize

FontHeight      : height of font
FrameMarginSize : margin of the header region set with SetFrameSize() [by default, 1 pixel]

The width of the header region "HeaderWidth" is given as below.

HeaderWidth = SFZTitleFlatFrameWidth - ShadowWidth

SFZTitlePlainFrameWidth  : width of local region of this SFZTitlePlainFrame instance
ShadowWidth              : width of shadow region [1 pixel]

The background of the header region is filled in the color(SFXRGBColor) set with the SFZTitlePlainFrame::SetHeaderColor function.

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.)
2. The header region is drawn by calling the SFZTitlePlainFrame::DrawHeader function. (The color of the header region is set with the SFZTitlePlainFrame::SetHeaderColor 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.

// define the class
SFMTYPEDEFCLASS(USRApplication)
class USRApplication : public SFYApplication {
  SFMSEALCOPY(USRApplication)
public:
  static SFCInvokerPtr Factory(Void);
private:
  explicit USRApplication(Void) static_throws;
  virtual ~USRApplication(Void);

  XANDLER_DECLARE_VOIDRENDER(OnRenderRequestSFZWindow) // drawing handler
  XANDLER_DECLARE_BOOLEVENT(OnKeySFZWindow)            // key handler of the window
};


// constructor
USRApplication::USRApplication(Void) static_throws
{
  // ... (omitted) ...

  SFZTitlePlainFrameSmp frame;  // smart pointer to SFZTitlePlainFrame
  SFZWindowSmp          window; // smart pointer to SFZWindow
  SFCError              error(SFERR_NO_ERROR);

  // create the frame
  if ((frame = SFZTitlePlainFrame::NewInstance(&error)) != null) {

    // set the frame's title
    frame->SetText("Title for SFZWindow");

    // In general, the frame's state is set to "visible" + "active" + "enable" + "focus".
    frame->SetState(true, true, true, true);

    // create the window
    if ((window = SFZWindow::NewInstance(&error)) != null) {

      // register the drawing handler into window: draw "Hello World!"
      error = window->RegisterHandler(
        SFXEventRange(SFEVT_RESPONDER_RENDER, SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, SFP16_RENDER_REQUEST),
        XANDLER_INTERNAL(OnRenderRequestSFZWindow)
      );
      if (error == SFERR_NO_ERROR) {

        // register the key handler into the window: close the frame when the SELECT key is pressed
        error = window->RegisterHandler(
          SFXEventRange(SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END),
          XANDLER_INTERNAL(OnKeySFZWindow)
        );
        if (error == SFERR_NO_ERROR) { 

          // set the window's parent responder to the application class(root)
          error = window->SetParent(GetThis());
          if (error == SFERR_NO_ERROR) {

            // attach the frame to the window
            error = window->SetFrame(frame);
            if (error == SFERR_NO_ERROR) {

              // Set the frame's real region to the region obtained by deflating the screen device region by (30, 30)
              // * Automatically, the window's real region will be set to the region obtained by deflating it by the frame margin.
              frame->SetRealBound(GetLocalBound().Deflate(30, 30));

              // set the window's state to "visible" + "active" + "enable" + "focus" together
              window->SetState(true, true, true, true);

              // move the window foremost
              // * automatically, the frame will be moved foremost together
              window->ToFront();
            }
          }
        }
      }
    }
  }
  static_throw(error);
}


// implement the drawing handler of SFZWindow
#define TROPICALBLUE_COLOR (SFXRGBColor(0xCE, 0xD8, 0xF8, 0x00))
#define COLOR_BLACK        (SFXRGBColor(0x00, 0x00, 0x00, 0x00))
XANDLER_IMPLEMENT_VOIDRENDER(helloworld, OnRenderRequestSFZWindow, invoker, reason, graphics)
{
  unused(invoker);
  unused(reason);

  // fill the window's local region in tropical bule color
  graphics->FillRectangle(GetLocalBound(), TROPICALBLUE_COLOR);

  // draw "Hello World!" in black at the center of the window
  graphics->DrawSingleText("Hello World!", invoker->GetLocalBound(), COLOR_BLACK);

  return;
}

// implement the key handler of SFZWindow
XANDLER_IMPLEMENT_BOOLEVENT(helloworld, OnKeySFZWindow, invoker, event)
{
  Bool result(false);
  unused(invoker);

  switch (event.GetP16()) {

    case AVK_SELECT:  // when the SELECT key is pressed

         // close the window only
         // * automatically, the frame will be detached from the window and become invisible
         invoker->Terminate();

         result = true;  // "true" is set since the event has been handled

         break;
  }

  return result;
}

Figure 404. Execution result of the sample code: attach a frame to a window [SFZTitlePlainFrame and SFZWindow]

Reference

SFZPlainFrame | SFYPlainFrame | SFYFrame | Real Region | SFYSingleTextWidget | SFYResponder::GetSuitableMargin | Frame | SFYResponder::ToFront | SFYResponder::Terminate

Member

Description

This constructor performs the initializations as follows:

	Note
	In a responder inheriting from SFZTitlePlainFrame, the corresponding handler will be called when one of the above events occurs.

Reference

SFYResponder::SetType | SFZTitlePlainFrame::CodeEnum | SFZTitlePlainFrame::SetFrameSize | SFZTitlePlainFrame::SetHeaderColor | SFZTitlePlainFrame::GetWidget | SFYResponder::SetState | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetFont | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetScrollDirection | SFZTitlePlainFrame::SetScrollInterval | SFZTitlePlainFrame::SetScrollStep | SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::SetWaitInterval | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFYSingleTextWidget | SFXRGBColor Type | State | Event | State Event[SFEVT_RESPONDER_STATE]

Description

This destructor does nothing.

Description

This function fills the header region of this frame in the color set with the SFZTitlePlainFrame::SetHeaderColor function.

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

Internal Implementation

Internal implementation of the SFZTitlePlainFrame::DrawHeader function is as follows:

/*protected */Void SFZTitlePlainFrame::DrawHeader(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    graphics->FillRectangle(rectangle, _color.header);
    return;
}// SFZTitlePlainFrame::DrawHeader //

Reference

SFZTitlePlainFrame::SetHeaderColor | SFXRGBColor

Description

This function gets the title font.

Reference

SFZTitlePlainFrame::SetFont

Return value

The margin between the border of the header region and the title string. [pixels]

Reference

SFZTitlePlainFrame::SetFrameSize

Return value

Header region of this frame.

Description

This function gets the header region to display title of this frame.

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

The default implementation is as follows:

The width of the header is that of the plain frame with a title excluded the shadow region.

The height of the header is the value set with the SFZTitlePlainFrame::SetFrameSize function multiplied by 2 and added by the height of the font.

This function is called in the SFZTitlePlainFrame::HandleMarginRequest function to calculate the header region.

Figure 405. Plain frame with a title: Expanded Figure[SFZTitlePlainFrame]

Reference

SFZTitlePlainFrame::HandleMarginRequest | SFZTitlePlainFrame::SetFrameSize

Return value

Color of the header region of this frame(SFXRGBColor).

Reference

SFZTitlePlainFrame::SetHeaderColor | SFXRGBColor

Return value

Value of horizontal alignment of the title.

Reference

SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::HorizontalEnum

Reference

SFZTitlePlainFrame::SetScrollDirection

Return value

Scroll-interval. [milliseconds]

Reference

SFZTitlePlainFrame::SetScrollInterval

Return value

Scroll-step. [pixels]

Reference

SFZTitlePlainFrame::SetScrollStep

Reference

SFZTitlePlainFrame::SetText

Reference

SFZTitlePlainFrame::SetTextColor | SFXRGBColor

Return value

Value of vertical alignment of the title.

Reference

SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::VerticalEnum

Return value

Waiting time to start to scroll. [milliseconds]

Reference

SFZTitlePlainFrame::SetWaitInterval

Description

This function gets the instance of the SFYSingleTextWidget class, which is contained as a child responder internally for drawing a title.

The drawing of the single text is delegated to the SFYSingleTextWidget class.

Reference

SFYSingleTextWidget

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation is to equalize the real region with the new local region and relocate this responder to fit into the new virtual region.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal Implementation

Internal implementation of the SFZTitlePlainFrame::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFZTitlePlainFrame::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZTitlePlainFrame::HandleBoundVirtual //

/*private */Void SFZTitlePlainFrame::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    lx.Deflate(GetShadowMargin());
    lx.Deflate(_frame, _frame);
    lx.SetHeight(_widget->GetFontSize().GetHeight());
    _bound.Set(lx);
    _bound.Inflate(_frame, _frame);
    _widget->SetRealBound(lx);
    return;
}// SFZTitlePlainFrame::Relocate //

Reference

SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::GetHeaderBound | SFZTitlePlainFrame::SetFrameSize | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND] | Virtual Region | Real Region | Local Region

Description

This function will be called when the margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, rectangle)] is received.

This function calculates the frame margin of this responder.

In case you want to calculate the frame margin of this responder when the margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, rectangle)] is received, override this virtual function.

In addition, this frame margin will be drawn by the SFZTitlePlainFrame::HandleRenderRequest function.

The default implementation is to calculate the frame margin which consists of a shadow region and a header region.

The shadow region and the header region can be obtained by calling the SFYPlainFrame::GetShadowMargin function and the SFZTitlePlainFrame::GetHeaderBound function respectively.

Figure 406. Plain frame with a title[SFZTitlePlainFrame]

Figure 407. Plain frame with a title: Expanded Figure[SFZTitlePlainFrame]

The height of the header region "HeaderHeight" is given as below.

HeaderHeight = FontHeight + 2 * FrameMarginSize

FontHeight      : height of font
FrameMarginSize : margin of the header region set with SetFrameSize() [by default, 1 pixel]

The width of the header region "HeaderWidth" is given as below.

HeaderWidth = SFZTitleFlatFrameWidth - ShadowWidth

SFZTitlePlainFrameWidth  : width of local region of this SFZTitlePlainFrame instance
ShadowWidth              : width of shadow region [1 pixel]

The background of the header region is filled in the color(SFXRGBColor) set with the SFZTitlePlainFrame::SetHeaderColor function.

The width of the shadow region is 1 pixel.

	Margin event[(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) event]
	The SFYResponder::GetSuitableMargin function will send the margin event [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, margin)] to this responder. Then, the SFYFrame::HandleMarginRequest virtual function will be called. The margin element (P32 parameter) of the margin event is set to SFXMargin::ZeroInstance() as an initial value.

Internal Implementation

Internal implementation of the SFZTitlePlainFrame::HandleMarginRequest function is as follows:

/*protected virtual */Void SFZTitlePlainFrame::HandleMarginRequest(SFXMarginPtr margin) const
{
    margin->Add(GetShadowMargin());
    margin->AddTop(_bound.GetHeight());
    return;
}// SFZTitlePlainFrame::HandleMarginRequest //

Reference

SFYResponder::GetSuitableMargin | SFYPlainFrame::GetShadowMargin | SFZTitlePlainFrame::GetHeaderBound | SFZTitlePlainFrame::HandleRenderRequest | SFXMargin | Margin Event[SFEVT_RESPONDER_MARGIN]

Description

This function will be called when the (SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) event is received.

In case you want to perform your own drawing of this responder, override this function.

The default implementation is to draw this responder.

The method to darw a responder

In addition to overriding this virtual function, it is possible to define and implement the handler for drawing event(drawing handler)[XANDLER_DECLARE_VOIDRENDER], and register it into the responder. Then, the overridden virtual function will be called first, and next the drawing handlers registered into the responder will be booted up in the registered order. In almost all cases, the method to override this function is used to draw the responder since there is no need to declare and register the drawing handler.

Procedure of drawing a responder

The drawing handler will be booted up when the drawing event(SFEVT_RESPONDER_RENDER) occurs. And then the drawing handler draw the responder actually. The drawing event will be sent to only the responders including the region to be redrawn out of the redraw regions registered into the renderer using the SFYResponder::InvokeBackward function after the SFYResponder::Render function boots up the renderer. Here, the SFYResponder::Render function will be called at the following situations: At the end of the event loop At the applet start / resume or the end of a highest priority event handler In the callback, which is outside the event loop. If calling the SFYResponder::Render function with specifying "true" as an argument, the drawing event will be sent to all the responders to be actually displayed on the screen which are located below the responder in the responder tree, regardless of the registration of redraw region.

Internal Implementation

Internal implementation of the SFZTitlePlainFrame::HandleRenderRequest function is as follows:

/*protected virtual */Void SFZTitlePlainFrame::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawShadow(graphics, GetLocalBound());
    DrawHeader(graphics, _bound);
    return;
}// SFZTitlePlainFrame::HandleRenderRequest //

Reference

SFYPlainFrame::DrawShadow | SFZTitlePlainFrame::DrawHeader | SFZTitlePlainFrame::SetHeaderColor | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::SetFont | SFZTitlePlainFrame::SetTextColor | SFXRGBColor | SFYSingleTextWidget | SFYSingleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | Event Loop | Responder Tree

Argument

Return value

Description

This function creates a new instance of this responder class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails such as insufficient memory, a null pointer will be returned, and the "exception" argument holds the error value.

Example

The code to create a new instance of this responder class is as follows:

SFZTitlePlainFrameSmp _titleplainframe;
SFCError error;

if ((_titleplainframe = SFZTitlePlainFrame::NewInstance(&error)) != null) {

    ...
}

Description

This function sets the title font to the specified value.

Default: AEE_FONT_NORMAL

Reference

SFZTitlePlainFrame::GetFont

Description

This function sets the margin between the border of the header region and the title string to the specified value. [pixels]

Default: 1 pixel.

	Height of the header region
	The value set with this function multiplied by 2 and added on the height of the font is the height of the header region.

Reference

SFZTitlePlainFrame::GetFrameSize

Description

This function sets the color of the header region of this frame to the specified value.

Default setting is as follows:

static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xDD, 0xDD, 0xDD}}}
};

Reference

SFZTitlePlainFrame::GetHeaderColor | SFXRGBColor

Description

This function sets the horizontal alignment of the title to the specified value.

The title set with the SFZTitlePlainFrame::SetText function is contained internally as text widget(SFYSingleTextWidget).

Default: SFYSingleTextWidget::DEFAULT_HORIZONTAL

For the value of SFYSingleTextWidget::DEFAULT_HORIZONTAL, refer to SFYSingleTextWidget::HorizontalEnum.

Reference

SFZTitlePlainFrame::GetHorizontalAlign | SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum

Description

This function sets the scroll direction of the title to the specified value.

Default: SFYSingleTextWidget::DEFAULT_DIRECTION

For the value of SFYSingleTextWidget::DEFAULT_DIRECTION, refer to SFYSingleTextWidget::DirectionEnum.

Reference

SFZTitlePlainFrame::GetScrollDirection | SFZTitlePlainFrame::DirectionEnum | SFYSingleTextWidget::DirectionEnum

Description

This function sets the scroll-interval of the title to the specified value. [milliseconds]

Default: SFYSingleTextWidget::DEFAULT_SCROLL [milliseconds]

For the value of SFYSingleTextWidget::DEFAULT_SCROLL, refer to SFYSingleTextWidget::DefaultEnum.

Reference

SFZTitlePlainFrame::GetScrollInterval | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Description

This function sets the number of pixels of each scroll to the specified value. If "-1"(this is default value) is set, the scroll-step will be set to the width of the " " character of the currently used font.

Default: SFYSingleTextWidget::DEFAULT_STEP [pixels]

For the value of SFYSingleTextWidget::DEFAULT_STEP, refer to SFYSingleTextWidget::DefaultEnum.

Reference

SFZTitlePlainFrame::GetScrollStep | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Return value

Description

This function sets the title to the specified value.

The string value is set directly in the argument, or read from the resource file.

Default: ""[null string]

Reference

SFZTitlePlainFrame::GetText | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetVerticalAlign SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetFont

Description

This function sets the color of the title to the specified value.

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

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

SFZTitlePlainFrame::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function set the vertical alignment of the title to the specified value.

The title set with the SFZTitlePlainFrame::SetText function is internally contained as text widget(SFYSingleTextWidget).

Default: SFYSingleTextWidget::DEFAULT_VERTICAL

For the value of SFYMultipleTextWidget::DEFAULT_VERTICAL, refer to SFYMultipleTextWidget::VerticalEnum.

Reference

SFZTitlePlainFrame::GetVerticalAlign | SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::VerticalEnum | SFYSingleTextWidget::VerticalEnum

Description

This function sets the waiting time to start to scroll the title to the specified value. [milliseconds]

Default: SFYSingleTextWidget::DEFAULT_WAIT [milliseconds]

For the value of SFYSingleTextWidget::DEFAULT_WAIT, refer to SFYSingleTextWidget::DefaultEnum.

Reference

SFZTitlePlainFrame::GetWaitInterval | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

Description

If the width of the text is greater than that of the virtual region, the title will start to scroll.

Otherwise, the title will not scroll.

Though the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event will be automatically handled, the behaviour of this function is not defined when called between the SFEVT_APP_SUSPEND event and the SFEVT_APP_RESUME event.

Reference

SFZTitlePlainFrame::StopScroll

Reference

SFZTitlePlainFrame::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Reference

SFYSingleTextWidget::DefaultEnum

Reference

SFYSingleTextWidget::DirectionEnum

Reference

SFYSingleTextWidget::HorizontalEnum

Reference

SFYSingleTextWidget::VerticalEnum