uiInfoHandler.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/uiInfoHandler.h"
#ifndef _uiInfoHandler
#define _uiInfoHandler

// ===========================================================================
// Copyright 2020 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================

#include "common/ufeExport.h"

#include "sceneItem.h"
#include "types.h"

#include <string>

UFE_NS_DEF {


struct UFE_SDK_DECL CellInfo {

    CellInfo() = default;
    CellInfo(
        const std::string& argFontName,
        double             argFontPointSize,
        bool               argFontBold,
        bool               argFontItalics,
        bool               argFontStrikeout,
        const Color3f&     argTextFgColor,
        const Color3f&     argTextBgColor
    );
    CellInfo(const CellInfo&) = default;

    std::string fontName;

    double fontPointSize{-1.0};

    bool fontBold{false};

    bool fontItalics{false};

    bool fontStrikeout{false};

    Color3f textFgColor;

    Color3f textBgColor;
};

class UFE_SDK_DECL UIInfoHandler
{
public:
    typedef std::shared_ptr<UIInfoHandler> Ptr;

    enum Quadrant {None, UpperLeft, UpperRight, LowerLeft, LowerRight};

    enum Mode
    {
        Normal,     
        Disabled,   
        Active,     
        Selected    
    };

    struct Icon {
        Icon() {}
        Icon(const std::string& baseIconArg)
            : baseIcon(baseIconArg) {}
        Icon(const std::string& baseIconArg, Mode modeArg)
            : baseIcon(baseIconArg), mode(modeArg) {}
        Icon(const std::string& baseIconArg, const std::string& badgeIconArg, Quadrant posArg)
            : baseIcon(baseIconArg), badgeIcon(badgeIconArg), pos(posArg) {}

        std::string baseIcon;
        std::string badgeIcon;
        Quadrant pos{None};
        Mode mode{Normal};
    };

    static Ptr uiInfoHandler(Rtid rt);

    UIInfoHandler() = default;
    UIInfoHandler(const UIInfoHandler&) = default;
    virtual ~UIInfoHandler() = default;

    virtual bool treeViewCellInfo(const SceneItem::Ptr& item, CellInfo& info) const = 0;

    virtual Icon treeViewIcon(const SceneItem::Ptr& item) const;

    virtual std::string treeViewTooltip(const SceneItem::Ptr& item) const;

    virtual std::string getLongRunTimeLabel() const = 0;
};

}

#endif // _uiInfoHandler