office-gobmx/framework/inc/helper/titlebarupdate.hxx
Noel Grandin 8ef4dc07cd improve loplugin:staticmethods
Some of the exclusions were too aggressive. Restrict them to only the
important classes, which exposes some more places this plugin applies.

Change-Id: I1b2d1fb24391adc71ed0984f94168f61a149479f
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/165154
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-03-22 11:47:36 +01:00

142 lines
5.5 KiB
C++

/* -*- 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/uno/XComponentContext.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/XFrameActionListener.hpp>
#include <com/sun/star/frame/XTitleChangeListener.hpp>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/weakref.hxx>
namespace framework{
/*-************************************************************************************************************
@short helps our frame on setting title/icon on the titlebar (including updates)
@devstatus draft
@threadsafe yes
*//*-*************************************************************************************************************/
class TitleBarUpdate final : public ::cppu::WeakImplHelper<
css::lang::XInitialization
, css::frame::XTitleChangeListener // => XEventListener
, css::frame::XFrameActionListener > // => XEventListener
{
// structs, types
private:
struct TModuleInfo
{
/// internal id of this module
OUString sID;
/// configured icon for this module
::sal_Int32 nIcon;
};
// member
private:
/// may we need a uno service manager to create own services
css::uno::Reference< css::uno::XComponentContext > m_xContext;
/// reference to the frame which was created by the office himself
css::uno::WeakReference< css::frame::XFrame > m_xFrame;
// interface
public:
// ctor/dtor
TitleBarUpdate(css::uno::Reference< css::uno::XComponentContext > xContext);
virtual ~TitleBarUpdate( ) override;
// XInterface, XTypeProvider
// XInitialization
virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments) override;
// XFrameActionListener
virtual void SAL_CALL frameAction(const css::frame::FrameActionEvent& aEvent) override;
// XTitleChangeListener
virtual void SAL_CALL titleChanged(const css::frame::TitleChangedEvent& aEvent) override;
// XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
// helper
private:
/** @short identify the application module, which is used behind the component
of our frame.
@param xFrame
contains the component, which must be identified.
@param rInfo
describe the module in its details.
Is set only if return value is true.
@return [sal_Bool]
sal_True in case module could be identified and all needed values could be read.
sal_False otherwise.
*/
bool implst_getModuleInfo(const css::uno::Reference< css::frame::XFrame >& xFrame,
TModuleInfo& rInfo );
/** @short set a new icon and title on the title bar of our connected frame window.
@descr It does not check if an update is really needed. That has to be done outside.
It retrieves all needed information and update the title bar - nothing less -
nothing more.
*/
void impl_forceUpdate();
/** @short identify the current component (inside the connected frame)
and set the right module icon on the title bar.
@param xFrame
the frame which contains the component and where the icon must be set
on the window title bar.
*/
void impl_updateIcon(const css::uno::Reference< css::frame::XFrame >& xFrame);
/** @short gets the current title from the frame and set it on the window.
@param xFrame
the frame which contains the component and where the title must be set
on the window title bar.
*/
static void impl_updateTitle(const css::uno::Reference< css::frame::XFrame >& xFrame);
//Hook to set GNOME3/Windows 7 applicationID for toplevel frames
//http://msdn.microsoft.com/en-us/library/dd378459(v=VS.85).aspx
//http://live.gnome.org/GnomeShell/ApplicationBased
void impl_updateApplicationID(const css::uno::Reference< css::frame::XFrame >& xFrame);
}; // class TitleBarUpdate
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */