attributeHints.h

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//

#ifndef PXR_USD_USDUI_ATTRIBUTE_HINTS_H
#define PXR_USD_USDUI_ATTRIBUTE_HINTS_H

#include "pxr/usd/usdUI/propertyHints.h"
#include "pxr/usd/usd/attribute.h"

#include "pxr/base/vt/dictionary.h"
#include "pxr/base/vt/value.h"

#include <string>

PXR_NAMESPACE_OPEN_SCOPE

class UsdUIAttributeHints : public UsdUIPropertyHints
{
public:
    USDUI_API
    UsdUIAttributeHints();

    USDUI_API
    explicit UsdUIAttributeHints(const UsdAttribute& attr);

    UsdAttribute GetAttribute() const { return _attr; }

    USDUI_API
    VtDictionary GetValueLabels() const;

    USDUI_API
    bool SetValueLabels(const VtDictionary& labels);

    USDUI_API
    VtTokenArray GetValueLabelsOrder() const;

    USDUI_API
    bool SetValueLabelsOrder(const VtTokenArray& order);

    USDUI_API
    bool ApplyValueLabel(const std::string& label);

private:
    UsdAttribute _attr;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif