setup_native/source/win32/customactions/reg4msdoc/registryw9x.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: registryw9x.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _REGISTRYW9X_HXX_
  32 #define _REGISTRYW9X_HXX_
  33
  34 #include "registry.hxx"
  35 #include "registry.hxx"
  36
  37 //---------------------------------------
  38 // constants
  39 //---------------------------------------
  40
  41 class RegistryKeyImplWin9x : public RegistryKeyImpl
  42 {
  43 public:
  44
  45     //############################################
  46     // Queries
  47     //############################################
  48
  49     /** The number of sub values of the key at hand
  50
  51         @precond IsOpen = true
  52
  53         @throws
  54     */
  55     virtual size_t GetSubValueCount() const;
  56
  57     /** The number of sub-keys of the key at hand
  58
  59         @precond IsOpen = true
  60
  61         @throws
  62     */
  63     virtual size_t GetSubKeyCount() const;
  64
  65     virtual StringListPtr GetSubKeyNames() const;
  66
  67     virtual StringListPtr GetSubValueNames() const;
  68
  69     /** Get the specified registry value
  70
  71         @precond IsOpen = true
  72     */
  73     virtual RegistryValue GetValue(const std::wstring& Name) const;
  74
  75     /** Get the specified registry value, return the given
  76         default value if value not found
  77
  78         @precond IsOpen = true
  79     */
  80     virtual RegistryValue GetValue(const std::wstring& Name, const RegistryValue& Default) const;
  81
  82     //############################################
  83     // Commands
  84     //############################################
  85
  86     /** Open the registry key, has no effect if
  87         the key is already open
  88
  89         @precond IsOpen = false
  90
  91         @throws RegistryWriteAccessDenyException
  92                 RegistryAccessDenyException
  93     */
  94     virtual void Open(bool Writeable = true);
  95
  96     /** Open the specified sub-key of the registry key
  97         at hand
  98
  99         @precond IsOpen = true
 100                  HasSubKey(Name) = true
 101
 102         @throws RegistryIOException
 103                 RegistryKeyNotFoundException
 104                 RegistryAccessDeniedException
 105     */
 106     virtual RegistryKey OpenSubKey(const std::wstring& Name, bool Writeable = true);
 107
 108     /** Creates a new sub-key below the key at hand
 109
 110         @precond IsOpen = true
 111                  IsWriteable = true
 112
 113         @throws  RegistryIOException
 114                  RegistryWriteAccessDenyException
 115     */
 116     virtual RegistryKey CreateSubKey(const std::wstring& Name);
 117
 118     /** Deletes a sub-key below the key at hand, the
 119         key must not have sub-keys
 120
 121         @precond IsOpen = true
 122                  IsWriteable = true
 123
 124         @throws  RegistryIOException
 125                  RegistryWriteAccessDenyException
 126     */
 127     virtual void DeleteSubKey(const std::wstring& Name);
 128
 129     /** Deletes a sub-key below the key at hand with all
 130         its sub-keys
 131
 132         @precond IsOpen = true
 133                  IsWriteable = true;
 134
 135         @throws  RegistryIOException
 136                  RegistryWriteAccessDenyException
 137     */
 138     virtual void DeleteSubKeyTree(const std::wstring& Name);
 139
 140     /** Delete the specified value
 141
 142         @precond IsOpen = true
 143                  IsWriteable = true
 144                  HasValue(Name) = true
 145
 146         @throws RegistryIOException
 147                 RegistryWriteAccessDeniedException
 148                 RegistryValueNotFoundException
 149     */
 150     virtual void DeleteValue(const std::wstring& Name);
 151
 152     /** Set the specified registry value
 153
 154         @precond IsOpen = true
 155                  IsWriteable = true
 156
 157         @throws  RegistryIOException
 158                  RegistryWriteAccessDenyException
 159     */
 160     virtual void SetValue(const RegistryValue& Value);
 161
 162     //############################################
 163     // Creation
 164     //
 165     // only possible through WindowsRegistry class
 166     //############################################
 167
 168 protected:
 169     /** Create instance and open the specified Registry key
 170
 171         @throws  RegistryWriteAccessDenyException
 172                  RegistryAccessDenyException
 173                  RegistryKeyNotFoundException
 174     */
 175     RegistryKeyImplWin9x(HKEY RootKey, const std::wstring& KeyName);
 176
 177     /** Create instance and open the specified Registry key
 178
 179         @throws  RegistryWriteAccessDenyException
 180                  RegistryAccessDenyException
 181                  RegistryKeyNotFoundException
 182     */
 183     RegistryKeyImplWin9x(HKEY RootKey);
 184
 185     /** Create an instances of the specified Registry key,
 186     the key is assumed to be already opened.
 187     */
 188     RegistryKeyImplWin9x(HKEY RootKey, HKEY SubKey, const std::wstring& KeyName, bool Writeable = true);
 189
 190 // prevent copy/assignment
 191 private:
 192     RegistryKeyImplWin9x(const RegistryKeyImplWin9x&);
 193     RegistryKeyImplWin9x& operator=(const RegistryKeyImplWin9x&);
 194
 195 //######################################
 196 // Friend declarations
 197 //######################################
 198
 199 friend class WindowsRegistry;
 200 };
 201
 202 #endif