File: ewk_file_chooser.h

package info (click to toggle)
qtwebkit-opensource-src 5.7.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 291,692 kB
  • ctags: 268,122
  • sloc: cpp: 1,360,420; python: 70,286; ansic: 42,986; perl: 35,476; ruby: 12,236; objc: 9,465; xml: 8,396; asm: 3,873; yacc: 2,397; sh: 1,647; makefile: 650; lex: 644; java: 110
file content (132 lines) | stat: -rw-r--r-- 4,483 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
    Copyright (C) 2012 Samsung Electronics

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

/**
 * @file    ewk_file_chooser.h
 * @brief   File Chooser API.
 *
 * File Chooser supports APIs for file selection dialog.
 * This support attributes of file chooser regarding:
 * - allowance of multiple files selection
 * - allowance of upload directory
 * - list of accepted mime types
 * - list of accepted file extensions
 * - list of initial selected file names
 * - capture attribute for HTML media capture
 */

#ifndef ewk_file_chooser_h
#define ewk_file_chooser_h

#include <Eina.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _Ewk_File_Chooser Ewk_File_Chooser;

/**
 * \enum    _Ewk_File_Chooser_Capture_Type
 * @brief   Types of capture attribute of file chooser to support the HTML media capture.
 */
enum _Ewk_File_Chooser_Capture_Type {
    EWK_FILE_CHOOSER_CAPTURE_TYPE_INVALID,
    EWK_FILE_CHOOSER_CAPTURE_TYPE_FILESYSTEM,
    EWK_FILE_CHOOSER_CAPTURE_TYPE_CAMERA,
    EWK_FILE_CHOOSER_CAPTURE_TYPE_CAMCORDER,
    EWK_FILE_CHOOSER_CAPTURE_TYPE_MICROPHONE
};
typedef enum _Ewk_File_Chooser_Capture_Type Ewk_File_Chooser_Capture_Type;

/**
 * Query if multiple files are supported by file chooser.
 *
 * @param f file chooser object.
 *
 * It returns a boolean value which indicates if multiple file is supported or not.
 *
 * @return @c EINA_TRUE on support multiple files or @c EINA_FALSE otherwise.
 */
EAPI Eina_Bool ewk_file_chooser_allows_multiple_files_get(const Ewk_File_Chooser *f);

/**
 * Query if directory upload is supported by file chooser.
 *
 * @param f file chooser object.
 *
 * It returns a boolean value which indicates if directory upload is supported or not.
 *
 * @return @c EINA_TRUE on support directory upload or @c EINA_FALSE otherwise.
 */
EAPI Eina_Bool ewk_file_chooser_allows_directory_upload_get(const Ewk_File_Chooser *f);

/**
 * Returns the list of accepted mimetypes of the file chooser.
 *
 * @param f file chooser object.
 *
 * @return Eina_List of accepted mimetypes on success, or @c NULL on failure,
 *         the Eina_List and its items should be freed after use. Use eina_stringshare_del()
 *         to free the items.
 */
EAPI Eina_List *ewk_file_chooser_accept_mimetypes_get(const Ewk_File_Chooser *f);

/**
 * Returns the list of accepted file extensions of the file chooser.
 *
 * @param f file chooser object.
 *
 * @return @c Eina_List of accepted file extensions on success, or @c NULL on failure,
 *         the Eina_List and its items should be freed after use. Use eina_stringshare_del()
 *         to free the items.
 */
EAPI Eina_List *ewk_file_chooser_accept_file_extentions_get(const Ewk_File_Chooser *f);

/**
 * Returns the list of selected file names of the file chooser.
 *
 * This list indicates previously selected file names of the file chooser.
 * These can be used by initial values of the file dialog.
 *
 * @param f file chooser object.
 *
 * @return @c Eina_List of selected file names on success, or @c NULL on failure,
 *         the Eina_List and its items should be freed after use. Use eina_stringshare_del()
 *         to free the items.
 */
EAPI Eina_List *ewk_file_chooser_selected_files_get(const Ewk_File_Chooser *f);

/**
 * Returns the capture attribute of the file chooser to support HTML media capture.
 *
 * @see http://www.w3.org/TR/html-media-capture/ for the semantics of the capture attribute.
 *
 * @param f file chooser object.
 *
 * @return @c Ewk_File_Chooser_Capture_Type on supporting HTML media capture or
 *         @c EWK_FILE_CHOOSER_CAPTURE_TYPE_INVALID on failure.
 */
EAPI Ewk_File_Chooser_Capture_Type ewk_file_chooser_capture_get(const Ewk_File_Chooser *f);

#ifdef __cplusplus
}
#endif

#endif // ewk_file_chooser_h