Inheritance diagram

Collaboration diagram

Description

The button control can display the character string as a title, and can set the color of seleted parts with SFRButtonControl::ColorEnum.

Ths code if the implement of the button control is as below:

SFMTYPEDEFCLASS(UserClass)
class UserClass : public SFRPlainWindow {
  // the constructor etc. is omitted
  private:
    Void  Main  (Void);
    HANDLER_DECLARE_VOIDCONTROL(ButtonHandler)
};

Void UserClass::Main(Void)
{
  SFRButtonControlPtr  button;

  button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
  
  button->RegisterHandler(SREVT_CONTROL, HANDLER_BEFORE, HANDLER_FUNCTION(ButtonHandler));
  
  // set the color of button
  // use the default color if there is no color setting
  button->SetColor(SFRButtonControl::COLOR_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
  button->SetColor(SFRButtonControl::COLOR_BASE, SFXRGBColor(0x66, 0x66, 0x66, 0x00));
  button->SetColor(SFRButtonControl::COLOR_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
  button->SetColor(SFRButtonControl::COLOR_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));
  
  return;
}

HANDLER_IMPLEMENT_VOIDCONTROL(UserClass, ButtonHandler, result, control)
{
  // this handler runs when the button is released
  return;
}

SFRButtonControl class is inherited from SFRButtonBase class.

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | SFRButtonBase | Button

Member

Example

Create a button control, register the handler that the button is pressed.

SFRButtonControlPtr  button;

button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
button->RegisterHandler(SREVT_CONTROL, HANDLER_BEFORE, HANDLER_FUNCTION(ButtonHandler));

Reference

SFRButtonControl::~SFRButtonControl

Reference

SFRButtonControl::SFRButtonControl

Argument

Description

The behavior is not defined when the specified palette index is invalid.

Example

Get the base color.

SFRButtonControlPtr  button;
SFXRGBColor          color;

button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
color = button->GetColor(SFRButtonControl::COLOR_BASE);

Reference

SFRButtonControl::SetColor | SFRButtonControl::ColorEnum

Reference

SFRButtonControl::SetFont

Reference

SFRButtonControl::SetTitle

Example

Create a button at the coordinate ( 5 , 5 , 48 , 16 ) in base bound, and modify it into (10 , 10 , 96 , 16 )

SFRButtonControlPtr  button;

button = new SFRButtonControl(window, SFXRectangle(5 , 5, 48, 16), "sample");
button->SetBaseBound(SFXRectangle(10, 10, 96, 16));

Reference

SFRResponder::GetBaseBound | SFRResponder::SetBaseBound

Argument

Description

The behavior is not defined when the specified palette index is invalid.

Example

Set the color of button to black.

SFRButtonControlPtr  button;

button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
button->SetColor(SFRButtonControl::COLOR_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
button->SetColor(SFRButtonControl::COLOR_BASE, SFXRGBColor(0x66, 0x66, 0x66, 0x00));
button->SetColor(SFRButtonControl::COLOR_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
button->SetColor(SFRButtonControl::COLOR_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));

Reference

SFRButtonControl::GetColor | SFRButtonControl::ColorEnum

Description

Set the title font of the button.

Example

Set the title text into bold.

SFRButtonControlPtr  button;

button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
button->SetFont(AEE_FONT_BOLD);

Reference

SFRButtonControl::GetFont

Exapmle

Create a button with the title "sample" , and modify the title into "changed".

SFRButtonControlPtr  button;

button = new SFRButtonControl(window, SFXRectangle(5, 5, 48, 16), "sample");
button->SetTitle("changed");

Reference

SFRButtonControl::GetTitle

Description

SFRButtonControl::ColorEnum is used to set or get the color of specific part of SFRButtonControl object.

Reference

SFRButtonControl::SetColor | SFRButtonControl::GetColor