Inheritance diagram

Collaboration diagram

Description

The combobox control is used to select an item in the list.

The combobox control can display the string of the title, and set the color of selected part with SFRComboboxControl::ColorEnum.

Access key can be also specified.

The code to use the combobox control is as below:

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

Void UserClass::Main(Void)
{
  SFRComboboxControlPtr  combobox;
  SFXWideString          item[]  = {"item1", "item2", "item3"};

  combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
  
  combobox->RegisterHandler(SREVT_CONTROL, HANDLER_BEFORE, HANDLER_FUNCTION(ComboboxHandler));
  
  // specify the access key of item1
  combobox->SetAccessKey(0, AVK_1, 0x69F7);
  
  // set the color of combo-box
  // use the default color if there is no color setting
  combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
  combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_BASE, SFXRGBColor(0x66, 0x66, 0x66, 0x00));
  combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
  combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));
  
  combobox->SetColor(SFRComboboxControl::COLOR_MENU_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
  combobox->SetColor(SFRComboboxControl::COLOR_MENU_BASE, SFXRGBColor(0x66, 0x66, 0x6, 0x006));
  combobox->SetColor(SFRComboboxControl::COLOR_MENU_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
  combobox->SetColor(SFRComboboxControl::COLOR_MENU_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));
  
  return;
}

HANDLER_IMPLEMENT_VOIDCONTROL(UserClass, ComboboxHandler, result, control) {
{
  // this handler runs when the menu of combo-box is selected
  return;
}

Reference

SFRResponder | SFRApplication | SFRWindow | SFRDialog | SFRControl | Combo Box

Member

Example

Create a check-box control, register the handler that the menu of combo-box is selected.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->RegisterHandler(SREVT_CONTROL, HANDLER_BEFORE, HANDLER_FUNCTION(ComboboxHandler));

Reference

SFRComboboxControl::~SFRComboboxControl

Reference

SFRComboboxControl::SFRComboboxControl

Example

Append items onto the combobox, and add one more item onto it.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
combobox->AppendItem(item, lengthof(item));
combobox->AppendItem("appended", AVK_9, 0x69F7);

Reference

SFRComboboxControl::SetItem

Description

The value of combobox is set to 0.

Example

Delete all items in the combobox menu.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->ClearItem();

Reference

SFRComboboxControl::RemoveItem

Description

The access key is as same as the key code in BREW.

If the access key is not set, AVK_UNDEFINED will be returned.

Reference

SFRComboboxControl::SetAccessKey

Argument

Description

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

Example

Get the base color of the button.

SFRComboboxControlPtr  combobox;
SFXRGBColor            color;

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
color = combobox->GetColor(SFRComboboxControl::COLOR_BUTTON_BASE);

Reference

SFRComboboxControl::SetColor | SFRComboboxControl::ColorEnum

Reference

SFRComboboxControl::SetFont

Reference

SFRComboboxControl::SetTitle

Description

The value is 0-based.

Reference

SFRComboboxControl::SetValue

Example

Remove a registered item from combo-box menu.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->RemoveItem(0);

Reference

SFRComboboxControl::ClearItem

Description

The access key is as same as the key code in BREW.

The icon can be displayed on the left of the string when menu is shown.

Example

Set the access key and the icon of the item.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->SetAccessKey(0, AVK_1, 0x69F7);

Reference

SFRComboboxControl::GetAccessKey

Example

Create a combo-box at the coordinate ( 5 , 5 , 48 , 16 ) in base region, and modify it into (10 , 10 , 96 , 16 )

SFRComboboxControlPtr  combobox;

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
combobox->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 combo-box to black.

SFRComboboxControlPtr  combobox;

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_BASE, SFXRGBColor(0x66, 0x66, 0x66, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_BUTTON_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));

combobox->SetColor(SFRComboboxControl::COLOR_MENU_LIGHT, SFXRGBColor(0x99, 0x99, 0x99, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_MENU_BASE, SFXRGBColor(0x66, 0x66, 0x66, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_MENU_SHADOW, SFXRGBColor(0x33, 0x33, 0x33, 0x00));
combobox->SetColor(SFRComboboxControl::COLOR_MENU_TITLE, SFXRGBColor(0xBB, 0xBB, 0xBB, 0x00));

Reference

SFRComboboxControl::GetColor | SFRComboboxControl::ColorEnum

Description

Set the title font of the combo-box.

Example

Set the title text into bold.

SFRComboboxControlPtr  combobox;

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
combobox->SetFont(AEE_FONT_BOLD);

Reference

SFRComboboxControl::GetFont

Example

Set the items, and modify 1 of them.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), null, 0);
combobox->SetItem(item, lengthof(item));
combobox->SetItem(0, "changed", AVK_1, 0x69F7);

Reference

SFRComboboxControl::GetTitle | SFRComboboxControl::GetAccessKey | SFRComboboxControl::AppendItem

Example

Modify the title of an item.

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->SetTitle(0, "changed");

Reference

SFRComboboxControl::GetTitle

Description

The value is 0-based.

Example

Set the value of combobox to 1.(The status of combobox can be changed to "item2" if selected.)

SFRComboboxControlPtr  combobox;
SFXWideString          item[]  = {"item1", "item2", "item3"};

combobox = new SFRComboboxControl(window, SFXRectangle(5, 5, 48, 16), item, lengthof(item));
combobox->SetValue(1);

Reference

SFRComboboxControl::GetValue

Description

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

Reference

SFRComboboxControl::SetColor | SFRComboboxControl::GetColor