Inheritance diagram

Collaboration diagram

Description

How to use

Combo box control(SFZComboBoxControl) is a button control which internally contains a flex list box control(SFZFlexListBoxControl) for list items.

To insert an item, use the SFZComboBoxControl::Insert / SFZComboBoxControl::InsertFirst / SFZComboBoxControl::InsertLast function. To remove an item, use the SFZComboBoxControl::Remove / SFZComboBoxControl::RemoveFirst / SFZComboBoxControl::RemoveLast function. If the SFZComboBoxControl::Clear function is called, all items are removed.

In the region of this combo box control, the currently selected item among this flex list box control is displayed.

If there are more characters than can be displayed in the text region of a combo box control, this control will start to scroll automatically when it is in the focused state.

The flex list box control(SFZFlexListBoxControl) internally contained by the combo box control(SFZComboBoxControl) will be displayed if the pull-down button where the reverse triangle is drawn is pressed using the operation key of the combo box control set with the SFYButtonControl::SetOperateKey.

In SFZFlexListBoxControl, the focused item, currently selected item, is displayed highlightly.

	Note
	If an item is in the invalid state, it will not be focused nor selected.

List items can be scrolled using the scroll keys set with the SFZFlexListBoxControl::SetScrollUpKey / SFZFlexListBoxControl::SetScrollDownKey / SFZFlexListBoxControl::SetPageUpKey / SFZFlexListBoxControl::SetPageDownKey / SFZFlexListBoxControl::SetSnapUpKey / SFZFlexListBoxControl::SetSnapDownKey functions.

The below is the specification of the combo box control.

	Flex List Box Control
	For more details, refer to SFZFlexListBoxControl.

Limitation on combo box control specification

The minimum value is always 0. The current value represents the index of currently selected item of the flex list box control(SFZFlexListBoxControl) which the combo box control contains internally. The maximum value represents the number of items of the flex list box control(SFZFlexListBoxControl) which the combo box control contains internally. [* This function is to be discontinued in the future. To get the number of items of the flex list box control(SFZFlexListBoxControl) which the combo box control contains internally, call the SFZComboBoxControl::GetItemCount function.] The minimum value or the maximum value must not be changed by using the SFYControl::SetMinimumValue function or the SFYControl::SetMaximumValue function.

Structure of the combo box control

In the default implementation, the combo box control is drawn as below depending on its state.

Figure 317. Expanded figure of the combo box control in the "active" or "enable" state

The title is drawn in the content region surrounded by the frame("focus frame") of 2 pixels width in title bevel region.

For more details: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

Figure 318. Expanded figure of the combo box control in the "inactive" state

The title is drawn in the color which is calculated for the "inactive" state using the color set with the SFZComboBoxControl::SetTitleColor function.

The reverse triangle is drawn in the color which is calculated for the "inactive" state using the color set with the SFZComboBoxControl::SetArrowColor function.

For more details: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

Figure 319. Expanded figure of the combo box control in the "focus" state when not pressed

For more details: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

Figure 320. Expanded figure of the combo box control in the "focus" state when pressed

For more details: SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow

The below is the sample code to create the instance of the combo box control.

// implementation of combo box including only body string
Void UserClass::Main(Void)
{
    SFZWindowSmp            window;
    SFZComboBoxControlSmp   combo;
    SFCError                error(SFERR_NO_ERROR);

    // create the window
    window = SFZWindow::NewInstance(&error);
    window->SetParent(GetThis());
    window->SetRealBound(GetLocalBound());
    window->SetState(true, true, true, true);
    window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

    // [Required] create combo box
    combo = SFZComboBoxControl::NewInstance(&error);

    // [Required] set combo box's parent responder to window
    combo->SetParent(window);

    // [Required] insert string at the tail
    for (SInt32 i = 0;  i < 5 ; ++i) {
        combo->InsertLast(SFXAnsiString::Format("Item index is %d.", i));
    }

    // [Required] set real region(calculate suitable region from window's local region)
    combo->SetRealBound(combo->GetSuitableBound(window->GetLocalBound().Deflate(20, 50)).SetOrigin(20, 50));

    // [Required] set combo box's states to "visible" + "active" + "enable" + "focus" together
    combo->SetState(true, true, true, true);
    return;
}

// implementation of combo box control including header string and body icon image
Void UserClass::Main2(Void) {
    SFZWindowSmp                    window;
    SFZComboBoxControlSmp           combo;
    SFZComboBoxControl::ItemRec     item;
    SFBShellSmp                     shell(SFBShell::GetInstance());
    SFBImageSmp                     normal(shell->LoadResImage("userclass.bar", IDI_OBJECT_5001));
    SFBImageSmp                     select(shell->LoadResImage("userclass.bar", IDI_OBJECT_5002));
    SFCError                        error(SFERR_NO_ERROR);

    // create the window
    window = SFZWindow::NewInstance(&error);
    window->SetParent(GetThis());
    window->SetRealBound(GetLocalBound());
    window->SetState(true, true, true, true);
    window->SetBackgroundColor(SFXRGBColor(0xDD, 0xFF, 0xDD, 0x00));

    // [Required] create combo box
    combo = SFZComboBoxControl::NewInstance(&error);

    // [Required] set combo box's parent responder to window
    combo->SetParent(window);

    // in case image is used, append item using item structure

    // [Required to select] set enable flag of item structure to "true"
    item.property.enable = true;

    // [Required to select] set access key and command id of item structure
    // in this case, these are not used
    item.property.key = 0;
    item.property.id = SFZComboBoxControl::INVALID_COMMAND_ID;

    // [Optional] set image of item structure
    item.normal.body.icon = normal;
    item.select.body.icon = select;

    // [Required] insert 5 items
    for (SInt32 i = 0;  i < 5; ++i) {

        // [Required to select] set text of item structure
        item.normal.header.text.Set(SFXWideString::Format("%02d", i));
        item.normal.body.text.Set(SFXWideString::Format("List item %02d", i));
        item.select.body.text.Set(SFXWideString::Format("The item %02d is selected.", i));

        // insert item at tail
        combo->InsertLast(item);
    }

    // [Required] set combo box's real region(calculate suitable region from window's local region)
    combo->SetRealBound(combo->GetSuitableBound(window->GetLocalBound().Deflate(20, 50)).SetOrigin(20, 50));

    // [Required] set combo box's states to "visible" + "active" + "enable" + "focus" together
    combo->SetState(true, true, true, true);
    return;
}

Execution Result (Left: only body string is used ; Right: header string, body icon image, and body string are included)

CAUTION

The region of a flex list box control internally contained by a combo box control is automatically set based on inserted items and the local region of its parent responder where the combo box control is placed. To draw the flex list box control, the real region(local region) of its parent responder needs to be set with the SFYResponder::SetRealBound function. This real region is the same with its local region unless its virtual region is set with the SFYResponder::SetVirtualBound function. * Both the local region and the virtual region represent the same rectangular region.

Reference

Combo Box Control[SFZComboBoxControl] | SFZFlexListBoxControl | State | SFYButtonControl | SFYSingleTextWidget | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Real Region | Local Region | Virtual Region

Members

Description

This constructor performs the initializations as follows:

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

Reference

SFYResponder::SetType | SFZComboBoxControl::CodeEnum | SFZComboBoxControl::SetArrowColor | SFZComboBoxControl::SetFont | SFZComboBoxControl::SetTitleColor | SFZComboBoxControl::SetSpaceSize | SFZComboBoxControl::SetHorizontalAlign | SFZComboBoxControl::SetVerticalAlign | SFZComboBoxControl::SetScrollDirection | SFZComboBoxControl::SetScrollInterval | SFZComboBoxControl::SetScrollStep | SFZComboBoxControl::SetWaitInterval | SFZComboBoxControl::HorizontalEnum | SFZComboBoxControl::VerticalEnum | SFZComboBoxControl::DirectionEnum | SFZComboBoxControl::DefaultEnum | SFYButtonControl::SetStatePress | SFYControl::SetCurrentValue | SFZFlexListBoxControl::NewInstance | SFXRGBColor | SFXEvent | Type | State | Event | State Event[SFEVT_RESPONDER_STATE] | Result Event[SFEVT_RESPONDER_RESULT] | Value Event[SFEVT_RESPONDER_VALUE]

Description

This destructor does nothing.

Description

This function inserts an item at the tail of the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

	Caution
	Since this function is deprecated, use the SFZComboBoxControl::InsertLast function instead.

Reference

SFZComboBoxControl::InsertLast | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZFlexListBoxControl

Description

This function removes all items in the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Reference

SFZComboBoxControl::InsertLast | SFZComboBoxControl::Insert | SFZComboBoxControl::InsertFirst | SFZComboBoxControl::Append | SFZComboBoxControl::Remove | SFZFlexListBoxControl

Description

This function draws the reverse triangle of this combo box control in the specified region.

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

	Tip
	This function will be called in the SFZComboBoxControl::HandleRenderRequest function.

Internal Implementation

Internal implementation of the SFZComboBoxControl::DrawTab function is as follows:

/*protected */Void SFZComboBoxControl::DrawTab(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    SInt16                                      W(rectangle.GetWidth());
    SInt16                                      H(rectangle.GetHeight());
    SInt16                                      h(H / 4 - 1);
    SInt16                                      w(h * 2);
    SInt16                                      x(rectangle.GetX() + (W - w) / 2);
    SInt16                                      y(rectangle.GetY() + (H - h) / 2);
    SFXRGBColor                                 rgb(GetArrowColor());
    SFXTriangle                                 triangle;

    triangle.Set(x, y, x + w, y, x + w / 2, y + h);
    if (!GetStateActive(true)) {
        (rgb.GetBrightness() > 0x7F) ? rgb.SubRGB(0x44) : rgb.AddRGB(0x44);
    }
    graphics->FillTriangle(triangle, rgb);
    return;
}// SFZComboBoxControl::DrawTab //

Reference

SFZComboBoxControl::HandleRenderRequest

Return value

Color(SFXRGBColor) of reverse triangle on the pull-down button of this combo box control.

Reference

SFZComboBoxControl::SetArrowColor | SFXRGBColor

Return value

Font of the text of this combo box control and the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

Description

This function gets the font of this combo box control.

Reference

SFZComboBoxControl::SetFont

Return value

Value of horizontal alignment of the title.

Reference

SFZComboBoxControl::SetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

Return value

Access key for the specified item of the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

"0" will be returned if the access key is not set.

Reference

SFZComboBoxControl::SetItemAccessKey | SFZFlexListBoxControl

Return value

Number of items in the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Reference

SFZComboBoxControl::Append | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZFlexListBoxControl

Return value

Icon image specified by the icon constant(SFZComboBoxControl::IconEnum) of item in the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Description

This function gets the icon image of the specified icon enum(SFZFlexListBoxControl::IconEnum) of the specified item of the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

Reference

SFZComboBoxControl::IconEnum | SFZComboBoxControl::SetItemIconImage | SFZFlexListBoxControl

Return value

Text of the specified item in the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Description

This function gets the text of the specified text enum(SFZComboBoxControl::TextEnum) of a specified item in the flex list box control(SFZFlexListBoxControl), which is contained internally by this combo box control.

If the textEnum argument is omitted, the Body text of the list item is gotten.

Reference

SFZComboBoxControl::SetItemText | SFZFlexListBoxControl | SFZComboBoxControl::TextEnum

Return value

Flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Description

This function gets the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

The developer can change the background color or the foregraound color of an item using the flex list box control obtained by this function.

	Flex list box control
	For more details, refer to SFZFlexListBoxControl.

Example

The below is the code to enable the grid line using the flex list box control obtained by this function.

SFZComboBoxControlSmp       combo;
SFZFlexListBoxControlSmp    list;

// create combo box control
if ((combo = SFZComboBoxControl::NewInstance()) != null) {
    // ...
}

// get flex list box control
if ((list = combo->GetListBoxControl()) != null) {

    // enable grid line
    list->SetGridLineEnable(true);
}

Reference

SFZFlexListBoxControl

Return value

Number of the items in the flex list box control of this combo box control.

Description

This function gets the number of items in the flex list box control of this combo box control.

	Caution
	Since this function is deprecated, use the SFZComboBoxControl::GetItemCount function instead.

Reference

SFZComboBoxControl::GetItemCount

Reference

SFZComboBoxControl::SetScrollDirection

Return value

Scroll-interval. [milliseconds]

Reference

SFZComboBoxControl::SetScrollInterval

Return value

Scroll-step. [pixels]

Reference

SFZComboBoxControl::SetScrollStep

Return value

Space size between two elements in the title [pixels]

Reference

SFZComboBoxControl::SetSpaceSize

Return value

Foreground color(SFXRGBColor) to draw the text of the title.

Reference

SFZComboBoxControl::SetTitleColor | SFXRGBColor

Return value

Value of vertical alignment of the title.

Reference

SFZComboBoxControl::SetVerticalAlign | SFZComboBoxControl::VerticalEnum

Return value

Waiting time to start to scroll. [milliseconds]

Reference

SFZComboBoxControl::SetWaitInterval

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] is received.

This function calculates the suitable rectangle size of this responder within the specified hint rectangle[i.e., rectangle element (P32 parameter) of the region event].

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin of the rectangle argument in this function.

	Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) event]
	If the rectangle argument of the hint region is specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] to this responder. Then, the SFYWidget::HandleBoundOptimize virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the hint region as an initial value.

Internal Implementation

Internal implementation of the SFZComboBoxControl::HandleBoundOptimize function is as follows:

SFYFlexListItemWidgetSmp        _widget;

/*protected virtual */Void SFZComboBoxControl::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                temp;

    temp.Set(*rectangle);
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());
    rectangle->SetSize(_widget->GetSuitableBound(*rectangle).GetSize());
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    rectangle->AddWidth(rectangle->GetHeight());
    if (rectangle->GetWidth() > temp.GetWidth()) {
        rectangle->SetWidth(temp.GetWidth());
    }
    return;
}// SFZComboBoxControl::HandleBoundOptimize //

Reference

SFYResponder::GetSuitableBound | SFXEvent | Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

Description

This function will be called when the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] is received.

This function calculates the suitable rectangle size of this responder.

The suitable rectangle size is stored into the size element of the rectangle argument as a result of calculation. It is recommended not to change the origin element of the rectangle argument within this function.

Region event[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) event]

If the rectangle argument of the hint region is not specified, the SFYResponder::GetSuitableBound function will send the region event [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] to this responder. Then, the SFYWidget::HandleBoundRequest virtual function will be called. The rectangle element (P32 parameter) of the region event is set to the real region as an initial value. Tip Default value of the real region: SFXRectangle(0, 0, 0, 0)

Internal Implementation

Internal implementation of the SFZComboBoxControl::HandleBoundRequest function is as follows:

SFYFlexListItemWidgetSmp        _widget;

/*protected virtual */Void SFZComboBoxControl::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    rectangle->Deflate(GetShadowMargin());
    rectangle->Deflate(GetButtonMargin());
    rectangle->SetSize(_widget->GetSuitableBound().GetSize());
    rectangle->Inflate(GetButtonMargin());
    rectangle->Inflate(GetShadowMargin());
    rectangle->AddWidth(rectangle->GetHeight());
    return;
}// SFZComboBoxControl::HandleBoundRequest //

Reference

SFYResponder::GetSuitableBound | SFXEvent | Real Region Region Event[SFEVT_RESPONDER_BOUND] | Handler for the Region Event[XANDLER_DECLARE_VOIDBOUND]

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 SFZComboBoxControl::HandleBoundVirtual function is as follows:

/*protected virtual */Void SFZComboBoxControl::HandleBoundVirtual(Void)
{
    Relocate();
    if (_listbox->GetStateVisible()) {
        RelocateListBox();
    }
    return;
}// SFZComboBoxControl::HandleBoundVirtual //

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

    lx.Set(GetLocalBound());
    lx.SubRight(lx.GetHeight());
    lx.Deflate(GetShadowMargin());
    lx.Deflate(GetButtonMargin());
    if (GetStatePress()) {
        lx.Offset(GetPressOffset());
    }
    _widget->SetRealBound(lx);
    return;
}// SFZComboBoxControl::Relocate //

/*private */Void SFZComboBoxControl::RelocateListBox(Void)
{
    SFXRectangle                                rx;
    SFXRectangle                                px;
    SFXRectangle                                sx;
    SFYResponderSmp                             parent(GetParent());

    if (parent != null) {
        rx.Set(GetRealBound());
        px.Set(
     SFXRectangle(parent->GetVirtualBound()).GetLeftTop().Neg(),
            parent->GetRealBound().GetSize()
        );
        sx.Set(SFXRectangle(rx.GetX(), px.GetY(), rx.GetWidth(), px.GetHeight()));
        sx.Set(_listbox->GetSuitableBound(sx));
        sx.SetWidth(rx.GetWidth());
        if (sx.GetHeight() < px.GetHeight()) {
            sx.SetY(rx.GetBottom());
            if (sx.GetBottom() > px.GetBottom()) {
                sx.SubY(sx.GetBottom() - px.GetBottom());
            }
        }
        _listbox->SetRealBound(sx);
    }
    return;
}// SFZComboBoxControl::ReLocateListBox //

Reference

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 SFEVT_KEY_RELEASE event(key event[SFEVT_KEY]) of the operaion key set with the SFYButtonControl::SetOperateKey function is received.

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

The default implementation is to display the flex list box control(SFZFlexListBoxControl) which this combo box control contains internally.

Internal Implementation

Internal implementation of the SFZComboBoxControl::HandleOperateKeyRelease function is as follows:

SFZFlexListBoxControlSmp        _listbox;

/*protected virtual */Void SFZComboBoxControl::HandleOperateKeyRelease(Void)
{
    SetStateFocus(false);
    _listbox->SetParent(GetThis()->GetParent());
    _listbox->SetState(true, true, true, true);
    _listbox->SetCurrentValue(GetCurrentValue());
    RelocateListBox();
    _listbox->ToFront();
    return;
}// SFZComboBoxControl::HandleOperateKeyRelease

/*private */Void SFZComboBoxControl::RelocateListBox(Void)
{
    SFXRectangle                                rx;
    SFXRectangle                                px;
    SFXRectangle                                sx;
    SFYResponderSmp                             parent(GetParent());

    if (parent != null) {
        rx.Set(GetRealBound());
        px.Set(
     SFXRectangle(parent->GetVirtualBound()).GetLeftTop().Neg(),
            parent->GetRealBound().GetSize()
        );
        sx.Set(SFXRectangle(rx.GetX(), px.GetY(), rx.GetWidth(), px.GetHeight()));
        sx.Set(_listbox->GetSuitableBound(sx));
        sx.SetWidth(rx.GetWidth());
        if (sx.GetHeight() < px.GetHeight()) {
            sx.SetY(rx.GetBottom());
            if (sx.GetBottom() > px.GetBottom()) {
                sx.SubY(sx.GetBottom() - px.GetBottom());
            }
        }
        _listbox->SetRealBound(sx);
    }
    return;
}// SFZComboBoxControl::ReLocateListBox //

Reference

SFYButtonControl::SetOperateKey | SFZFlexListBoxControl | Key Event[SFEVT_KEY]

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 SFZComboBoxControl::HandleRenderRequest function is as follows:

/*protected virtual */Void SFZComboBoxControl::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    SFXRectangle                                lx;
    SFXRectangle                                wx;

    lx.Set(DrawShadow(graphics, GetLocalBound()));
    wx.Set(lx.GetOrigin(), lx.GetWidth() - lx.GetHeight(), lx.GetHeight());
    DrawButton(graphics, wx);
    DrawButton(graphics, lx.SetLeft(wx.GetRight()));
    DrawTab(graphics, lx);
    return;
}// SFZComboBoxControl::HandleRenderRequest //

Reference

SFZComboBoxControl::DrawTab | SFYButtonControl::DrawButton | SFYButtonControl::DrawShadow | SFZComboBoxControl::SetTitleColor | SFZComboBoxControl::SetArrowColor | SFYButtonControl::SetButtonColor | SFYButtonControl::SetFocusColor | SFYButtonControl::SetShadowColor | SFYButtonControl::SetOperateKey | SFZListBoxControl | SFYControl::GetCurrentValue | SFYWidget | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | Drawing Event[SFEVT_RESPONDER_RENDER] | Handler for the Drawing Event[XANDLER_DECLARE_VOIDRENDER] | Rendering | State

Return value

Description

This function inserts the specified item at the specified index of the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::InsertFirst | SFZComboBoxControl::InsertLast | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZComboBoxControl::ItemRec | SFZFlexListBoxControl

Return value

Description

This function inserts the specified item at the head of the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::ItemRec | SFZComboBoxControl::Insert | SFZComboBoxControl::InsertLast | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

Return value

Description

This function inserts the specified item at the tail of the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::ItemRec | SFZComboBoxControl::Insert | SFZComboBoxControl::InsertFirst | SFZComboBoxControl::Remove | SFZComboBoxControl::Clear | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

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:

SFZComboBoxControlSmp _combobox;
SFCError error;

if ((_combobox = SFZComboBoxControl::NewInstance(&error)) != null) {

    ...
}

Description

This function removes specified items from the flex list box control(SFZFlexListBoxControl), which this combo box control contains internally.

If the specified index is less than 0 or greater than or equals the number of items, no item will be removed

If the beginning index to remove is greater than or equals the number of items or the ending index to remove is less than or equals 0, no item will be removed

If the beginning index to remove is less than or equals 0, it will be reset to 0.

If the ending index to remove is greater than the number of items, it will be reset to the number of items.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::Clear | SFZComboBoxControl::RemoveFirst | SFZComboBoxControl::RemoveLast | SFZComboBoxControl::Insert | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

Description

This function removes the first item from this combo box control.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::Clear | SFZComboBoxControl::Remove | SFZComboBoxControl::RemoveLast | SFZComboBoxControl::InsertFirst | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

Description

This function removes the last item from this combo box control.

	Note
	The numuber of items can be obtained by calling the SFZComboBoxControl::GetItemCount function.

Reference

SFZComboBoxControl::Clear | SFZComboBoxControl::Remove | SFZComboBoxControl::RemoveFirst | SFZComboBoxControl::InsertLast | SFZComboBoxControl::GetItemCount | SFZFlexListBoxControl

Description

This function sets the color(SFXRGBColor) of reverse triangle on the pull-down button to the specified value.

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

In the "inactive" state, the reverse triangle 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.

	Brightness of the color
	The brightness of color can be obtained by calling the SFXRGBColor::GetBrightness function.

Reference

SFZComboBoxControl::GetArrowColor | SFXRGBColor::GetBrightness | SFXRGBColor | State

Description

This function sets font of the title and the flex list box control(SFZFlexListBoxControl) to the specified value, which this combo box control contains internally.

Default: AEE_FONT_NORMAL

Reference

SFZComboBoxControl::GetFont | SFZComboBoxControl::TextEnum | SFZFlexListBoxControl

Description

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

Default: SFZComboBoxControl::DEFAULT_HORIZONTAL

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

Reference

SFZComboBoxControl::GetHorizontalAlign | SFZComboBoxControl::HorizontalEnum

Description

This function sets the access key and its icon character for the specified item of the flex list box control(SFZFlexListBoxControl) to the specified value, which this combo box control contains internally.

Example

The below is the code to set the access key and its icon character to the item of the flex list box control of the combo box control.

// set AVK_1 as access key, 0xFBF6 as its icon character to first item of flex list box control
_combobox->SetItemAccessKey(0, AVK_1, 0xFBF6);

Reference

SFZComboBoxControl::GetItemAccessKey

Description

This function sets the icon image of the specified icon enum(SFZFlexListBoxControl::IconEnum) of the specified item of the flex list box control(SFZFlexListBoxControl) to the specified value(SFZComboBoxControl::IconEnum), which this combo box control contains internally.

Reference

SFZComboBoxControl::GetItemIconImage | SFZFlexListBoxControl | SFZComboBoxControl::IconEnum

Description

This function sets the text of the specified text enum(SFZComboBoxControl::TextEnum) of a specified item in the flex list box control(SFZFlexListBoxControl) to the specified value, which is contained internally by this combo box control.

If the textEnum argument is omitted, the Body text of the list item is set.

Reference

SFZComboBoxControl::GetItemText | SFZFlexListBoxControl | SFZComboBoxControl::TextEnum

Description

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

Default: SFZComboBoxControl::DEFAULT_DIRECTION

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

Reference

SFZComboBoxControl::GetScrollDirection | SFZComboBoxControl::DirectionEnum

Description

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

Default: SFZComboBoxControl::DEFAULT_SCROLL [milliseconds]

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

Reference

SFZComboBoxControl::GetScrollInterval | SFZComboBoxControl::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: SFZComboBoxControl::DEFAULT_STEP [pixels]

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

Reference

SFZComboBoxControl::GetScrollStep | SFZComboBoxControl::DefaultEnum

Description

This function sets the space size between two elements in the title of this combo box control as the figure below to the specified value. [pixels]

Default: 2 [pixels]

Reference

SFZComboBoxControl::GetSpaceSize

Description

This function sets the color(SFXRGBColor) of the title to the specified value.

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

Reference

SFZComboBoxControl::GetTitleColor | SFXRGBColor

Description

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

Default: SFZComboBoxControl::DEFAULT_VERTICAL

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

Reference

SFZComboBoxControl::GetVerticalAlign | SFZComboBoxControl::VerticalEnum

Description

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

Default: SFZComboBoxControl::DEFAULT_WAIT [milliseconds]

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

Reference

SFZComboBoxControl::GetWaitInterval | SFZComboBoxControl::DefaultEnum

Description

This function starts to scroll the title.

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

SFZComboBoxControl::StopScroll

Description

This function stops to scroll the title.

Reference

SFZComboBoxControl::StartScroll

Reference

SFYResponder::GetType | SFYResponder::SetType

Description

ICON_BODY_NORMAL: body icon image in not selecting

ICON_BODY_SELECT: body icon in selecting (not used for the title)

ICON_FOOTER_NORMAL: footer icon image in not selecting

ICON_FOOTER_SELECT: footer icon in selecting (not used for the title)

Description

An item can be inserted into this combo box control using this item structure.

Reference

SFZComboBoxControl::Insert

Description

TEXT_HEADER_NORMAL: header string in not selecting

TEXT_HEADER_SELECT: header string in selecting (not used for the title)

TEXT_BODY_NORMAL: body string in not selecting

TEXT_BODY_SELECT: body string in selecting (not used for the title)