autodoc/inc/ary/ary.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
  20 #ifndef ARY_ARY_HXX
  21 #define ARY_ARY_HXX
  22
  23
  24 // USED SERVICES
  25     // BASE CLASSES
  26     // OTHER
  27
  28 namespace ary
  29 {
  30 namespace idl
  31 {
  32     class Gate;
  33 }
  34 }
  35
  36
  37
  38 namespace ary
  39 {
  40
  41 /** Starting point for all work with the
  42     Autodoc Sourcecode Repository.
  43
  44     Create and destroy the repository and
  45     give access to the "Gates" for different tasks.
  46
  47     @collab ::ary::idl::Gate
  48 */
  49
  50 class Repository
  51 {
  52   public:
  53     //  LIFECYCLE
  54     virtual             ~Repository() {}
  55     static DYN Repository &
  56                         Create_();
  57     // INQUIRY
  58     virtual const String &
  59                         Title() const = 0;
  60     virtual const ::ary::idl::Gate &
  61                         Gate_Idl() const = 0;
  62     // ACCESS
  63     virtual ::ary::idl::Gate &
  64                         Gate_Idl() = 0;
  65     virtual void        Set_Title(
  66                             const String &      i_sName ) = 0;
  67 };
  68
  69
  70
  71 } // namespace ary
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */