registry/source/reflread.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_REFLREAD_HXX
  21 #define INCLUDED_REGISTRY_SOURCE_REFLREAD_HXX
  22
  23 #include <registry/refltype.hxx>
  24 #include <rtl/ustring.hxx>
  25
  26 /// Implementation handle
  27 typedef void* TypeReaderImpl;
  28
  29 /** RegistryTypeReades reads a binary type blob.
  30
  31     This class provides the necessary functions to read type information
  32     for all kinds of types of a type blob.
  33
  34     @deprecated
  35     use typereg::Reader instead
  36 */
  37 class RegistryTypeReader
  38 {
  39 public:
  40
  41     /** Constructor.
  42
  43         @param buffer points to the binary data block.
  44         @param bufferLen specifies the size of the binary data block.
  45      */
  46     RegistryTypeReader(const sal_uInt8* buffer,
  47                               sal_uInt32 bufferLen);
  48
  49     /// Destructor. The Destructor frees the data block if the copyData flag was TRUE.
  50     ~RegistryTypeReader();
  51
  52     /** returns the typeclass of the type represented by this blob.
  53
  54         This function will always return the type class without the internal
  55         RT_TYPE_PUBLISHED flag set.
  56      */
  57     RTTypeClass      getTypeClass() const;
  58
  59     /** returns the full qualified name of the type.
  60      */
  61     OUString  getTypeName() const;
  62
  63     /** returns the full qualified name of the supertype.
  64      */
  65     OUString  getSuperTypeName() const;
  66
  67     /** returns the number of fields (attributes/properties, enum values or number
  68         of constants in a module).
  69
  70      */
  71     sal_uInt32       getFieldCount() const;
  72
  73     /** returns the name of the field specified by index.
  74      */
  75     OUString  getFieldName( sal_uInt16 index ) const;
  76
  77     /** returns the full qualified name of the field specified by index.
  78      */
  79     OUString  getFieldType( sal_uInt16 index ) const;
  80
  81     /** returns the access mode of the field specified by index.
  82      */
  83     RTFieldAccess    getFieldAccess( sal_uInt16 index ) const;
  84
  85     /** returns the value of the field specified by index.
  86
  87         This function returns the value of an enum value or of a constant.
  88      */
  89     RTConstValue     getFieldConstValue( sal_uInt16 index ) const;
  90
  91     /** returns the documentation string for the field specified by index.
  92
  93         Each field of a type can have their own documentation.
  94      */
  95     OUString  getFieldDoku( sal_uInt16 index ) const;
  96
  97     /** returns the IDL filename of the field specified by index.
  98
  99         The IDL filename of a field can differ from the filename of the ype itself
 100         because modules and also constants can be defined in different IDL files.
 101      */
 102     OUString  getFieldFileName( sal_uInt16 index ) const;
 103
 104 private:
 105     RegistryTypeReader(RegistryTypeReader const &) = delete;
 106     void operator =(RegistryTypeReader const &) = delete;
 107
 108     /// stores the handle of an implementation class
 109     TypeReaderImpl                                              m_hImpl;
 110 };
 111
 112 #endif
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */