1 files changed, 90 insertions, 0 deletions
diff --git a/basctl/source/basicide/documentenumeration.hxx b/basctl/source/basicide/documentenumeration.hxx
new file mode 100644
index 000000000..084a4aa0c
--- /dev/null
+++ b/basctl/source/basicide/documentenumeration.hxx
@@ -0,0 +1,90 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#pragma once
+
+#include <com/sun/star/frame/XController.hpp>
+#include <memory>
+#include <vector>
+
+namespace com::sun::star::uno { class XComponentContext; }
+
+
+namespace basctl::docs {
+
+
+    typedef std::vector< css::uno::Reference< css::frame::XController > >   Controllers;
+
+    struct DocumentDescriptor
+    {
+        css::uno::Reference< css::frame::XModel >  xModel;
+        Controllers                                aControllers;
+    };
+
+    typedef std::vector< DocumentDescriptor > Documents;
+
+
+    /// allows pre-filtering when enumerating document descriptors
+    class SAL_NO_VTABLE IDocumentDescriptorFilter
+    {
+    public:
+        virtual bool    includeDocument( const DocumentDescriptor& _rDocument ) const = 0;
+
+    protected:
+        ~IDocumentDescriptorFilter() {}
+    };
+
+
+    struct DocumentEnumeration_Data;
+    /** is a helper class for enumerating documents in OOo
+
+        If you need a list of all open documents in OOo, this is little bit of
+        a hassle: You need to iterate though all components at the desktop, which
+        might or might not be documents.
+
+        Additionally, you need to examine the existing documents' frames
+        for sub frames, which might contain sub documents (e.g. embedded objects
+        edited out-place).
+
+        DocumentEnumeration relieves you from this hassle.
+    */
+    class DocumentEnumeration
+    {
+    public:
+        DocumentEnumeration( css::uno::Reference< css::uno::XComponentContext > const & _rContext, const IDocumentDescriptorFilter* _pFilter );
+        ~DocumentEnumeration();
+
+        /** retrieves a list of all currently known documents in the application
+
+            @param _out_rDocuments
+                output parameter taking the collected document information
+            @
+        */
+        void    getDocuments(
+            Documents& _out_rDocuments
+        ) const;
+
+    private:
+        std::unique_ptr< DocumentEnumeration_Data > m_pData;
+    };
+
+
+} // namespace basctl::docs
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */