MFXIconComboBox.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2006-2023 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
/****************************************************************************/
//
/****************************************************************************/
 
#pragma once
#include <config.h>
 
#include "MFXTextFieldIcon.h"
 
 
class MFXListItem : public FXListItem {
    FXDECLARE(MFXListItem)
 
public:
    MFXListItem(const FXString& text, FXIcon* ic, FXColor backGroundColor, void* ptr = NULL);
 
    void draw(const FXList* list, FXDC& dc, FXint x, FXint y, FXint w, FXint h);
 
    const FXColor& getBackGroundColor() const;
 
protected:
    MFXListItem();
 
    FXColor myBackGroundColor;
};
 
 
class MFXIconComboBox : public FXPacker {
    FXDECLARE(MFXIconComboBox)
 
public:
    enum {
        ID_LIST = FXPacker::ID_LAST,
        ID_TEXT,
        ID_LAST
    };
 
    MFXIconComboBox(FXComposite* p, FXint cols, const bool haveIcons, FXObject* tgt = NULL, 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);
 
    virtual ~MFXIconComboBox();
 
    virtual void create();
 
    virtual void detach();
 
    virtual void destroy();
 
    virtual void enable();
 
    virtual void disable();
 
    virtual FXint getDefaultWidth();
 
    virtual FXint getDefaultHeight();
 
    virtual void layout();
 
    FXbool isEditable() const;
 
    void setEditable(FXbool edit = TRUE);
 
    FXString getText() const;
 
    void setNumColumns(FXint cols);
 
    FXint getNumColumns() const;
 
    void setJustify(FXuint mode);
 
    FXuint getJustify() const;
 
    FXint getNumItems() const;
 
    FXint getNumVisible() const;
 
    void setText(FXString text);
 
    void setNumVisible(FXint nvis);
 
    FXbool isItemCurrent(FXint index) const;
 
    void setCurrentItem(FXint index, FXbool notify = FALSE);
 
    FXint getCurrentItem() const;
 
    FXString getItem(FXint index) const;
 
    FXint setIconItem(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);
 
    bool setItem(const FXString& text, FXIcon* icon);
 
    void setCustomText(const FXString text);
 
    FXint prependItem(const FXString& text, void* ptr = NULL);
 
    FXint moveItem(FXint newindex, FXint oldindex);
 
    void removeItem(FXint index);
 
    void clearItems();
 
    FXint findItem(const FXString& text, FXint start = -1, FXuint flags = SEARCH_FORWARD | SEARCH_WRAP) const;
 
    FXint findItemByData(const void* ptr, FXint start = -1, FXuint flags = SEARCH_FORWARD | SEARCH_WRAP) const;
 
    FXString getItemText(FXint index) const;
 
    void setItemData(FXint index, void* ptr) const;
 
    void* getItemData(FXint index) const;
 
    FXbool isPaneShown() const;
 
    void sortItems();
 
    void setFont(FXFont* fnt);
 
    FXFont* getFont() const;
 
    void setComboStyle(FXuint mode);
 
    FXuint getComboStyle() const;
 
    virtual void setBackColor(FXColor clr);
 
    FXColor getBackColor() const;
 
    void setTextColor(FXColor clr);
 
    FXColor getTextColor() const;
 
    void setSelBackColor(FXColor clr);
 
    FXColor getSelBackColor() const;
 
    void setSelTextColor(FXColor clr);
 
    FXColor getSelTextColor() const;
 
    FXListSortFunc getSortFunc() const;
 
    void setSortFunc(FXListSortFunc func);
 
    void setHelpText(const FXString& txt);
 
    const FXString& getHelpText() 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*);
 
protected:
    MFXIconComboBox();
 
    FXLabel* myIconLabel = nullptr;
 
    MFXTextFieldIcon* myTextFieldIcon = nullptr;
 
    FXMenuButton* myButton = nullptr;
 
    FXList* myList = nullptr;
 
    FXPopup* myPane = nullptr;
 
    const bool myHaveIcons;
 
private:
    MFXIconComboBox(const MFXIconComboBox&);
 
    MFXIconComboBox& operator=(const MFXIconComboBox&) = delete;
};