office-gobmx/framework/inc/jobs/helponstartup.hxx
Noel Grandin bb121c864c fdo#46808, Convert frame::Desktop to new style service.
I had to drop XEventBroadcaster from the merged interface
because it introduced method name conflicts (addEventListener).

Shouldn't be an issue since it was scheduled to be dropped anyhow,
and the service implementation still implements it, so existing clients
will be fine.

I dropped the interface XPropertySet from the combined IDL because nobody
seems to be using it, and it's primary purpose appears to be to set weird
flags.

I dropped the optional interfaces
   XStatusIndicatorFactory
   XDispatchInformationProvider
from the combined IDL because the service does not implement them, and
nobody seems to be using them. I suspect they were mistakenly copied
from XFrame.

I also did not convert the Title, UserDefinedAttributes and LayoutManager
properties to attributes, again because no-one is using them.

Change-Id: I678a00006ed2cca2d6c37c4e39465811442c33af
2012-12-21 10:57:09 +02:00

215 lines
8.4 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 .
*/
#ifndef __FRAMEWORK_JOBS_HELPONSTARTUP_HXX_
#define __FRAMEWORK_JOBS_HELPONSTARTUP_HXX_
#include <threadhelp/threadhelpbase.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <macros/xserviceinfo.hxx>
#include <cppuhelper/implbase3.hxx>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/task/XJob.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/frame/XDesktop2.hpp>
#include <com/sun/star/frame/XModuleManager2.hpp>
namespace framework{
//_______________________________________________
/** @short implements a job component, which handle the special
feature to show a suitable help page for every (visible!)
loaded document.
@author as96863
*/
class HelpOnStartup : private ThreadHelpBase
,public ::cppu::WeakImplHelper3< ::com::sun::star::lang::XServiceInfo,::com::sun::star::lang::XEventListener,::com::sun::star::task::XJob >
{
//-------------------------------------------
// member
private:
//.......................................
/** @short reference to an uno service manager. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
//.......................................
/** @short such module manager is used to classify new opened documents. */
css::uno::Reference< css::frame::XModuleManager2 > m_xModuleManager;
//.......................................
/** @short is needed to locate a might open help frame. */
css::uno::Reference< css::frame::XDesktop2 > m_xDesktop;
//.......................................
/** @short provides read access to the underlying configuration. */
css::uno::Reference< css::container::XNameAccess > m_xConfig;
//.......................................
/** @short knows the current locale of this office session,
which is needed to build complete help URLs.
*/
::rtl::OUString m_sLocale;
//.......................................
/** @short knows the current operating system of this office session,
which is needed to build complete help URLs.
*/
::rtl::OUString m_sSystem;
//-------------------------------------------
// native interface
public:
//---------------------------------------
/** @short create new instance of this class.
@param xContext
reference to the uno service manager, which created this instance.
Can be used later to create own needed uno resources on demand.
*/
HelpOnStartup(const css::uno::Reference< css::uno::XComponentContext >& xContext);
//---------------------------------------
/** @short does nothing real ...
@descr But it should exists as virtual function,
so this class cant make trouble
related to inline/symbols etcpp.!
*/
virtual ~HelpOnStartup();
//-------------------------------------------
// uno interface
public:
//---------------------------------------
// css.lang.XServiceInfo
DECLARE_XSERVICEINFO
// css.task.XJob
virtual css::uno::Any SAL_CALL execute(const css::uno::Sequence< css::beans::NamedValue >& lArguments)
throw(css::lang::IllegalArgumentException,
css::uno::Exception ,
css::uno::RuntimeException );
// css.lang.XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
throw(css::uno::RuntimeException);
//-------------------------------------------
// helper
private:
//---------------------------------------
/** @short analyze the given job arguments, try to locate a model reference
and try to classify this model.
@descr As a result of this operation a module identifier will be returned.
It can be used against the module configuration then to retrieve further informations.
@param lArguments
the list of job arguments which is given on our interface method execute().
@return [string]
a module identifier ... or an empty value if no model could be located ...
or if it could not be classified successfully.
*/
::rtl::OUString its_getModuleIdFromEnv(const css::uno::Sequence< css::beans::NamedValue >& lArguments);
//---------------------------------------
/** @short tries to locate the open help module and return
the url of the currently shown help content.
@descr It returns an empty string, if the help isnt still
open at calling time.
@return The URL of the current shown help content;
or an empty value if the help isnt still open.
*/
::rtl::OUString its_getCurrentHelpURL();
//---------------------------------------
/** @short checks if the given help url match to a default help url
of any office module.
@param sHelpURL
the help url for checking.
@return [bool]
sal_True if the given URL is any default one ...
sal_False otherwise.
*/
::sal_Bool its_isHelpUrlADefaultOne(const ::rtl::OUString& sHelpURL);
//---------------------------------------
/** @short checks, if the help module should be shown automaticly for the
currently opened office module.
@descr This value is readed from the module configuration.
In case the help should be shown, this method returns
a help URL, which can be used to show the right help content.
@param sModule
identifies the used office module.
@return [string]
A valid help URL in case the help content should be shown;
an empty value if such automatism was disabled for the specified office module.
*/
::rtl::OUString its_checkIfHelpEnabledAndGetURL(const ::rtl::OUString& sModule);
//---------------------------------------
/** @short create a help URL for the given parameters.
@param sBaseURL
must be the base URL for a requested help content
e.g. "vnd.sun.star.help://swriter/"
or "vnd.sun.star.help://swriter/67351"
@param sLocale
the current office locale
e.g. "en-US"
@param sSystem
the current operating system
e.g. "WIN"
@return The URL which was generated.
e.g.
e.g. "vnd.sun.star.help://swriter/?Language=en-US&System=WIN"
or "vnd.sun.star.help://swriter/67351?Language=en-US&System=WIN"
*/
static ::rtl::OUString ist_createHelpURL(const ::rtl::OUString& sBaseURL,
const ::rtl::OUString& sLocale ,
const ::rtl::OUString& sSystem );
};
} // namespace framework
#endif // __FRAMEWORK_JOBS_HELPONSTARTUP_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */