OCMD.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_CPPPDFOCGOCMD
#define PDFTRON_H_CPPPDFOCGOCMD
 
#include <C/PDF/OCG/TRN_OCMD.h>
#include <Common/BasicTypes.h>
 
namespace pdftron { 
    namespace PDF {
        namespace OCG {

class OCMD
{
public: 
  
    enum VisibilityPolicyType {
        e_AllOn,  
        e_AnyOn,  
        e_AnyOff, 
        e_AllOff  
    };

    static OCMD Create(PDFDoc& doc, SDF::Obj ocgs, VisibilityPolicyType vis_policy);
 
    OCMD(SDF::Obj ocmd);
 
    bool IsValid() const;

    SDF::Obj GetOCGs() const;    

    VisibilityPolicyType GetVisibilityPolicy() const;

    void SetVisibilityPolicy(VisibilityPolicyType vis_policy);

    SDF::Obj GetVisibilityExpression() const;

    bool IsCurrentlyVisible(const class Context& context) const;   

    SDF::Obj GetSDFObj () const;

    OCMD (const OCMD& g);
    OCMD& operator=(const OCMD& g);
 
    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
    OCMD(TRN_OCMD o) : mp_obj(o) {}
    TRN_OCMD mp_obj;
    #endif
    // @endcond
};
 
        };  // namespace OCG
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFOCGOCMD