documentenumeration.hxx

Go to the documentation of this file.

/* -*- 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;
 
 
    class SAL_NO_VTABLE IDocumentDescriptorFilter
    {
    public:
        virtual bool    includeDocument( const DocumentDescriptor& _rDocument ) const = 0;
 
    protected:
        ~IDocumentDescriptorFilter() {}
    };
 
 
    class DocumentEnumeration
    {
    public:
        DocumentEnumeration( css::uno::Reference< css::uno::XComponentContext > const & _rContext, const IDocumentDescriptorFilter* _pFilter );
        ~DocumentEnumeration();
 
        void    getDocuments(
            Documents& _out_rDocuments
        ) const;
 
    private:
        css::uno::Reference< css::uno::XComponentContext > m_xContext;
        const IDocumentDescriptorFilter* m_pFilter;
    };
 
 
} // namespace basctl::docs
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */