registry/source/reflwrit.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 INCLUDED_REGISTRY_SOURCE_REFLWRIT_HXX
  21 #define INCLUDED_REGISTRY_SOURCE_REFLWRIT_HXX
  22
  23 #include <registry/types.hxx>
  24 #include <rtl/ustring.hxx>
  25
  26 class RTConstValue;
  27
  28 /// Implementation handle
  29 typedef void* TypeWriterImpl;
  30
  31 /** RegistryTypeWriter writes/creates a binary type blob.
  32
  33     This class provides the necessary functions to write type information
  34     for all kinds of types into a blob.
  35
  36     @deprecated
  37     use typereg::Writer instead
  38 */
  39 class RegistryTypeWriter
  40 {
  41 public:
  42
  43     /** Constructor.
  44
  45         @param RTTypeClass specifies the type of the new blob.
  46         @param typeName specifies the full qualified type name with '/' as separator.
  47         @param superTypeName specifies the full qualified type name of the base type
  48                              with '/' as separator.
  49         @param fieldCount specifies the number of fields (eg. number of attributes/properties,
  50                           enum values or constants).
  51      */
  52     RegistryTypeWriter(RTTypeClass               RTTypeClass,
  53                               const OUString&    typeName,
  54                               const OUString&    superTypeName,
  55                               sal_uInt16                fieldCount);
  56
  57     /** Destructor. The Destructor frees the internal data block.
  58
  59         The pointer (returned by getBlop) will be set to NULL.
  60      */
  61     ~RegistryTypeWriter();
  62
  63     /** sets the data for a field member of a type blob.
  64
  65         @param index indicates the index of the field.
  66         @param name specifies the name.
  67         @param typeName specifies the full qualified typename.
  68         @param doku specifies the documentation string of the field.
  69         @param fileName specifies the name of the IDL file where the field is defined.
  70         @param access specifies the access mode of the field.
  71         @param constValue specifies the value of the field. The value is only interesting
  72                           for enum values or constants.
  73      */
  74     void setFieldData( sal_uInt16              index,
  75                               const OUString&    name,
  76                               const OUString&    typeName,
  77                               const OUString&    doku,
  78                               const OUString&    fileName,
  79                               RTFieldAccess           access,
  80                               const RTConstValue&     constValue);
  81
  82     /** returns a pointer to the new type blob.
  83
  84         The pointer will be invalid (NULL) if the instance of
  85         the RegistryTypeWriter will be destroyed.
  86      */
  87     const sal_uInt8*     getBlop();
  88
  89     /** returns the size of the new type blob in bytes.
  90      */
  91     sal_uInt32       getBlopSize();
  92
  93 private:
  94     RegistryTypeWriter(RegistryTypeWriter const &) = delete;
  95     void operator =(RegistryTypeWriter const &) = delete;
  96
  97     /// stores the handle of an implementation class
  98     TypeWriterImpl                                               m_hImpl;
  99 };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */