xmlsecurity/source/framework/elementmark.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: elementmark.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _ELEMENTMARK_HXX
  32 #define _ELEMENTMARK_HXX
  33
  34 #include <com/sun/star/lang/XServiceInfo.hpp>
  35 #include <com/sun/star/xml/crypto/sax/ElementMarkType.hpp>
  36
  37 class BufferNode;
  38
  39 class ElementMark
  40 /****** elementmark.hxx/CLASS ElementMark *************************************
  41  *
  42  *   NAME
  43  *      ElementMark -- Class to manipulate an element mark
  44  *
  45  *   FUNCTION
  46  *      This class maintains the security id, buffer id and its type for a
  47  *      buffer node.
  48  *
  49  *   HISTORY
  50  *      05.01.2004 -    implemented
  51  *
  52  *   AUTHOR
  53  *      Michael Mi
  54  *      Email: michael.mi@sun.com
  55  ******************************************************************************/
  56 {
  57 protected:
  58     /* the BufferNode maintained by this object */
  59     BufferNode* m_pBufferNode;
  60
  61     /* the security Id */
  62     sal_Int32 m_nSecurityId;
  63
  64     /* the buffer Id */
  65     sal_Int32 m_nBufferId;
  66
  67     /*
  68      * the type value, is one of following values:
  69      * TYPEOFELEMENTMARK - the default value, represents an blocker if
  70      *                     not changed
  71      * TYPEOFELEMENTCOLLECTOR - represents an ElementCollector
  72      */
  73     com::sun::star::xml::crypto::sax::ElementMarkType m_type;
  74
  75 public:
  76     ElementMark(sal_Int32 nSecurityId, sal_Int32 nBufferId);
  77     virtual ~ElementMark() {};
  78
  79     BufferNode* getBufferNode() const;
  80     void setBufferNode(const BufferNode* pBufferNode);
  81     sal_Int32 getSecurityId() const;
  82     void setSecurityId(sal_Int32 nSecurityId);
  83     com::sun::star::xml::crypto::sax::ElementMarkType getType() const;
  84     sal_Int32 getBufferId() const;
  85 };
  86
  87 #endif
  88