include/sfx2/hintpost.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SFX2_HINTPOST_HXX
  20 #define INCLUDED_SFX2_HINTPOST_HXX
  21
  22 #include <sfx2/genlink.hxx>
  23 #include <tools/ref.hxx>
  24
  25
  26
  27 class SfxHint;
  28
  29
  30
  31 class SfxHintPoster: public SvRefBase
  32
  33 /*  [Description]
  34
  35     With instances of this class unique events per PostUserEvent can be sent
  36     using the StarView-application. If the User-Event is triggered often,
  37     the handler <Event()> is called, the base implementation with the
  38     <SetEventHdl()> line is making these link calls.
  39
  40     The instance are held via Ref-Count at least as long as a possible sent
  41     event has not arrived yet. Should be killed before the goal, before the
  42     connection is SetEventHdl (GenLink ()) .
  43 */
  44
  45 {
  46     GenLink         aLink;
  47
  48 private:
  49                     DECL_LINK( DoEvent_Impl, SfxHint * );
  50
  51 protected:
  52     virtual         ~SfxHintPoster();
  53     void            Event( SfxHint* pPostedHint );
  54
  55 public:
  56                     SfxHintPoster( const GenLink& rLink );
  57
  58     void            Post( SfxHint* pHint = 0 );
  59     void            SetEventHdl( const GenLink& rLink );
  60 };
  61
  62
  63
  64 typedef tools::SvRef<SfxHintPoster> SfxHintPosterRef;
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */