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 <tools/link.hxx>
  23 #include <tools/ref.hxx>
  24
  25
  26 class SfxRequest;
  27
  28 /**  [Description]
  29
  30     This class allows sending unique events via VCL's
  31     Application::PostUserEvent().  When the User-Event is dispatched,
  32     the handler <Event()> is called, which calls the Link provided with
  33     SetEventHdl().
  34
  35     The instances are held via Ref-Count until a possibly sent
  36     event has arrived.  If the target dies before delivery,
  37     the connection must be severed with SetEventHdl(Link()).
  38 */
  39 class SfxHintPoster : public SvRefBase
  40 {
  41 private:
  42     Link<SfxRequest*,void> m_Link;
  43
  44                     DECL_LINK_TYPED( DoEvent_Impl, void*, void );
  45
  46 protected:
  47     virtual         ~SfxHintPoster();
  48
  49 public:
  50                     SfxHintPoster(const Link<SfxRequest*,void>& rLink);
  51
  52     void            Post( SfxRequest* pHint = nullptr );
  53     void            SetEventHdl(const Link<SfxRequest*,void>& rLink);
  54 };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */