source/libs/poppler/poppler-src/poppler/OptionalContent.h

   1 //========================================================================
   2 //
   3 // OptionalContent.h
   4 //
   5 // Copyright 2007 Brad Hards <bradh@kde.org>
   6 // Copyright 2008 Carlos Garcia Campos <carlosgc@gnome.org>
   7 // Copyright 2013 Albert Astals Cid <aacid@kde.org>
   8 //
   9 // Released under the GPL (version 2, or later, at your option)
  10 //
  11 //========================================================================
  12
  13 #ifndef OPTIONALCONTENT_H
  14 #define OPTIONALCONTENT_H
  15
  16 #ifdef USE_GCC_PRAGMAS
  17 #pragma interface
  18 #endif
  19
  20 #include "Object.h"
  21 #include "CharTypes.h"
  22
  23 class GooString;
  24 class GooList;
  25 class XRef;
  26
  27 class OptionalContentGroup;
  28 class OCDisplayNode;
  29
  30 //------------------------------------------------------------------------
  31
  32 class OCGs {
  33 public:
  34
  35   OCGs(Object *ocgObject, XRef *xref);
  36   ~OCGs();
  37
  38   // Is OCGS valid?
  39   GBool isOk() { return ok; }
  40
  41   bool hasOCGs();
  42   GooList *getOCGs() const { return optionalContentGroups; }
  43
  44   OptionalContentGroup* findOcgByRef( const Ref &ref);
  45
  46   // Get the root node of the optional content group display tree
  47   // (which does not necessarily include all of the OCGs).
  48   OCDisplayNode *getDisplayRoot();
  49
  50   Array* getOrderArray()
  51     { return (order.isArray() && order.arrayGetLength() > 0) ? order.getArray() : NULL; }
  52   Array* getRBGroupsArray()
  53     { return (rbgroups.isArray() && rbgroups.arrayGetLength()) ? rbgroups.getArray() : NULL; }
  54
  55   bool optContentIsVisible( Object *dictRef );
  56
  57 private:
  58   GBool ok;
  59
  60   GBool evalOCVisibilityExpr(Object *expr, int recursion);
  61   bool allOn( Array *ocgArray );
  62   bool allOff( Array *ocgArray );
  63   bool anyOn( Array *ocgArray );
  64   bool anyOff( Array *ocgArray );
  65
  66   GooList *optionalContentGroups;
  67
  68   Object order;
  69   Object rbgroups;
  70   XRef *m_xref;
  71   OCDisplayNode *display; // root node of display tree
  72 };
  73
  74 //------------------------------------------------------------------------
  75
  76 class OptionalContentGroup {
  77 public:
  78   enum State { On, Off };
  79
  80   // Values from the optional content usage dictionary.
  81   enum UsageState {
  82     ocUsageOn,
  83     ocUsageOff,
  84     ocUsageUnset
  85   };
  86
  87   OptionalContentGroup(Dict *dict);
  88
  89   OptionalContentGroup(GooString *label);
  90
  91   ~OptionalContentGroup();
  92
  93   GooString* getName() const;
  94
  95   Ref getRef() const;
  96   void setRef(const Ref ref);
  97
  98   State getState() { return m_state; };
  99   void setState(State state) { m_state = state; };
 100
 101   UsageState getViewState() { return viewState; }
 102   UsageState getPrintState() { return printState; }
 103
 104 private:
 105   GooString *m_name;
 106   Ref m_ref;
 107   State m_state;
 108   UsageState viewState;  // suggested state when viewing
 109   UsageState printState; // suggested state when printing
 110 };
 111
 112 //------------------------------------------------------------------------
 113
 114 class OCDisplayNode {
 115 public:
 116
 117   static OCDisplayNode *parse(Object *obj, OCGs *oc, XRef *xref, int recursion = 0);
 118   OCDisplayNode();
 119   ~OCDisplayNode();
 120
 121   GooString *getName() { return name; }
 122   OptionalContentGroup *getOCG() { return ocg; }
 123   int getNumChildren();
 124   OCDisplayNode *getChild(int idx);
 125
 126 private:
 127
 128   OCDisplayNode(GooString *nameA);
 129   OCDisplayNode(OptionalContentGroup *ocgA);
 130   void addChild(OCDisplayNode *child);
 131   void addChildren(GooList *childrenA);
 132   GooList *takeChildren();
 133
 134   GooString *name;              // display name (may be NULL)
 135   OptionalContentGroup *ocg;    // NULL for display labels
 136   GooList *children;            // NULL if there are no children
 137                                 //   [OCDisplayNode]
 138 };
 139
 140 #endif