MFXListIcon.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2006-2024 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 <string>
#include <vector>
 
#include "MFXListIconItem.h"
 
class MFXListIcon : public FXScrollArea {
    FXDECLARE(MFXListIcon)
 
public:
    enum {
        ID_LOOKUPTIMER = FXScrollArea::ID_LAST,
        ID_LAST
    };
 
    MFXListIcon(FXComposite* p, FXObject* tgt = NULL, FXSelector sel = 0, FXuint opts = LIST_NORMAL, FXint x = 0, FXint y = 0, FXint w = 0, FXint h = 0);
 
    ~MFXListIcon();
 
    void create();
 
    void detach();
 
    void layout();
 
    FXint getDefaultWidth();
 
    FXint getDefaultHeight();
 
    FXint getContentWidth();
 
    FXint getContentHeight();
 
    void recalc();
 
    bool canFocus() const;
 
    void setFocus();
 
    void killFocus();
 
    FXint getNumItems() const {
        return (int)items.size();
    }
 
    FXint getNumVisible() const {
        return visible;
    }
 
    void setNumVisible(FXint nvis);
 
    MFXListIconItem* getItem(FXint index) const;
 
    FXint setItem(FXint index, MFXListIconItem* item, FXbool notify = FALSE);
 
    FXint editItem(FXint index, const FXString& text, FXIcon* icon = NULL, void* ptr = NULL, FXbool notify = FALSE);
 
    FXint insertItem(FXint index, MFXListIconItem* item, FXbool notify = FALSE);
 
    FXint insertItem(FXint index, const FXString& text, FXIcon* icon = NULL, void* ptr = NULL, FXbool notify = FALSE);
 
    FXint appendItem(MFXListIconItem* item, FXbool notify = FALSE);
 
    FXint appendItem(const FXString& text, FXIcon* icon = NULL, void* ptr = NULL, FXbool notify = FALSE);
 
    void removeItem(FXint index, FXbool notify = FALSE);
 
    void clearItems(FXbool notify = FALSE);
 
    void setFilter(const FXString& value, FXLabel* label);
 
    FXint getItemWidth(FXint index) const;
 
    FXint getItemHeight(FXint index) const;
 
    MFXListIconItem* getItemAt(FXint y) const;
 
    int findItem(const FXString& text) const;
 
    FXint hitItem(MFXListIconItem* item, FXint x, FXint y) const;
 
    void makeItemVisible(MFXListIconItem* item);
 
    void makeItemVisible(FXint index);
 
    FXbool isItemCurrent(FXint index) const;
 
    FXbool isItemVisible(MFXListIconItem* item) const;
 
    void updateItem(MFXListIconItem* item) const;
 
    FXbool selectItem(MFXListIconItem* item, FXbool notify = FALSE);
 
    FXbool deselectItem(MFXListIconItem* item, FXbool notify = FALSE);
 
    FXbool toggleItem(MFXListIconItem* item, FXbool notify = FALSE);
 
    FXbool killSelection(FXbool notify = FALSE);
 
    void setCurrentItem(MFXListIconItem* item, FXbool notify = FALSE);
 
    FXint getCurrentItemIndex() const;
 
    FXint getViewableItem() const;
 
    void setAnchorItem(MFXListIconItem* item);
 
    FXint getAnchorItem() const;
 
    MFXListIconItem* getCursorItem() const;
 
    FXFont* getFont() const {
        return font;
    }
 
    FXColor getTextColor() const {
        return textColor;
    }
 
    void setTextColor(FXColor clr);
 
    FXColor getSelBackColor() const {
        return selbackColor;
    }
 
    FXColor getSelTextColor() const {
        return seltextColor;
    }
 
    void setHelpText(const FXString& text);
 
    const FXString& getHelpText() const {
        return help;
    }
 
    FXString tolowerString(const FXString& str) const;
 
    long onPaint(FXObject*, FXSelector, void*);
    long onEnter(FXObject*, FXSelector, void*);
    long onLeave(FXObject*, FXSelector, void*);
    long onUngrabbed(FXObject*, FXSelector, void*);
    long onKeyPress(FXObject*, FXSelector, void*);
    long onKeyRelease(FXObject*, FXSelector, void*);
    long onLeftBtnPress(FXObject*, FXSelector, void*);
    long onLeftBtnRelease(FXObject*, FXSelector, void*);
    long onRightBtnPress(FXObject*, FXSelector, void*);
    long onRightBtnRelease(FXObject*, FXSelector, void*);
    long onMotion(FXObject*, FXSelector, void*);
    long onFocusIn(FXObject*, FXSelector, void*);
    long onFocusOut(FXObject*, FXSelector, void*);
    long onAutoScroll(FXObject*, FXSelector, void*);
    long onClicked(FXObject*, FXSelector, void*);
    long onDoubleClicked(FXObject*, FXSelector, void*);
    long onTripleClicked(FXObject*, FXSelector, void*);
    long onCommand(FXObject*, FXSelector, void*);
    long onQueryTip(FXObject*, FXSelector, void*);
    long onQueryHelp(FXObject*, FXSelector, void*);
    long onTipTimer(FXObject*, FXSelector, void*);
    long onLookupTimer(FXObject*, FXSelector, void*);
 
protected:
    MFXListIcon();
 
    void recompute();
 
    MFXListIconItem* createItem(const FXString& text, FXIcon* icon, void* ptr);
 
    std::vector<MFXListIconItem*> items;
 
    std::vector<MFXListIconItem*> itemFiltered;
 
    FXint anchor = -1;
 
    MFXListIconItem* currentItem = nullptr;
 
    FXint extent = -1;
 
    MFXListIconItem* cursor = nullptr;
 
    MFXListIconItem* viewable = nullptr;
 
    FXFont* font = nullptr;
 
    FXColor textColor = 0;
 
    FXColor selbackColor = 0;
 
    FXColor seltextColor = 0;
 
    FXint listWidth = 0;
 
    FXint listHeight = 0;
 
    FXint visible = 0;
 
    FXString help;
 
    FXint grabx = 0;
 
    FXint graby = 0;
 
    FXString lookup;
 
    FXbool state = FALSE;
 
    FXString filter;
 
private:
    typedef FXint(*FXCompareFunc)(const FXString&, const FXString&, FXint);
 
    bool showItem(const FXString& itemName) const;
 
    MFXListIcon(const FXList&) = delete;
 
    MFXListIcon&   operator = (const FXList&) = delete;
};