a3acf24ae609e7e58d384c6b74a3f0e954120c0c
[framework/web/wrt-plugins-common.git] / src / plugins-api-support / IObject.h
1 /*
2  * Copyright (c) 2012 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  *    Licensed under the Apache License, Version 2.0 (the "License");
5  *    you may not use this file except in compliance with the License.
6  *    You may obtain a copy of the License at
7  *
8  *        http://www.apache.org/licenses/LICENSE-2.0
9  *
10  *    Unless required by applicable law or agreed to in writing, software
11  *    distributed under the License is distributed on an "AS IS" BASIS,
12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  *    See the License for the specific language governing permissions and
14  *    limitations under the License.
15  */
16 /**
17  * @file    IObject.h
18  * @author  Grzegorz Krawczyk (g.krawczyk@samgsung.com)
19  * @version
20  * @brief
21  */
22 #ifndef _WRT_PLUGINS_COMMON_PLUGIN_API_SUPPORT_IOBJECT_H_
23 #define _WRT_PLUGINS_COMMON_PLUGIN_API_SUPPORT_IOBJECT_H_
24
25 #include <memory>
26 #include <list>
27
28 extern "C" {
29     typedef struct OpaqueJSClass* const (*ClassRef)();
30 }
31
32 namespace WrtPluginsApi
33 {
34
35 enum class IObjectType
36 {
37     Object,
38     Function,
39     Interface,
40     InterfaceInstance
41 };
42
43 enum class IObjectOption
44 {
45     Overlayed
46 };
47
48 class IObject;
49 typedef std::shared_ptr<IObject> IObjectPtr;
50
51 class IObject
52 {
53   public:
54     constexpr static const char* WINDOW_OBJECT()
55     {
56         return "window";
57     }
58
59     virtual void AddChild(const IObjectPtr& ) = 0;
60
61     /*
62      * Optional
63      * */
64     virtual void setBoolOption(IObjectOption option, bool value) = 0;
65
66     virtual ~IObject(){};
67 };
68
69 typedef std::list<IObjectPtr> IObjectsList;
70 typedef std::shared_ptr<IObjectsList> IObjectsListPtr;
71
72 }
73 #endif