summaryrefslogtreecommitdiff
path: root/svx/inc/svditer.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'svx/inc/svditer.hxx')
-rw-r--r--svx/inc/svditer.hxx84
1 files changed, 84 insertions, 0 deletions
diff --git a/svx/inc/svditer.hxx b/svx/inc/svditer.hxx
new file mode 100644
index 000000000000..92325f281c92
--- /dev/null
+++ b/svx/inc/svditer.hxx
@@ -0,0 +1,84 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: svditer.hxx,v $
+ * $Revision: 1.9.246.1 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef _SVDITER_HXX
+#define _SVDITER_HXX
+
+#include <sal/types.h>
+#include <tools/list.hxx>
+#include "svx/svxdllapi.h"
+
+class SdrObjList;
+class SdrObject;
+class SdrMarkList;
+
+// SdrObjListIter methods:
+// IM_FLAT : Flach ueber die Liste
+// IM_DEEPWITHGROUPS : Mit rekursivem Abstieg, Next() liefert auch Gruppenobjekte
+// IM_DEEPNOGROUPS : Mit rekursivem Abstieg, Next() liefert keine Gruppenobjekte
+enum SdrIterMode { IM_FLAT, IM_DEEPWITHGROUPS, IM_DEEPNOGROUPS};
+
+class SVX_DLLPUBLIC SdrObjListIter
+{
+ List maObjList;
+ sal_uInt32 mnIndex;
+ BOOL mbReverse;
+
+ void ImpProcessObjectList(const SdrObjList& rObjList, SdrIterMode eMode, BOOL bUseZOrder);
+ void ImpProcessMarkList(const SdrMarkList& rMarkList, SdrIterMode eMode);
+ void ImpProcessObj(SdrObject* pObj, SdrIterMode eMode, BOOL bUseZOrder);
+
+public:
+ SdrObjListIter(const SdrObjList& rObjList, SdrIterMode eMode = IM_DEEPNOGROUPS, BOOL bReverse = FALSE);
+ /** This variant lets the user choose the order in which to travel over
+ the objects.
+ @param bUseZOrder
+ When <TRUE/> then the z-order defines the order of iteration.
+ Otherwise the navigation position as returned by
+ SdrObject::GetNavigationPosition() is used.
+ */
+ SdrObjListIter(const SdrObjList& rObjList, BOOL bUseZOrder, SdrIterMode eMode = IM_DEEPNOGROUPS, BOOL bReverse = FALSE);
+
+ /* SJ: the following function can now be used with every
+ SdrObject and is no longer limited to group objects */
+ SdrObjListIter(const SdrObject& rObj, SdrIterMode eMode = IM_DEEPNOGROUPS, BOOL bReverse = FALSE);
+
+ /** Iterates over a list of marked objects received from the SdrMarkView. */
+ SdrObjListIter(const SdrMarkList& rMarkList, SdrIterMode eMode = IM_DEEPNOGROUPS, BOOL bReverse = FALSE);
+
+ void Reset() { mnIndex = (mbReverse ? maObjList.Count() : 0L); }
+ BOOL IsMore() const { return (mbReverse ? mnIndex != 0 : ( mnIndex < maObjList.Count())); }
+ SdrObject* Next() { return (SdrObject*)maObjList.GetObject(mbReverse ? --mnIndex : mnIndex++); }
+
+ sal_uInt32 Count() { return maObjList.Count(); }
+};
+
+#endif //_SVDITER_HXX
+