optional_content.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_
#define PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_
 
#include <string>
#include <vector>
 
#include <pdfsdk/core/optional_content.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {

class OCGroup : public detail::RefCountedHandle<PDOCG> {
public:
    static OCGroup CreateFromPdfObject(const Object& object);

    Object GetPdfObject() const;

    bool Equals(const OCGroup& that) const;

    void SetName(const std::wstring& name);

    std::wstring GetName() const;

    OCMembership CreateOCMembership() const;

    void SetUsageEntry(PDOCUsageCategory category, const Object& entry);

    Object GetUsageEntry(PDOCUsageCategory category) const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCGroup, PDOCG)
};

class OCMembership : public detail::RefCountedHandle<PDOCMD> {
public:
    static OCMembership CreateFromPdfObject(const Object& object);

    static OCMembership CreateFromGroups(const std::vector<OCGroup>& ocgs, PDOCVisibilityPolicy policy = kPDOCVisibilityPolicyAnyOn);

    Object GetPdfObject() const;

    bool IsVisible(const OCContext& context) const;

    PDOCVisibilityPolicy GetVisibilityPolicy() const;

    void SetVisibilityPolicy(PDOCVisibilityPolicy policy);

    std::vector<OCGroup> GetOCGs() const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCMembership, PDOCMD)
};

class OCConfig : public detail::RefCountedHandle<PDOCConfig> {
public:
    static OCConfig CreateFromPdfObject(const Object& object);

    Object GetPdfObject() const;

    void AddOrderEntry(const OCGroup& ocg);

    Object GetOrder() const;

    void SetInitialState(const OCGroup& ocg, bool state, bool preserveRB = true);

    bool GetInitialState(const OCGroup& ocg) const;

    void AddAutoState(PDOCUsageEvent event, const std::vector<OCGroup>& ocgs, const std::vector<PDOCUsageCategory>& categories = {});

    void SetLocked(const OCGroup& ocg, bool locked);

    bool IsLocked(const OCGroup& ocg) const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCConfig, PDOCConfig)
};

class OCContext : public detail::RefCountedHandle<PDOCContext> {
public:
    static OCContext Create(const OCConfig& config);

    static OCContext CreateWithAutoStates(const OCConfig& config, PDOCUsageEvent event);

    OCContext Copy() const;

    OCContext CopyWithAutoStates(PDOCUsageEvent event) const;

    bool GetState(const OCGroup& ocg) const;

    void SetState(const OCGroup& ocg, bool state, bool preserveRB = true);

    void ResetStates(bool all_on);

    bool ApplyAutoStates(PDOCUsageEvent event);

    template<class Evaluator>
    bool ApplyRuntimeAutoStates(PDOCUsageEvent event, Evaluator&& evaluator);

    void SetDrawMode(PDOCDrawMode mode);

    PDOCDrawMode GetDrawMode() const;

    void SetNonOCDrawing(bool draw);

    bool GetNonOCDrawing() const;

    void CommitTo(const OCConfig& config) const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(OCContext, PDOCContext)
};
 
}  // namespace PDF
 
#include "optional_content_impl.inl"
 
#endif  // PDFSDK_CXX_OPTIONAL_CONTENT_H_INCLUDED_