framelistanalyzer.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 .
 */
 
#ifndef INCLUDED_FRAMEWORK_FRAMELISTANALYZER_HXX
#define INCLUDED_FRAMEWORK_FRAMELISTANALYZER_HXX
 
#include <config_options.h>
#include <framework/fwkdllapi.h>
#include <o3tl/typed_flags_set.hxx>
#include <com/sun/star/uno/Reference.hxx>
 
#include <vector>
 
namespace com::sun::star::frame { class XFrame; }
namespace com::sun::star::frame { class XFramesSupplier; }
 
enum class FrameAnalyzerFlags
{
    Model             =     1,
    Help              =     2,
    BackingComponent  =     4,
    Hidden            =     8,
    All               =    15,
    Zombie            = 32768 // use it for special test scenarios only!!!
};
namespace o3tl {
    template<> struct typed_flags<FrameAnalyzerFlags> : is_typed_flags<FrameAnalyzerFlags, 32768+15> {};
}
 
 
namespace framework{
 
class UNLESS_MERGELIBS(FWK_DLLPUBLIC) FrameListAnalyzer final
{
 
    // types
 
    public:
 
    // member
 
    public:
 
        const css::uno::Reference< css::frame::XFramesSupplier >& m_xSupplier;
 
        const css::uno::Reference< css::frame::XFrame >& m_xReferenceFrame;
 
        FrameAnalyzerFlags m_eDetectMode;
 
        std::vector< css::uno::Reference< css::frame::XFrame > > m_lModelFrames;
 
        std::vector< css::uno::Reference< css::frame::XFrame > > m_lOtherVisibleFrames;
 
        std::vector< css::uno::Reference< css::frame::XFrame > > m_lOtherHiddenFrames;
 
        css::uno::Reference< css::frame::XFrame > m_xHelp;
 
        css::uno::Reference< css::frame::XFrame > m_xBackingComponent;
 
        bool m_bReferenceIsHidden;
 
        bool m_bReferenceIsHelp;
 
        bool m_bReferenceIsBacking;
 
 
    // interface
 
    public:
 
                 FrameListAnalyzer( const css::uno::Reference< css::frame::XFramesSupplier >& xSupplier       ,
                                    const css::uno::Reference< css::frame::XFrame >&          xReferenceFrame ,
                                          FrameAnalyzerFlags                                  eDetectMode     );
                 ~FrameListAnalyzer();
 
 
    // helper
 
    private:
 
            void impl_analyze();
 
 
}; // class FrameListAnalyzer
 
} // namespace framework
 
#endif // INCLUDED_FRAMEWORK_FRAMELISTANALYZER_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */