summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/logging/XSimpleLogRing.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/logging/XSimpleLogRing.idl')
-rw-r--r--offapi/com/sun/star/logging/XSimpleLogRing.idl74
1 files changed, 74 insertions, 0 deletions
diff --git a/offapi/com/sun/star/logging/XSimpleLogRing.idl b/offapi/com/sun/star/logging/XSimpleLogRing.idl
new file mode 100644
index 000000000000..a0a8d1f0483c
--- /dev/null
+++ b/offapi/com/sun/star/logging/XSimpleLogRing.idl
@@ -0,0 +1,74 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_logging_XSimpleLogRing_idl__
+#define __com_sun_star_logging_XSimpleLogRing_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module logging {
+
+//=============================================================================
+
+/** a simple log ring allowing to collect a limited number of last events
+
+ <p>
+ The intention of this interface is to provide a simple possibility
+ for developer to collect the most important events without affecting
+ the performance. For this reasons the messages related API is quite
+ simple, the strings should be produced by the preprocessor mainly.
+ </p>
+
+ @since OOo 3.2
+ */
+interface XSimpleLogRing
+{
+ /** allows to add a message to the logger
+ */
+ void logString( [in] string aMessage );
+
+ /** allows to get the collected messages from the logger
+
+ <p>
+ It is up to logger implementation to provide only the limited
+ number of last messages.
+ </p>
+ */
+ sequence< string > getCollectedLog();
+};
+
+//=============================================================================
+
+}; }; }; };
+
+//=============================================================================
+
+#endif