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 "unoview.hxx"
  26
  27
  28 namespace com::sun::star::presentation { class XSlideShowView; }
  29
  30 /* Definition of UnoViewContainer class */
  31
  32 namespace slideshow::internal
  33     {
  34         /** Contains UnoViews
  35          */
  36         class UnoViewContainer
  37         {
  38         public:
  39             UnoViewContainer();
  40             UnoViewContainer(const UnoViewContainer&) = delete;
  41             UnoViewContainer& operator=(const UnoViewContainer&) = delete;
  42
  43             /** Add a view to this container
  44
  45                 @return true, if the view was successfully added
  46                 (false is e.g. returned, if the view was already
  47                 added)
  48              */
  49             bool addView( const UnoViewSharedPtr& rView );
  50
  51             /** Remove a previously added a view from this container
  52
  53                 @return the View object, if this view was successfully
  54                 removed, and an empty shared_ptr otherwise (e.g. if
  55                 this view wasn't added in the first place)
  56             */
  57             UnoViewSharedPtr removeView( const css::uno::Reference<css::presentation::XSlideShowView >& xView );
  58
  59             /// Dispose all stored views. Implies clear().
  60             void dispose();
  61
  62             // the following parrots STL container concept methods
  63             // ===================================================
  64
  65             bool empty() const { return maViews.empty(); }
  66
  67             UnoViewVector::iterator         begin() { return maViews.begin(); }
  68             UnoViewVector::const_iterator   begin() const { return maViews.begin(); }
  69             UnoViewVector::iterator         end() { return maViews.end(); }
  70             UnoViewVector::const_iterator   end() const { return maViews.end(); }
  71
  72         private:
  73             /// All added views
  74             UnoViewVector   maViews;
  75         };
  76
  77 }
  78
  79 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_UNOVIEWCONTAINER_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */