Inheritance diagram

Collaboration diagram

Description

To implement your own button control, the SFRButtonBase::HandleContent function needs to be overridden.

Ths code to implement your own button control is as below:

SFMTYPEDEFCLASS(UserButton)
class UserButton : public SFRButtonBase {
    // the copy-forbidden macro
    SFMSEALCOPY(UserButton)
  public:
    // declaration of the constructor and the destructor
    UserButton(SFRResponderPtr, SFXRectangleConstRef, BehaviorType);
    virtual ~UserButton(Void);
  private:
    // declaration of the draw handler
    virtual  Void  HandleContent(SFXGraphicsPtr);
    // declaration of the key release handler
    virtual  Void  HandleRelease(Void);
};

// constructor
UserButton::UserButton(SFRResponderPtr director, SFXRectangleConstRef rect, BehaviorType behavior)
: SFRButtonBase(director, rect, behavior, four_char_code('U', 's', 'e', 'r'))
{
  return;
}

// destructor
UserButton::~UserButton(Void)
{
  return;
}
// draw the button
Void UserButton::HandleContent(SFXGraphicsPtr graphic)
{
  SFXRGBColor  color;

  // get whether it is enable for response
  if (GetInheritEnable()) {
    // get whether it is focused
    if (GetInheritFocus()) {
       // get whether the key is pressed
      if (GetStatusPress()) {
        color.SetRGB(0x44, 0x44, 0x44);
      }
      else {
        color.SetRGB(0x66, 0x66, 0x66);
      }
    }
    else {
      color.SetRGB(0x88, 0x88, 0x88);
    }
  }
  else {
    color.SetRGB(0xAA, 0xAA, 0xAA);
  }
  
  // draw the button
  graphic->DrawRectangle(GetVirtualWorld(), color);
  
  return;
}

// the function to run when key released
Void UserButton::HandleRelease(Void)
{
  // the SREVT_CONTROL event is sent to itself
  Invoke(SFXEvent(SREVT_CONTROL, 0, reinterpret_cast<UInt32>(this)));
  return;
}

The SFRButtonControl class inherites from the SFRButtonBase class.

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | SFRButtonControl | Button

Member

Reference

SFRButtonBase::~SFRButtonBase

Reference

SFRButtonBase::SFRButtonBase

Description

This function can be used such as an original button control implemted, whose drawing modified with the key status.

Description

When the button is implemented originally, the function is overrided and draw itself.

Example

Draw the button originally.

Draw a button whose color changes when: Enabled / Disabled , Focused / Unfocused , Key pressed / released.

// draw the button
Void UserButton::HandleContent(SFXGraphicsPtr graphic)
{
  SFXRGBColor  color;

  // get whether it is enabled
  if (GetInheritEnable()) {
    // get whether it is focused
    if (GetInheritFocus()) {
       // get whether the key is pressed
      if (GetStatusPress()) {
        color.SetRGB(0x44, 0x44, 0x44);
      }
      else {
        color.SetRGB(0x66, 0x66, 0x66);
      }
    }
    else {
      color.SetRGB(0x88, 0x88, 0x88);
    }
  }
  else {
    color.SetRGB(0xAA, 0xAA, 0xAA);
  }
  
  // draw the button
  graphic->DrawRectangle(GetVirtualWorld(), color);
  
  return;
}

Description

If user want to process the key-pressed handler originally with the original-implemented button, it is necessary to override this function.

Example

The original event is sent when the key is pressed.

Void HandlePress(Void)
{
  Invoke(SFXEvent(USEREVT_CONTROL, USERP16_CONTROL_PRESS, reinterpret_cast<UInt32>(this)));
  return;
}

Description

If user want to process the key-released handler originally with the original-implemented button, it is necessary to override this function.

Example

The original event is sent when the key is released.

Void HandleRelease(Void)
{
  Invoke(SFXEvent(USEREVT_CONTROL, USERP16_CONTROL_RELEASE, reinterpret_cast<UInt32>(this)));
  return;
}

Description

This function can be used when an original button control implemted, which needs to be redrawed.

This function does the same thing as InvalidateVirtual() function. If there is no virtual bound of the button, it is necessary to override the InvalidateButton() function.

Example

When the title text has been changed by the original-implemented button, register it as update bound.

if (param != _title) {
  _title = param;
  InvalidateButton();
}

The original-implemented button must be registered as update bound, when there is no virtual bound.

Void InvalidateButton(Void)
{
  InvalidateVirtual(_updatebound);
}

Reference

SFRResponder::InvalidateVirtual

Reference

SFRResponder::SetBaseBound

Reference

SFRResponder::GetContentBound | SFRResponder::SetContentBound

Reference

SFRResponder::GetVirtualBound | SFRResponder::SetVirtualBound