autodoc/inc/ary/ary_disp.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef ARY_ARY_DISP_HXX
  29 #define ARY_ARY_DISP_HXX
  30 //  KORR_DEPRECATED_3.0
  31
  32
  33 // USED SERVICES
  34     // BASE CLASSES
  35 #include <cosv/tpl/processor.hxx>
  36     // COMPONENTS
  37     // PARAMETERS
  38 #include <ary/types.hxx>
  39 #include <ary/cpp/c_types4cpp.hxx>
  40
  41 namespace ary
  42 {
  43 namespace cpp
  44 {
  45     class Gate;
  46 }
  47
  48 class Display : public csv::ProcessorIfc
  49 {
  50   public:
  51     virtual             ~Display() {}
  52
  53     // OPERATIONS
  54     void                StartSlot();
  55     void                FinishSlot();
  56
  57     /** This method depends on the result of Get_ReFinder().
  58         If Get_ReFinder() != 0, then DisplayGate::Find_Re() is called
  59         and if valid, cpp::CppEntity::Accept( *this ) is called.
  60         If Get_ReFinder() == 0, simply do_DisplaySlot_Rid() is called
  61         with just the id as parameter.
  62     */
  63     void                DisplaySlot_Rid(
  64                             ary::Rid            i_nId );
  65 //    void                DisplaySlot_Lid(
  66 //                          ary::Lid            i_nId );
  67     /** This method depends on the result of Get_ReFinder().
  68         If Get_ReFinder() != 0, then DisplayGate::Find_Re() is called
  69         and if valid, cpp::CppEntity::Accept( *this ) is called.
  70         If Get_ReFinder() == 0, simply do_DisplaySlot_LocalCe() is called
  71         with just the id as parameter.
  72     */
  73     void                DisplaySlot_LocalCe(
  74                             ary::cpp::Ce_id     i_nId,
  75                             const String  &     i_sName );
  76     // INQUIRY
  77     const cpp::Gate *   Get_ReFinder() const;
  78
  79   private:
  80     virtual void        do_StartSlot();
  81     virtual void        do_FinishSlot();
  82
  83
  84     virtual void        do_DisplaySlot_Rid(
  85                             ary::Rid            i_nId );
  86     virtual void        do_DisplaySlot_LocalCe(
  87                             ary::cpp::Ce_id     i_nId,
  88                             const String  &     i_sName );
  89     virtual const cpp::Gate *
  90                         inq_Get_ReFinder() const = 0;
  91 };
  92
  93
  94 // IMPLEMENTATION
  95
  96
  97 inline void
  98 Display::StartSlot()
  99     { do_StartSlot(); }
 100 inline void
 101 Display::FinishSlot()
 102     { do_FinishSlot(); }
 103 inline const cpp::Gate *
 104 Display::Get_ReFinder() const
 105     { return inq_Get_ReFinder(); }
 106
 107
 108
 109
 110 } // namespace ary
 111 #endif