autodoc/inc/ary/ary_disp.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: ary_disp.hxx,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef ARY_ARY_DISP_HXX
  32 #define ARY_ARY_DISP_HXX
  33 //  KORR_DEPRECATED_3.0
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <cosv/tpl/processor.hxx>
  39     // COMPONENTS
  40     // PARAMETERS
  41 #include <ary/types.hxx>
  42 #include <ary/cpp/c_types4cpp.hxx>
  43
  44 namespace ary
  45 {
  46 namespace cpp
  47 {
  48     class Gate;
  49 }
  50
  51 class Display : public csv::ProcessorIfc
  52 {
  53   public:
  54     virtual                     ~Display() {}
  55
  56     // OPERATIONS
  57     void                StartSlot();
  58     void                FinishSlot();
  59
  60     /** This method depends on the result of Get_ReFinder().
  61         If Get_ReFinder() != 0, then DisplayGate::Find_Re() is called
  62         and if valid, cpp::CppEntity::Accept( *this ) is called.
  63         If Get_ReFinder() == 0, simply do_DisplaySlot_Rid() is called
  64         with just the id as parameter.
  65     */
  66     void                DisplaySlot_Rid(
  67                             ary::Rid            i_nId );
  68 //    void                DisplaySlot_Lid(
  69 //                                                      ary::Lid            i_nId );
  70     /** This method depends on the result of Get_ReFinder().
  71         If Get_ReFinder() != 0, then DisplayGate::Find_Re() is called
  72         and if valid, cpp::CppEntity::Accept( *this ) is called.
  73         If Get_ReFinder() == 0, simply do_DisplaySlot_LocalCe() is called
  74         with just the id as parameter.
  75     */
  76     void                DisplaySlot_LocalCe(
  77                             ary::cpp::Ce_id     i_nId,
  78                             const String  &             i_sName );
  79     // INQUIRY
  80     const cpp::Gate *   Get_ReFinder() const;
  81
  82   private:
  83     virtual void        do_StartSlot();
  84     virtual void        do_FinishSlot();
  85
  86
  87     virtual void        do_DisplaySlot_Rid(
  88                             ary::Rid            i_nId );
  89     virtual void        do_DisplaySlot_LocalCe(
  90                             ary::cpp::Ce_id     i_nId,
  91                             const String  &             i_sName );
  92     virtual const cpp::Gate *
  93                         inq_Get_ReFinder() const = 0;
  94 };
  95
  96
  97 // IMPLEMENTATION
  98
  99
 100 inline void
 101 Display::StartSlot()
 102     { do_StartSlot(); }
 103 inline void
 104 Display::FinishSlot()
 105     { do_FinishSlot(); }
 106 inline const cpp::Gate *
 107 Display::Get_ReFinder() const
 108     { return inq_Get_ReFinder(); }
 109
 110
 111
 112
 113 } // namespace ary
 114 #endif