binfilter/inc/bf_sfx2/hintpost.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hintpost.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SFXHINTPOST_HXX
  31 #define _SFXHINTPOST_HXX
  32
  33 #ifndef _SFXGENLINK_HXX
  34 #include <bf_sfx2/genlink.hxx>
  35 #endif
  36
  37 #ifndef _REF_HXX //autogen
  38 #include <tools/ref.hxx>
  39 #endif
  40 namespace binfilter {
  41
  42 class SfxHint;
  43
  44 //===================================================================
  45
  46
  47 //-------------------------------------------------------------------
  48
  49 class SfxHintPoster: public SvRefBase
  50
  51 /*      [Beschreibung]
  52
  53     Mit Instanzen dieser Klasse k"onnen eindeutige Events per PostUserEvent
  54     "uber die StarView-Application verschickt werden. Wenn das User-Event
  55     ausgel"ost wird, wird der Handler <Event()> gerufen, dessen
  56     Basisimplementierung den mit <SetEventHdl()> angegbenen Link ruft.
  57
  58     Die Instanz wird via Ref-Count mindestens solange gehalten, wie
  59     ein ggf. abgeschicktes Event noch nicht angekommen ist. Sollte das
  60     Ziel vorher sterben, ist die Verbindung zuvor mit 'SetEventHdl(GenLink())'
  61     zu kappen.
  62 */
  63
  64 {
  65     ULONG                       nId;
  66     GenLink             aLink;
  67
  68 private:
  69 #if _SOLAR__PRIVATE
  70                     DECL_LINK( DoEvent_Impl, SfxHint * );
  71 #endif
  72
  73 protected:
  74     virtual         ~SfxHintPoster();
  75     virtual void        Event( SfxHint* pPostedHint );
  76 };
  77
  78 //-------------------------------------------------------------------
  79
  80 SV_DECL_IMPL_REF(SfxHintPoster);
  81
  82 }//end of namespace binfilter
  83 #endif