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