svx/inc/svdviter.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: svdviter.hxx,v $
  10  * $Revision: 1.5 $
  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 _SVDVITER_HXX
  32 #define _SVDVITER_HXX
  33
  34 #include <tools/solar.h>
  35 #include <sal/types.h>
  36 #include "svx/svxdllapi.h"
  37
  38 ////////////////////////////////////////////////////////////////////////////////////////////////////
  39
  40 class OutputDevice;
  41 class Window;
  42 class SdrView;
  43 class SdrPageView;
  44 class SdrModel;
  45 class SdrPage;
  46 class SdrObject;
  47 class SetOfByte;
  48
  49 ////////////////////////////////////////////////////////////////////////////////////////////////////
  50
  51 class SVX_DLLPUBLIC SdrViewIter
  52 {
  53     const SdrModel*                                                                             mpModel;
  54     const SdrPage*                                                                              mpPage;
  55     const SdrObject*                                                                    mpObject;
  56     SdrView*                                                                                    mpAktView;
  57
  58     sal_uInt32                                                                                  mnListenerNum;
  59     sal_uInt32                                                                                  mnPageViewNum;
  60     sal_uInt32                                                                                  mnOutDevNum;
  61
  62     // bitfield
  63     unsigned                                                                                    mbNoMasterPage : 1;
  64
  65 private:
  66     SVX_DLLPRIVATE void          ImpInitVars();
  67     SVX_DLLPRIVATE SdrView*      ImpFindView();
  68     SVX_DLLPRIVATE SdrPageView*  ImpFindPageView();
  69     SVX_DLLPRIVATE OutputDevice* ImpFindOutDev();
  70     SVX_DLLPRIVATE Window*       ImpFindWindow();
  71     SVX_DLLPRIVATE sal_Bool              ImpCheckPageView(SdrPageView* pPV) const;
  72
  73 public:
  74     SdrViewIter(const SdrModel* pModel);
  75     SdrViewIter(const SdrPage* pPage, sal_Bool bNoMasterPage = sal_False);
  76     SdrViewIter(const SdrObject* pObject, sal_Bool bNoMasterPage = sal_False);
  77
  78     SdrView* FirstView();
  79     SdrView* NextView();
  80
  81     SdrPageView* FirstPageView();
  82     SdrPageView* NextPageView();
  83
  84     OutputDevice* FirstOutDev();
  85     OutputDevice* NextOutDev();
  86
  87     Window* FirstWindow();
  88     Window* NextWindow();
  89 };
  90
  91 ////////////////////////////////////////////////////////////////////////////////////////////////////
  92
  93 #ifdef _JUST_DESCRIPTION
  94
  95 Mit dieser Klasse kann man rausbekommen:
  96 - SdrView* First/NextView()
  97   - Alle Views in denen ein Models dargestellt wird
  98   - Alle Views in denen eine bestimme Page sichtbar ist (ww. auch als MasterPage)
  99   - Alle Views in denen ein bestimmes Objekt sichtbar ist (ww. auch auf MasterPage)
 100 - SdrPageView* First/NextPageView()
 101   - Alle PageViews in denen ein Models dargestellt wird
 102   - Alle PageViews in denen eine bestimme Page sichtbar ist (ww. auch als MasterPage)
 103   - Alle PageViews in denen ein bestimmes Objekt sichtbar ist (ww. auch auf MasterPage)
 104 - OutputDevice* First/NextOutDev()
 105   - Alle OutputDevices in denen ein Models dargestellt wird
 106   - Alle OutputDevices in denen eine bestimme Page sichtbar ist (ww. auch als MasterPage)
 107   - Alle OutputDevices in denen ein bestimmes Objekt sichtbar ist (ww. auch auf MasterPage)
 108 - Window* First/NextWindow()
 109   - Alle Windows in denen ein Models dargestellt wird
 110   - Alle Windows in denen eine bestimme Page sichtbar ist (auch als MasterPage)
 111   - Alle Windows in denen ein bestimmes Objekt sichtbar ist (auch auf MasterPage)
 112 Ob die Auswahl auf ein(e) bestimmte(s) Page/Objekt beschraenkt wird, bestimmt man
 113 durch die Wahl des Konstruktors.
 114
 115 Es werden u.a. auch berueksichtigt:
 116 - Layer Sichtbarkeitsstatus
 117 - Visible Layer von MasterPages
 118 - Mehrfachlayer bei Gruppenobjekten
 119
 120 Es wird nicht berueksichtigt:
 121 - Ob die Pages/Objekte wirklich schon gepaintet wurden oder noch ein Invalidate ansteht, ...
 122 - Ob die Pages/Objekte in einem Window im sichtbaren Bereich liegen
 123
 124 #endif // _JUST_DESCRIPTION
 125
 126 ////////////////////////////////////////////////////////////////////////////////////////////////////
 127
 128 #endif //_SVDVITER_HXX
 129