Prefs: add a function preferences()
[scilab.git] / scilab / modules / preferences / src / jni / ScilabPreferences.hxx
1 /* Generated by GIWS (version 2.0.1) with command:
2 giws -e -r -f ScilabPreferences.giws.xml 
3 */
4 /*
5
6 This is generated code.
7
8 This software is a computer program whose purpose is to hide the complexity
9 of accessing Java objects/methods from C++ code.
10
11 This software is governed by the CeCILL-B license under French law and
12 abiding by the rules of distribution of free software.  You can  use, 
13 modify and/ or redistribute the software under the terms of the CeCILL-B
14 license as circulated by CEA, CNRS and INRIA at the following URL
15 "http://www.cecill.info". 
16
17 As a counterpart to the access to the source code and  rights to copy,
18 modify and redistribute granted by the license, users are provided only
19 with a limited warranty  and the software's author,  the holder of the
20 economic rights,  and the successive licensors  have only  limited
21 liability. 
22
23 In this respect, the user's attention is drawn to the risks associated
24 with loading,  using,  modifying and/or developing or reproducing the
25 software by the user in light of its specific status of free software,
26 that may mean  that it is complicated to manipulate,  and  that  also
27 therefore means  that it is reserved for developers  and  experienced
28 professionals having in-depth computer knowledge. Users are therefore
29 encouraged to load and test the software's suitability as regards their
30 requirements in conditions enabling the security of their systems and/or 
31 data to be ensured and,  more generally, to use and operate it in the 
32 same conditions as regards security. 
33
34 The fact that you are presently reading this means that you have had
35 knowledge of the CeCILL-B license and that you accept its terms.
36 */
37
38
39 #ifndef __ORG_SCILAB_MODULES_PREFERENCES_SCILABPREFERENCES__
40 #define __ORG_SCILAB_MODULES_PREFERENCES_SCILABPREFERENCES__
41 #include <iostream>
42 #include <string>
43 #include <string.h>
44 #include <stdlib.h>
45 #include <jni.h>
46
47 #include "GiwsException.hxx"
48
49         #if !defined(byte) | !defined(_MSC_VER) /* Defined anyway with Visual */
50                 typedef signed char byte;
51         #else
52                 #pragma message("Byte has been redefined elsewhere. Some problems can happen")
53         #endif
54
55
56 #ifndef GIWSEXPORT
57 # if defined(_MSC_VER) || defined(__WIN32__) || defined(__CYGWIN__)
58 #   if defined(STATIC_LINKED)
59 #     define GIWSEXPORT
60 #   else
61 #     define GIWSEXPORT __declspec(dllexport)
62 #   endif
63 # else
64 #   if __GNUC__ >= 4
65 #     define GIWSEXPORT __attribute__ ((visibility ("default")))
66 #   else
67 #     define GIWSEXPORT
68 #   endif
69 # endif
70 #endif
71
72 namespace org_scilab_modules_preferences {
73 class GIWSEXPORT ScilabPreferences {
74
75 private:
76 JavaVM * jvm;
77
78 protected:
79 jmethodID voidaddToolboxInfosjstringjava_lang_Stringjstringjava_lang_Stringjstringjava_lang_StringID; // cache method id
80 jmethodID voidremoveToolboxInfosjstringjava_lang_StringID; // cache method id
81 jmethodID voidopenPreferencesID; // cache method id
82
83
84
85 jobject instance;
86 jclass instanceClass; // cache class
87
88                        
89 // Caching (if any)
90
91
92 /**
93 * Get the environment matching to the current thread.
94 */
95 virtual JNIEnv * getCurrentEnv();
96
97 public:
98 // Constructor
99 /**
100 * Create a wrapping of the object from a JNIEnv.
101 * It will call the default constructor
102 * @param JEnv_ the Java Env
103 */
104 ScilabPreferences(JavaVM * jvm_);
105
106 /**
107 * Create a wrapping of an already existing object from a JNIEnv.
108 * The object must have already been instantiated
109 * @param JEnv_ the Java Env
110 * @param JObj the object
111 */
112 ScilabPreferences(JavaVM * jvm_, jobject JObj);
113
114
115 /** 
116 * This is a fake constructor to avoid the constructor
117 * chaining when dealing with extended giws classes 
118 */
119 #ifdef FAKEGIWSDATATYPE
120 ScilabPreferences(fakeGiwsDataType::fakeGiwsDataType /* unused */) {}
121 #endif
122
123 // Destructor
124 ~ScilabPreferences();
125
126 // Generic method
127 // Synchronization methods
128 /**
129 * Enter monitor associated with the object.
130 * Equivalent of creating a "synchronized(obj)" scope in Java.
131 */
132 void synchronize();
133
134 /**
135 * Exit monitor associated with the object.
136 * Equivalent of ending a "synchronized(obj)" scope.
137 */
138 void endSynchronize();
139
140 // Methods
141 static void addToolboxInfos(JavaVM * jvm_, char const* name, char const* path, char const* prefFile);
142
143 static void removeToolboxInfos(JavaVM * jvm_, char const* path);
144
145 static void openPreferences(JavaVM * jvm_);
146
147
148                         /**
149                         * Get class name to use for static methods
150                         * @return class name to use for static methods
151                         */
152                         
153                 static const std::string className()
154                 {
155                 return "org/scilab/modules/preferences/ScilabPreferences";
156                 }
157                 
158 };
159
160
161 }
162 #endif