slideshow/source/engine/animationnodes/nodetools.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: nodetools.hxx,v $
  10  * $Revision: 1.7 $
  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 INCLUDED_SLIDESHOW_NODETOOLS_HXX
  32 #define INCLUDED_SLIDESHOW_NODETOOLS_HXX
  33
  34 #include <com/sun/star/uno/Sequence.hxx>
  35 #include <com/sun/star/beans/NamedValue.hpp>
  36 #include <com/sun/star/drawing/XShape.hpp>
  37
  38 #include "shapemanager.hxx"
  39 #include "basenode.hxx"
  40 #include "doctreenode.hxx"
  41 #include "attributableshape.hxx"
  42
  43
  44 #if defined(VERBOSE) && defined(DBG_UTIL)
  45 # define DEBUG_NODES_SHOWTREE(a) debugNodesShowTree(a);
  46 # define DEBUG_NODES_SHOWTREE_WITHIN(a) debugNodesShowTreeWithin(a);
  47 #else
  48 # define DEBUG_NODES_SHOWTREE(a)
  49 # define DEBUG_NODES_SHOWTREE_WITHIN(a)
  50 #endif
  51
  52 namespace slideshow
  53 {
  54     namespace internal
  55     {
  56
  57         // Tools
  58         //=========================================================================
  59
  60 #if defined(VERBOSE) && defined(DBG_UTIL)
  61         int& debugGetCurrentOffset();
  62         void debugNodesShowTree( const BaseNode* );
  63         void debugNodesShowTreeWithin( const BaseNode* );
  64 #endif
  65
  66         /** Look up an AttributableShape from ShapeManager.
  67
  68             This method retrieves an AttributableShape pointer, given
  69             an XShape and a LayerManager.
  70
  71             Throws a runtime exception if there's no such shape, or if
  72             it does not implement the AttributableShape interface.
  73          */
  74         AttributableShapeSharedPtr lookupAttributableShape( const ShapeManagerSharedPtr&                                rShapeManager,
  75                                                             const ::com::sun::star::uno::Reference<
  76                                                                 ::com::sun::star::drawing::XShape >&    xShape                  );
  77
  78         /** Predicate whether a Begin, Duration or End timing is
  79             indefinite, i.e. either contains no value, or the
  80             value Timing_INDEFINITE.
  81         */
  82         bool isIndefiniteTiming( const ::com::sun::star::uno::Any& rAny );
  83
  84         /// Extract the node type from the user data
  85         bool getNodeType( sal_Int16&                                                             o_rNodeType,
  86                           const ::com::sun::star::uno::Sequence<
  87                               ::com::sun::star::beans::NamedValue >& rValues );
  88     }
  89 }
  90
  91 #endif /* INCLUDED_SLIDESHOW_NODETOOLS_HXX */