offapi/com/sun/star/logging/XSimpleLogRing.idl

   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 __com_sun_star_logging_XSimpleLogRing_idl__
  21 #define __com_sun_star_logging_XSimpleLogRing_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com { module sun { module star { module logging {
  27
  28
  29 /** a simple log ring allowing to collect a limited number of last events
  30
  31     <p>
  32     The intention of this interface is to provide a simple possibility
  33     for developer to collect the most important events without affecting
  34     the performance. For this reasons the messages related API is quite
  35     simple, the strings should be produced by the preprocessor mainly.
  36     </p>
  37
  38     @since OOo 3.2
  39  */
  40 interface XSimpleLogRing
  41 {
  42     /** allows to add a message to the logger
  43      */
  44     void logString( [in] string aMessage );
  45
  46     /** allows to get the collected messages from the logger
  47
  48         <p>
  49         It is up to logger implementation to provide only the limited
  50         number of last messages.
  51         </p>
  52      */
  53     sequence< string > getCollectedLog();
  54 };
  55
  56
  57 }; }; }; };
  58
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */