/usr/include/libreoffice/registry/writer.h is in libreoffice-dev 1:3.5.2-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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 INCLUDED_registry_writer_h
#define INCLUDED_registry_writer_h
#include "registry/types.h"
#include "registry/version.h"
#include "rtl/ustring.h"
#include "sal/types.h"
#ifdef __cplusplus
extern "C" {
#endif
/// @HTML
/**
Creates a type writer working on a binary blob that represents a UNOIDL type.
<p>Operations on a returned handle are not multi-thread–safe.</p>
@param version the version of the created type writer; must not be negative
@param documentation the documentation; must not be null
@param fileName the file name; must not be null (deprecated, use an empty string)
@param typeClass the type class of the created type writer
@param published whether the created type writer is published; for a type
class that cannot be published, this should be false
@param typeName the type name of the created type writer; must not be null
@param superTypeCount the number of super types of the created type writer
@param fieldCount the number of fields of the created type writer
@param methodCount the number of methods of the created type writer
@param referenceCount the number of references of the created type writer
@return a handle on the type writer; if an out-of-memory condition occurs,
null is returned, and no type writer is created
@since UDK 3.2.0
*/
void * SAL_CALL typereg_writer_create(
typereg_Version version, rtl_uString const * documentation,
rtl_uString const * fileName, RTTypeClass typeClass, sal_Bool published,
rtl_uString const * typeName, sal_uInt16 superTypeCount,
sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
SAL_THROW_EXTERN_C();
/**
Destroys a type writer.
@param handle a handle on a type writer obtained from a call to
<code>typereg_writer_create</code>; must not be null
@since UDK 3.2.0
*/
void SAL_CALL typereg_writer_destroy(void * handle) SAL_THROW_EXTERN_C();
/**
Sets the type name of a super type of a type writer.
@param handle a handle on a type writer; must not be null
@param index a valid index into the range of super types of the given type
writer
@param typeName the super type name; must not be null
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setSuperTypeName(
void * handle, sal_uInt16 index, rtl_uString const * typeName)
SAL_THROW_EXTERN_C();
/**
Sets the data of a field of a type writer.
@param handle a handle on a type writer; must not be null
@param index a valid index into the range of fields of the given type writer
@param documentation the documentation of the field; must not be null
@param fileName the file name of the field; must not be null (deprecated, use an empty string)
@param flags the flags of the field
@param name the name of the field; must not be null
@param typeName the type name of the field; must not be null
@param valueType the type of the value of the field
@param valueValue the value of the value of the field
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setFieldData(
void * handle, sal_uInt16 index, rtl_uString const * documentation,
rtl_uString const * fileName, RTFieldAccess flags, rtl_uString const * name,
rtl_uString const * typeName, RTValueType valueType,
RTConstValueUnion valueValue)
SAL_THROW_EXTERN_C();
/**
Sets the data of a method of a type writer.
@param handle a handle on a type writer; must not be null
@param index a valid index into the range of methods of the given type writer
@param documentation the documentation of the method; must not be null
@param flags the flags of the method
@param name the name of the method; must not be null
@param returnTypeName the return type name of the method; must not be null
@param parameterCount the number of parameters of the method
@param exceptionCount the number of exceptions of the method
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setMethodData(
void * handle, sal_uInt16 index, rtl_uString const * documentation,
RTMethodMode flags, rtl_uString const * name,
rtl_uString const * returnTypeName, sal_uInt16 parameterCount,
sal_uInt16 exceptionCount)
SAL_THROW_EXTERN_C();
/**
Sets the data of a parameter of a method of a type writer.
@param handle a handle on a type writer; must not be null
@param methodIndex a valid index into the range of methods of the given type
writer
@param parameterIndex a valid index into the range of parameters of the given
method
@param flags the flags of the parameter
@param name the name of the parameter; must not be null
@param typeName the type name of the parameter; must not be null
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setMethodParameterData(
void * handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex,
RTParamMode flags, rtl_uString const * name, rtl_uString const * typeName)
SAL_THROW_EXTERN_C();
/**
Sets an exception type name of a method of a type writer.
@param handle a handle on a type writer; must not be null
@param methodIndex a valid index into the range of methods of the given type
writer
@param exceptionIndex a valid index into the range of exceptions of the given
method
@param typeName the exception type name; must not be null
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setMethodExceptionTypeName(
void * handle, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex,
rtl_uString const * typeName)
SAL_THROW_EXTERN_C();
/**
Sets the data of a reference of a type writer.
@param handle a handle on a type writer; must not be null
@param index a valid index into the range of references of the given type
writer
@param documentation the documentation of the reference; must not be null
@param sort the sort of the reference
@param flags the flags of the reference
@param typeName the type name of the reference; must not be null
@return false iff an out-of-memory condition ocurred, in which case the type
writer is not modified
@since UDK 3.2.0
*/
sal_Bool SAL_CALL typereg_writer_setReferenceData(
void * handle, sal_uInt16 index, rtl_uString const * documentation,
RTReferenceType sort, RTFieldAccess flags, rtl_uString const * typeName)
SAL_THROW_EXTERN_C();
/**
Returns the blob of a type writer.
@param handle a handle on a type writer; must not be null
@param size an out-parameter obtaining the size of the blob; must not be null
@return a (byte-aligned) pointer to the blob; the returned pointer and the
returned <code>size</code> remain valid until the next function is called on
the given type writer; if an out-of-memory condition occurs, null is returned
and <code>size</code> is not modified
*/
void const * SAL_CALL typereg_writer_getBlob(void * handle, sal_uInt32 * size)
SAL_THROW_EXTERN_C();
#ifdef __cplusplus
}
#endif
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|