summaryrefslogtreecommitdiff
path: root/framework/source/dispatch/helpagentdispatcher.cxx
blob: d3cc459a366fd04e7ada9b8b78ee2ed4b0c538a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*************************************************************************
 *
 *  $RCSfile: helpagentdispatcher.cxx,v $
 *
 *  $Revision: 1.1 $
 *
 *  last change: $Author: as $ $Date: 2001-07-02 13:27:02 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __FRAMEWORK_DISPATCH_HELPAGENTDISPATCHER_HXX_
#include <dispatch/helpagentdispatcher.hxx>
#endif

#ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
#include <threadhelp/resetableguard.hxx>
#endif

#ifndef _OSL_DIAGNOSE_H_
#include <osl/diagnose.h>
#endif

#ifndef _TOOLKIT_HELPER_VCLUNOHELPER_HXX_
#include <toolkit/helper/vclunohelper.hxx>
#endif

#ifndef _SV_SVAPP_HXX
#include <vcl/svapp.hxx>
#endif

#ifndef _SV_HELP_HXX
#include <vcl/help.hxx>
#endif

#ifndef _COMPHELPER_GUARDING_HXX_
#include <comphelper/guarding.hxx>
#endif

#ifndef INCLUDED_SVTOOLS_HELPOPT_HXX
#include <svtools/helpopt.hxx>
#endif

#ifndef _SV_SVAPP_HXX
#include <vcl/svapp.hxx>
#endif
//........................................................................
namespace framework
{
//........................................................................

    using namespace ::com::sun::star::uno;
    using namespace ::com::sun::star::frame;
    using namespace ::com::sun::star::util;
    using namespace ::com::sun::star::beans;
    using namespace ::com::sun::star::awt;
    using namespace ::com::sun::star::lang;

    //====================================================================
    //= HelpAgentDispatcher
    //====================================================================
    //--------------------------------------------------------------------
    HelpAgentDispatcher::HelpAgentDispatcher( const Reference< XFrame >& _rxParentFrame )
        :ThreadHelpBase(&Application::GetSolarMutex())
        ,m_pContainerWindow(NULL)
        ,m_pAgentWindow(NULL)
        ,m_xParentFrame(_rxParentFrame)
    {
        OSL_ENSURE(m_xParentFrame.is(), "HelpAgentDispatcher::HelpAgentDispatcher: invalid parent frame!");
    }

    //--------------------------------------------------------------------
    HelpAgentDispatcher::~HelpAgentDispatcher()
    {
        osl_incrementInterlockedCount( &m_refCount );
            // we may create new references to ourself below, so ensure the dtor is not called twice ....
        closeAgentWindow();
    }

    //--------------------------------------------------------------------
    sal_Bool HelpAgentDispatcher::ensureContainerWindow()
    {
        if (m_pContainerWindow)
            return sal_True;

        if (!m_xParentFrame.is())
        {
            OSL_ENSURE(sal_False, "HelpAgentDispatcher::ensureContainerWindow: have no explicit container window and no frame to obtain an implicit one!");
            // error condition, already asserted in the ctor
            return sal_False;
        }

        Reference< XWindow > xContainer = m_xParentFrame->getContainerWindow();
        implConstruct(xContainer);

        return (NULL != m_pContainerWindow);
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::implConstruct( const Reference< XWindow >& _rxContainer )
    {
        OSL_ENSURE(!m_pContainerWindow, "HelpAgentDispatcher::implConstruct: not to be called twice!");
        OSL_ENSURE(_rxContainer.is(), "HelpAgentDispatcher::implConstruct: invalid container window given!");

        m_pContainerWindow = VCLUnoHelper::GetWindow(_rxContainer);
        OSL_ENSURE(!_rxContainer.is() || (NULL != m_pContainerWindow), "HelpAgentDispatcher::implConstruct: could not get the implementation of the container!");
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::dispatch( const URL& _rURL, const Sequence< PropertyValue >& _rArgs ) throw (RuntimeException)
    {
        ResetableGuard aGuard(m_aLock);
        switchURL(_rURL);
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::addStatusListener( const Reference< XStatusListener >& _rxListener, const URL& _rURL ) throw (RuntimeException)
    {
        // this is pretty simple: we accept _all_ URLs, and we accept them _always_. So simply notify the listener
        // of the initial "available" state and then do nothing.
        if (_rxListener.is())
        {
            FeatureStateEvent aEvent;
            aEvent.FeatureURL = _rURL;
            aEvent.IsEnabled = sal_True;
            aEvent.Requery = sal_False;
            _rxListener->statusChanged(aEvent);
        }
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::removeStatusListener( const Reference< XStatusListener >& _rxListener, const URL& _rURL ) throw (RuntimeException)
    {
        // nothing to do. see addStatusListener
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::windowResized( const WindowEvent& _rSource ) throw (RuntimeException)
    {
        positionAgentWindow();
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::windowMoved( const WindowEvent& _rSource ) throw (RuntimeException)
    {
        // not interested in
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::windowShown( const EventObject& _rSource ) throw (RuntimeException)
    {
        // not interested in
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::windowHidden( const EventObject& _rSource ) throw (RuntimeException)
    {
        // not interested in
    }

    //--------------------------------------------------------------------
    void SAL_CALL HelpAgentDispatcher::disposing( const EventObject& _rSource ) throw (RuntimeException)
    {
        // not interested in case the container window is closed (this should be handled by our owner)

        // interested in case our agent window is closed (we're the only instance allowed to close it)
        if (m_pAgentWindow)
        {
            Reference< XWindow > xSource(_rSource.Source, UNO_QUERY);
            Reference< XWindow > xAgentWindow = VCLUnoHelper::GetInterface(m_pAgentWindow);
            if (xSource.get() == xAgentWindow.get())
            {   // somebody closed my agent window, but it was not me
                agentClosedExternally();
            }
        }
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::agentClosedExternally()
    {
        ResetableGuard aGuard(m_aLock);
        stopAutoCloseTimer();
        m_pAgentWindow = NULL;
    }

    //--------------------------------------------------------------------
    sal_Bool HelpAgentDispatcher::approveURLRequest(const URL& _rURL)
    {
        SvtHelpOptions aHelpOptions;
        sal_Int32 nAllowedToIgnore = aHelpOptions.getAgentIgnoreURLCounter(_rURL.Complete);
        return nAllowedToIgnore > 0;
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::switchURL(const URL& _rURL)
    {
        if (!approveURLRequest(_rURL))
            // silently drop the request
            return;

        // show our agent window
        ensureAgentWindow();

        // stop the expiration timer for the old URL
        stopAutoCloseTimer();

        // set the URL as tooltip text
        m_sCurrentURL = _rURL.Complete;
        m_pAgentWindow->SetQuickHelpText(m_sCurrentURL);

        // start the expiration timer for the new URL
        startAutoCloseTimer();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::stopAutoCloseTimer()
    {
        if (!m_xAutoCloseTimer.isValid())
            return;

        m_xAutoCloseTimer->stop();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::startAutoCloseTimer()
    {
        ::vos::TTimeValue aAutoCloseTimeout( SvtHelpOptions().GetHelpAgentTimeoutPeriod(), 0 );
        if (!m_xAutoCloseTimer.isValid())
        {

            m_xAutoCloseTimer = new OTimerHelper(aAutoCloseTimeout);
            m_xAutoCloseTimer->setListener(this);
        }

        m_xAutoCloseTimer->setRemainingTime(aAutoCloseTimeout);
        m_xAutoCloseTimer->start();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::helpRequested()
    {
        ResetableGuard aGuard(m_aLock);

        // FIRST stop the timer
        stopAutoCloseTimer();

        // reset the ignore counter for this URL
        SvtHelpOptions().resetAgentIgnoreURLCounter(m_sCurrentURL);

        Help* pApplicationHelp = Application::GetHelp();
        OSL_ENSURE(pApplicationHelp, "HelpAgentDispatcher::helpRequested: no help system available!");
        if (pApplicationHelp)
            pApplicationHelp->Start( m_sCurrentURL, NULL );

        aGuard.unlock();
        closeAgentWindow();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::closeAgent()
    {
        closeAgentWindow();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::timerExpired()
    {
        // the hint has been ignored by the user
        markURLIgnored(m_sCurrentURL);
        // close the window
        closeAgentWindow();
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::markURLIgnored( const ::rtl::OUString& _rURL )
    {
        SvtHelpOptions().decAgentIgnoreURLCounter(_rURL);
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::closeAgentWindow()
    {
        // now acquire the SolarMutex ...
        ::vos::OGuard aSolarGuard(Application::GetSolarMutex());
        // ... and our own mutex
        ResetableGuard aGuard(m_aLock);

        stopAutoCloseTimer();

        if (!m_pAgentWindow)
            return;

        if (m_pContainerWindow)
        {
            Reference< XWindow > xContainer = VCLUnoHelper::GetInterface(m_pContainerWindow);
            OSL_ENSURE(xContainer.is(), "HelpAgentDispatcher::closeAgentWindow: no UNO interface for the container window!");
            if (xContainer.is())
                xContainer->removeWindowListener(this);
        }

        if (m_pAgentWindow)
        {
            Reference< XWindow > xAgentWindow = VCLUnoHelper::GetInterface(m_pAgentWindow);
            OSL_ENSURE(xAgentWindow.is(), "HelpAgentDispatcher::closeAgentWindow: no UNO interface for the agent window!");
            if (xAgentWindow.is())
                xAgentWindow->removeWindowListener(this);
        }

        delete m_pAgentWindow;
        m_pAgentWindow = NULL;
    }

    //--------------------------------------------------------------------
    void HelpAgentDispatcher::positionAgentWindow()
    {
        OSL_ENSURE(m_pContainerWindow, "HelpAgentDispatcher::positionAgentWindow: please use ensureContainerWindow!");
        OSL_ENSURE(m_pAgentWindow, "HelpAgentDispatcher::positionAgentWindow: to be called with an existing agent window only!");
        OSL_ENSURE(m_pAgentWindow->GetParent() == m_pContainerWindow, "HelpAgentDispatcher::positionAgentWindow: invalid window hierarchy!");

        const Size aContainerSize = m_pContainerWindow->GetSizePixel();
        const Size aAgentSize = m_pAgentWindow->getPreferredSizePixel();

        const Point aAgentPos   ( aContainerSize.Width() - aAgentSize.Width()
                                , aContainerSize.Height() - aAgentSize.Height() );

        // TODO: use a surrogate if the container window is too small to contain the full-sized agent window

        m_pAgentWindow->SetPosSizePixel(aAgentPos, aAgentSize);
    }

    //--------------------------------------------------------------------
    sal_Bool HelpAgentDispatcher::ensureAgentWindow()
    {
        if (m_pAgentWindow)
            return sal_True;

        ::vos::OGuard aSolarGuard(Application::GetSolarMutex());
        if (!ensureContainerWindow())
            return sal_False;

        // create it
        m_pAgentWindow = new ::svt::HelpAgentWindow(m_pContainerWindow);
        m_pAgentWindow->setCallback(this);

        // add as listener at the agent window in case it is closed by the user (and not by us ourself)
        Reference< XWindow > xAgentWindow = VCLUnoHelper::GetInterface(m_pAgentWindow);
        OSL_ENSURE(xAgentWindow.is(), "HelpAgentDispatcher::ensureAgentWindow: no UNO interface for the agent window!");
        if (xAgentWindow.is())
            xAgentWindow->addWindowListener(this);

        // add as window listener to the container window so we can maintain the property position of the agent window
        Reference< XWindow > xContainer = VCLUnoHelper::GetInterface(m_pContainerWindow);
        OSL_ENSURE(xContainer.is(), "HelpAgentDispatcher::ensureAgentWindow: no container window interface!");
        if (xContainer.is())
            xContainer->addWindowListener(this);

        // position it
        positionAgentWindow();

        // show it
        if (m_pContainerWindow->IsVisible())
            m_pAgentWindow->Show();

        return sal_True;
    }

//........................................................................
}   // namespace framework
//........................................................................

/*************************************************************************
 * history:
 *  $Log: not supported by cvs2svn $
 *  Revision 1.3  2001/06/11 10:27:57  as
 *  #85529# use new lock mechanism
 *
 *  Revision 1.2  2001/05/07 15:07:20  fs
 *  moved the HelpAgentWindow implementation to SVTOOLS (prevent creating a new resource file here)
 *
 *  Revision 1.1  2001/05/07 13:42:24  fs
 *  initial checkin - help agent dispatcher
 *
 *
 *  Revision 1.0 03.05.01 11:28:01  fs
 ************************************************************************/