MFXListIconItem.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
/****************************************************************************/
//
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "fxheader.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class MFXListIcon;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class MFXListIconItem : public FXObject {
    FXDECLARE(MFXListIconItem)
 
    
    friend class MFXListIcon;
 
public:
    enum {
        SELECTED  = 1,      
        FOCUS     = 2,      
        DISABLED  = 4,      
        DRAGGABLE = 8,      
        ICONOWNED = 16      
    };

    MFXListIconItem(const FXString& text, FXIcon* ic = NULL, FXColor backGroundColor = 0, void* ptr = NULL);

    ~MFXListIconItem();

    void setText(const FXString& txt);

    const FXString& getText() const;

    FXIcon* getIcon() const;

    const FXColor& getBackGroundColor() const;

    void setFocus(FXbool focus);

    FXbool hasFocus() const;

    void setSelected(FXbool selected);

    FXbool isSelected() const;

    void setEnabled(FXbool enabled);

    FXbool isEnabled() const;

    void setDraggable(FXbool draggable);

    FXbool isDraggable() const;

    FXint getWidth(const MFXListIcon* list) const;

    FXint getHeight(const MFXListIcon* list) const;

    void create();

    void detach();

    void destroy();
 
protected:
    MFXListIconItem();

    void draw(const MFXListIcon* list, FXDC&   dc, FXint x, FXint y, FXint w, FXint h);

    FXint hitItem(const MFXListIcon* list, FXint x, FXint y) const;

    FXString label;

    FXIcon* icon = nullptr;

    void* data = nullptr;

    FXuint state = 0;

    FXint x = 0;
    FXint y = 0;

    FXColor myBackGroundColor = 0;

    bool show = true;
 
private:
    MFXListIconItem(const MFXListIconItem&) = delete;

    MFXListIconItem&   operator = (const MFXListIconItem&) = delete;
};