titlehelper.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_TITLEHELPER_HXX
#define INCLUDED_FRAMEWORK_TITLEHELPER_HXX
 
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/frame/XTitle.hpp>
#include <com/sun/star/frame/XTitleChangeBroadcaster.hpp>
#include <com/sun/star/frame/XFrameActionListener.hpp>
#include <com/sun/star/document/XDocumentEventListener.hpp>
 
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/weakref.hxx>
#include <cppuhelper/implbase.hxx>
#include <comphelper/multicontainer2.hxx>
 
#include <rtl/ustrbuf.hxx>
 
#include <framework/fwkdllapi.h>
 
namespace com::sun::star::frame { class XController; }
namespace com::sun::star::frame { class XFrame; }
namespace com::sun::star::frame { class XModel3; }
namespace com::sun::star::frame { class XUntitledNumbers; }
namespace com::sun::star::uno { class XComponentContext; }
namespace com::sun::star::uno { class XInterface; }
 
 
namespace framework{
 
 
class FWK_DLLPUBLIC TitleHelper final : private ::cppu::BaseMutex
                  , public  ::cppu::WeakImplHelper< css::frame::XTitle                 ,
                                                     css::frame::XTitleChangeBroadcaster,
                                                     css::frame::XTitleChangeListener   ,
                                                     css::frame::XFrameActionListener   ,
                                                     css::document::XDocumentEventListener >
{
 
    // interface
    public:
 
 
        TitleHelper(css::uno::Reference< css::uno::XComponentContext > xContext,
            const css::uno::Reference< css::uno::XInterface >& xOwner,
            const css::uno::Reference< css::frame::XUntitledNumbers >& xNumbers);
 
        virtual ~TitleHelper() override;
 
 
        virtual OUString SAL_CALL getTitle() override;
 
 
        virtual void SAL_CALL setTitle(const OUString& sTitle) override;
 
 
        virtual void SAL_CALL addTitleChangeListener(const css::uno::Reference< css::frame::XTitleChangeListener >& xListener) override;
 
 
        virtual void SAL_CALL removeTitleChangeListener(const css::uno::Reference< css::frame::XTitleChangeListener >& xListener) override;
 
 
        virtual void SAL_CALL titleChanged(const css::frame::TitleChangedEvent& aEvent) override;
 
 
        virtual void SAL_CALL documentEventOccured(const css::document::DocumentEvent& aEvent) override;
 
 
        virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
 
 
        virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) override;
 
 
    // internal
    private:
 
        void impl_sendTitleChangedEvent ();
 
        void impl_updateTitle (bool init = false);
        void impl_updateTitleForModel (const css::uno::Reference< css::frame::XModel3 >& xModel, bool init);
        void impl_updateTitleForController (const css::uno::Reference< css::frame::XController >& xController, bool init);
        void impl_updateTitleForFrame (const css::uno::Reference< css::frame::XFrame >& xFrame, bool init);
 
        void impl_startListeningForModel (const css::uno::Reference< css::frame::XModel >& xModel);
        void impl_startListeningForController (const css::uno::Reference< css::frame::XController >& xController);
        void impl_startListeningForFrame (const css::uno::Reference< css::frame::XFrame >& xFrame);
        void impl_updateListeningForFrame (const css::uno::Reference< css::frame::XFrame >& xFrame);
 
        void impl_appendComponentTitle (      OUStringBuffer&                       sTitle    ,
                                        const css::uno::Reference< css::uno::XInterface >& xComponent);
        void impl_appendProductName (OUStringBuffer& sTitle);
        void impl_appendModuleName (OUStringBuffer& sTitle);
        void impl_appendDebugVersion (OUStringBuffer& sTitle);
        void impl_appendSafeMode (OUStringBuffer& sTitle);
 
        void impl_setSubTitle (const css::uno::Reference< css::frame::XTitle >& xSubTitle);
 
        OUString impl_convertURL2Title(std::u16string_view sURL);
 
 
    // member
    private:
 
        css::uno::Reference< css::uno::XComponentContext> m_xContext;
 
        css::uno::WeakReference< css::uno::XInterface > m_xOwner;
 
        css::uno::WeakReference< css::frame::XUntitledNumbers > m_xUntitledNumbers;
 
        css::uno::WeakReference< css::frame::XTitle > m_xSubTitle;
 
        bool m_bExternalTitle;
 
        OUString m_sTitle;
 
        ::sal_Int32 m_nLeasedNumber;
 
        comphelper::OMultiTypeInterfaceContainerHelper2 m_aListener;
};
 
} // namespace framework
 
#endif // INCLUDED_FRAMEWORK_TITLEHELPER_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */