Tizen 2.1 base
[platform/core/appfw/shortcut.git] / include / SLP_shortcut_PG.h
1 /*
2  * Copyright 2012  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://www.tizenopensource.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 /**
18  *  @ingroup SLP_PG
19  *  @defgroup SHORTCUT_PG Add to home (shortcut)
20  *  @{
21
22  <h1 class="pg">Introduction</h1>
23  Shortcut is a communication interfaces for homescreen and applications. To enable the add_to_home feature. Shortcut(libslp-shortcut) uses socket for IPC.
24
25  @image html SLP_Shortcut_PG_image01.png
26
27  <h2 class="pg">Properties</h2>
28 - Types of shortcut
29 - Header File : shortcut.h 
30
31 <h1 class="pg">Programming Guide</h1>
32
33 <h2 class="pg">Types of shortcut</h1>
34 Shortcut defines 3 kinds of types.
35
36 <h3 class="pg">1.       SHORTCUT_PACKAGE</h1>
37 We can use this for adding a package shortcut with additional information. <br/>
38 @code
39 @endcode
40
41 <h3 class="pg">2.       SHORTCUT_DATA</h1>
42 @code
43 @endcode
44
45 <h3 class="pg">3.       SHORTCUT_FILE</h1>
46 @code
47 @endcode
48
49 <h2 class="pg">Error code</h1>
50 <h3 class="pg">1.       -EINVAL</h1>
51 <h3 class="pg">1.       -EFAULT</h1>
52 @code
53 @endcode
54 */
55
56 /**
57 @}
58 */