]> git.lyx.org Git - lyx.git/blob - src/frontends/xforms/xforms_helpers.h
Bugfixes: checkboxes to radiobuttons (from J�rgen S) and remove a little
[lyx.git] / src / frontends / xforms / xforms_helpers.h
1 // -*- C++ -*-
2
3 #ifndef XFORMSHELPERS_H
4 #define XFORMSHELPERS_H
5
6 #ifdef __GNUG_
7 #pragma interface
8 #endif
9
10 #include FORMS_H_LOCATION
11  
12 #include "Color.h"
13 #include "LString.h"
14  
15 #include <vector>
16
17 class LyXLength;
18
19 /// Extract shortcut from <ident>|<shortcut> string
20 char const * flyx_shortcut_extract(char const * sc);
21 /// Shortcut for flyx_shortcut_extract
22 #define scex flyx_shortcut_extract
23
24 /// Extract shortcut from <ident>|<shortcut> string
25 char const * flyx_ident_extract(char const * sc);
26 /// Shortcut for flyx_ident_extract
27 #define idex flyx_ident_extract
28
29 /// Set an FL_OBJECT to activated or deactivated
30 void setEnabled(FL_OBJECT *, bool enable);
31
32 /// Take a string and add breaks so that it fits into a desired label width, w
33 string formatted(string const &label, int w,
34                  int = FL_NORMAL_SIZE, int = FL_NORMAL_STYLE);
35
36 /// Given an fl_choice, create a vector of its entries
37 std::vector<string> const getVectorFromChoice(FL_OBJECT *);
38
39 /// Given an fl_browser, create a vector of its entries
40 std::vector<string> const getVectorFromBrowser(FL_OBJECT *);
41
42 /// Given an fl_input, return its contents.
43 string const getStringFromInput(FL_OBJECT * ob);
44
45 /** Given an fl_browser, return the contents of the currently
46     highlighted line.
47 */
48 /** Given an fl_browser, return the contents of line
49     (xforms numbering convention; starts at 1).
50 */
51 string const getStringFromBrowser(FL_OBJECT * ob, int line);
52 /** Given an fl_browser, return the contents of the currently
53     highlighted line.
54 */
55 string const getSelectedStringFromBrowser(FL_OBJECT * ob);
56
57 /// Given input and choice widgets, create a string such as "1cm"
58 string getLengthFromWidgets(FL_OBJECT * input, FL_OBJECT * choice);
59
60 /** Given a string such as "1cm", set the input and choice widgets.
61     If the string is empty, the choice will be set to default_unit.
62  */
63 void updateWidgetsFromLengthString(FL_OBJECT * input, FL_OBJECT * choice,
64                                    string const & str,
65                                    string const & default_unit);
66
67 /** Given a LyXLength, set the input and choice widgets.
68     If the length is null, the choice will be set to default_unit.
69  */
70 void updateWidgetsFromLength(FL_OBJECT * input, FL_OBJECT * choice,
71                              LyXLength const & len,
72                              string const & default_unit);
73
74 /// struct holding xform-specific colors
75 struct XformsColor : public NamedColor {
76         int colorID;
77         XformsColor() : NamedColor(), colorID(0) {}
78         static bool read(string const &);
79         static bool write(string const &);
80 };
81
82
83 /** Some functions that perform some quite detailed tests to ascertain whether
84     the directory or file is readable or writeable. If not, then an error
85     message is placed in error_message. */
86 class RWInfo {
87 public:
88         ///
89         static bool WriteableDir(string const & dir);
90         ///
91         static bool ReadableDir(string const & dir);
92         ///
93         static bool WriteableFile(string const & file);
94         ///
95         static bool ReadableFile(string const & file);
96         ///
97         static string const & ErrorMessage() { return error_message; }
98 private:
99         ///
100         static string error_message;
101 };
102 #endif // XFORMSHELPERS_H