include/svx/svdviter.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_SVX_SVDVITER_HXX
  21 #define INCLUDED_SVX_SVDVITER_HXX
  22
  23 #include <sal/types.h>
  24 #include <svx/svxdllapi.h>
  25
  26 /*
  27
  28 Using this class, you can find out:
  29 - SdrView* First/NextView()
  30   - All Views in which a model is displayed
  31   - All Views in which a certain page is visible (also as MasterPage)
  32   - All Views in which a certain object is visible (also as MasterPage)
  33 - SdrPageView* First/NextPageView()
  34   - All PageViews in which a model is displayed
  35   - All PageViews in which a certain page is visible (also as MasterPage)
  36   - All PageViews in which a certain object is visible (also as MasterPage)
  37 - vcl::Window* First/NextWindow()
  38   - All Windows in which a model is displayed
  39   - All Windows in which a certain page is visible (also as MasterPage)
  40   - All Windows in which a certain object is visible (also as MasterPage)
  41 You can specify if the selection is restricted to a certain page/object by
  42 choosing the corresponding constructor.
  43
  44 Among others, the following are considered:
  45 - Visibility state of the layer
  46 - Visible Layer of MasterPages
  47 - Multiple layer for group objects
  48
  49 Not considered are:
  50 - Whether the pages/objects were already painted or if an Invalidate is still pending
  51 - Whether the pages/objects in a Window are in a visible region
  52
  53 */
  54
  55 class OutputDevice;
  56 namespace vcl { class Window; }
  57 class SdrView;
  58 class SdrPageView;
  59 class SdrModel;
  60 class SdrPage;
  61 class SdrObject;
  62 class SdrLayerIDSet;
  63
  64 class SVX_DLLPUBLIC SdrViewIter
  65 {
  66     const SdrModel*                                     mpModel;
  67     const SdrPage*                                      mpPage;
  68     const SdrObject*                                    mpObject;
  69     SdrView*                                            mpCurrentView;
  70
  71     size_t                                              mnListenerNum;
  72
  73 private:
  74     SVX_DLLPRIVATE void          ImpInitVars();
  75     SVX_DLLPRIVATE SdrView*      ImpFindView();
  76     SVX_DLLPRIVATE bool          ImpCheckPageView(SdrPageView const * pPV) const;
  77
  78 public:
  79     SdrViewIter(const SdrPage* pPage);
  80     SdrViewIter(const SdrObject* pObject);
  81
  82     SdrView* FirstView();
  83     SdrView* NextView();
  84 };
  85
  86 #endif // INCLUDED_SVX_SVDVITER_HXX
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */