slideshow/source/inc/unoviewcontainer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_INC_UNOVIEWCONTAINER_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_UNOVIEWCONTAINER_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24
  25 #include <boost/shared_ptr.hpp>
  26 #include <boost/utility.hpp>
  27
  28 #include <vector>
  29
  30 #include "unoview.hxx"
  31
  32
  33 namespace com { namespace sun { namespace star { namespace presentation
  34 {
  35     class XSlideShowView;
  36 } } } }
  37
  38 /* Definition of UnoViewContainer class */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         /** Contains UnoViews
  45          */
  46         class UnoViewContainer : private boost::noncopyable
  47         {
  48         public:
  49             UnoViewContainer();
  50
  51             /** Add a view to this container
  52
  53                 @return true, if the view was successfully added
  54                 (false is e.g. returned, if the view was already
  55                 added)
  56              */
  57             bool addView( const UnoViewSharedPtr& rView );
  58
  59             /** Remove a previously added a view from this container
  60
  61                 @return the View object, if this view was successfully
  62                 removed, and an empty shared_ptr otherwise (e.g. if
  63                 this view wasn't added in the first place)
  64             */
  65             UnoViewSharedPtr removeView( const ::com::sun::star::uno::Reference<
  66                                                      ::com::sun::star::presentation::XSlideShowView >& xView );
  67
  68             /// Dispose all stored views. Implies clear().
  69             void dispose();
  70
  71             // the following parrots STL container concept methods
  72             // ===================================================
  73
  74             std::size_t size() const { return maViews.size(); }
  75             bool empty() const { return maViews.empty(); }
  76
  77             void clear() { maViews.clear(); }
  78
  79
  80             UnoViewVector::iterator         begin() { return maViews.begin(); }
  81             UnoViewVector::const_iterator   begin() const { return maViews.begin(); }
  82             UnoViewVector::iterator         end() { return maViews.end(); }
  83             UnoViewVector::const_iterator   end() const { return maViews.end(); }
  84
  85         private:
  86             /// All added views
  87             UnoViewVector   maViews;
  88         };
  89
  90         typedef ::boost::shared_ptr< UnoViewContainer > UnoViewContainerSharedPtr;
  91
  92     }
  93 }
  94
  95 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_UNOVIEWCONTAINER_HXX
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */