basctl/source/basicide/documentenumeration.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 #pragma once
  21
  22 #include <com/sun/star/frame/XController.hpp>
  23 #include <memory>
  24 #include <vector>
  25
  26 namespace com::sun::star::uno { class XComponentContext; }
  27
  28
  29 namespace basctl::docs {
  30
  31
  32     typedef std::vector< css::uno::Reference< css::frame::XController > >   Controllers;
  33
  34     struct DocumentDescriptor
  35     {
  36         css::uno::Reference< css::frame::XModel >  xModel;
  37         Controllers                                aControllers;
  38     };
  39
  40     typedef std::vector< DocumentDescriptor > Documents;
  41
  42
  43     /// allows pre-filtering when enumerating document descriptors
  44     class SAL_NO_VTABLE IDocumentDescriptorFilter
  45     {
  46     public:
  47         virtual bool    includeDocument( const DocumentDescriptor& _rDocument ) const = 0;
  48
  49     protected:
  50         ~IDocumentDescriptorFilter() {}
  51     };
  52
  53
  54     /** is a helper class for enumerating documents in OOo
  55
  56         If you need a list of all open documents in OOo, this is little bit of
  57         a hassle: You need to iterate though all components at the desktop, which
  58         might or might not be documents.
  59
  60         Additionally, you need to examine the existing documents' frames
  61         for sub frames, which might contain sub documents (e.g. embedded objects
  62         edited out-place).
  63
  64         DocumentEnumeration relieves you from this hassle.
  65     */
  66     class DocumentEnumeration
  67     {
  68     public:
  69         DocumentEnumeration( css::uno::Reference< css::uno::XComponentContext > const & _rContext, const IDocumentDescriptorFilter* _pFilter );
  70         ~DocumentEnumeration();
  71
  72         /** retrieves a list of all currently known documents in the application
  73
  74             @param _out_rDocuments
  75                 output parameter taking the collected document information
  76             @
  77         */
  78         void    getDocuments(
  79             Documents& _out_rDocuments
  80         ) const;
  81
  82     private:
  83         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  84         const IDocumentDescriptorFilter* m_pFilter;
  85     };
  86
  87
  88 } // namespace basctl::docs
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */