Update License
[platform/framework/web/livebox-cpp.git] / include / livebox-cpp.h
1 /*
2  * Copyright 2013  Samsung Electronics Co., Ltd
3  *
4  * Licensed under the Flora License, Version 1.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://floralicense.org/license/
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 /* Pure virtual class */
18 class CLiveBox
19 {
20 public:
21         CLiveBox(void) {};
22         virtual ~CLiveBox(void) {}
23
24         virtual int Create(const char *filename, const char *content, const char *cluster, const char *category) = 0;
25         virtual int Destroy(void) = 0;
26
27         virtual int NeedToUpdate(void) = 0;
28         virtual int NeedToDestroy(void) = 0;
29         virtual int UpdateContent(void) = 0;
30
31         /*!
32          * \param[in] event "clicked" only
33          */
34         virtual int Clicked(const char *event, double timestamp, double x, double  y) = 0;
35         virtual int ContentEvent(const char *emission, const char *source, struct event_info *info) = 0;
36
37         /*!
38          * if "source" == "filename", emission could be "pd,show", "pd,hide", "lb,show", "lb,hide".
39          */
40         virtual int Resize(int type) = 0;
41         virtual int ChangeGroup(const char *cluster, const char *category) = 0;
42         virtual int GetInfo(int *w, int *h, double *priority, char **content, char **title) = 0;
43         virtual char *PinUp(int on_pin) = 0;
44         virtual const char *Filename(void) = 0;
45         virtual int IsPinnedUp(void) = 0;
46         virtual int SystemEvent(int event) = 0;
47 };
48
49 /* End of a file */