Group.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFOCGGroup
#define PDFTRON_H_CPPPDFOCGGroup
 
#include <PDF/OCG/Config.h>
#include <C/PDF/OCG/TRN_OCG.h>
 
namespace pdftron {
    namespace PDF {
        class PDFDoc;
        namespace OCG {
            class Context;

class Group
{
public:

    static Group Create(PDFDoc& doc, const UString& name);
 
    Group(SDF::Obj ocg);
 
    bool IsValid() const;

    UString GetName() const;  

    void SetName(const UString& name);

    bool GetCurrentState(const class Context& context) const;   

    void SetCurrentState(class Context& context, bool state);

    bool GetInitialState(const class Config& config) const;
 
    void SetInitialState(class Config& config, bool state);

    SDF::Obj GetIntent() const;

    void SetIntent(SDF::Obj intent);
 
    bool IsLocked(const Config& config) const;

    void SetLocked(const Config& config, bool locked);

    bool HasUsage() const;

    SDF::Obj GetUsage(const char* key) const;

    SDF::Obj GetSDFObj () const;

    Group (const Group& g);
    Group& operator=(const Group& g);
 
    #ifndef SWIGHIDDEN
    Group(TRN_OCG g) : mp_obj(g) {}
    TRN_OCG mp_obj;
    #endif
};
 
        };  // namespace OCG
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFOCGGroup