MFXComboBoxIcon.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2006-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// ComboBox with search field and icons
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MFXListIcon.h"
#include "MFXTextFieldSearch.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class MFXComboBoxIcon : public FXPacker {
    FXDECLARE(MFXComboBoxIcon)
 
public:
    enum {
        ID_LIST = FXPacker::ID_LAST,
        ID_TEXT,
        ID_SEARCH,
        ID_LAST
    };
 
    MFXComboBoxIcon(FXComposite* p, FXint cols, const bool canSearch,
                    const int visibleItems, FXObject* tgt, FXSelector sel = 0, FXuint opts = COMBOBOX_NORMAL,
                    FXint x = 0, FXint y = 0, FXint w = 0, FXint h = 0,
                    FXint pl = DEFAULT_PAD, FXint pr = DEFAULT_PAD, FXint pt = DEFAULT_PAD, FXint pb = DEFAULT_PAD);
 
    ~MFXComboBoxIcon();
 
    void create();
 
    void detach();
 
    void destroy();
 
    void enable();
 
    void disable();
 
    FXint getDefaultWidth();
 
    FXint getDefaultHeight();
 
    void layout();
 
    FXString getText() const;
 
    FXint getNumItems() const;
 
    void setNumVisible(FXint nvis);
 
    void setText(const FXString& text, FXbool notify = FALSE);
 
    FXbool isItemCurrent(FXint index) const;
 
    long setCurrentItem(const FXint index, FXbool notify = FALSE);
 
    long setCurrentItem(const FXString& text, FXbool notify = FALSE);
 
    FXint getCurrentItem() const;
 
    FXint updateIconItem(FXint index, const FXString& text, FXIcon* icon = nullptr, FXColor bgColor = FXRGB(255, 255, 255), void* ptr = nullptr);
 
    FXint insertIconItem(FXint index, const FXString& text, FXIcon* icon = nullptr, FXColor bgColor = FXRGB(255, 255, 255), void* ptr = nullptr);
 
    FXint appendIconItem(const FXString& text, FXIcon* icon = nullptr, FXColor bgColor = FXRGB(255, 255, 255), void* ptr = nullptr);
 
    void removeItem(FXint index);
 
    virtual void clearItems();
 
    FXint findItem(const FXString& text) const;
 
    std::string getItemText(FXint index) const;
 
    void setBackColor(FXColor clr);
 
    void setTextColor(FXColor clr);
 
    FXColor getTextColor() const;
 
    void setTipText(const FXString& txt);
 
    const FXString& getTipText() const;
 
 
    long onFocusUp(FXObject*, FXSelector, void*);
    long onFocusDown(FXObject*, FXSelector, void*);
    long onFocusSelf(FXObject*, FXSelector, void*);
    long onMouseWheel(FXObject*, FXSelector, void*);
    long onTextButton(FXObject*, FXSelector, void*);
    long onTextChanged(FXObject*, FXSelector, void*);
    long onTextCommand(FXObject*, FXSelector, void*);
    long onListClicked(FXObject*, FXSelector, void*);
    long onFwdToText(FXObject*, FXSelector, void*);
    long onUpdFmText(FXObject*, FXSelector, void*);
    long onCmdFilter(FXObject*, FXSelector, void*);
 
 
protected:
    MFXComboBoxIcon();
 
    MFXTextFieldIcon* myTextFieldIcon = nullptr;
 
    FXMenuButton* myButton = nullptr;
 
    MFXListIcon* myList = nullptr;
 
    MFXTextFieldSearch* myTextFieldSearch = nullptr;
 
    FXPopup* myPane = nullptr;
 
    FXLabel* myNoItemsLabel = nullptr;
 
private:
    MFXComboBoxIcon(const MFXComboBoxIcon&) = delete;
 
    MFXComboBoxIcon& operator=(const MFXComboBoxIcon&) = delete;
};