source: trunk/Lucide/plugins/ludoc/luitext.idl @ 542

Last change on this file since 542 was 367, checked in by dmik, 11 years ago

Merged bramches/kmk (r294:365) to trunk.

  • Property svn:executable set to *
File size: 2.2 KB
RevLine 
[319]1#ifndef luitext_idl
2#define luitext_idl
3
4#include <somobj.idl>
5#include <luifield.idl>
6
7/**
8 * LuInputText represents a text field.
9 */
10interface LuInputText : LuInputField
11{
12    /**
[338]13     * Returns the contents of the text field as a zero-terminated UTF-8 string.
[319]14     *
15     * To be overriden. By default, returns NULL.
16     */
17    string getContents();
18
19    /**
[338]20     * Sets the contents of the text field using a zero-terminated UTF-8 string.
[319]21     *
22     * TO be overriden. By default, does nothing.
23     */
24    void setContents(in string aContents);
25
26    /**
27     * Returns TRUE if this is a multi-line text field.
28     *
29     * To be overriden. By default, returns FALSE.
30     */
31    boolean isMultiLine();
32
33    /**
34     * Returns TRUE if this is a password entry field.
35     *
36     * To be overriden. By default, returns FALSE.
37     */
38    boolean isPassword();
39
40    /**
41     * Returns TRUE if this is a file name entry field.
42     *
43     * To be overriden. By default, returns FALSE.
44     */
45    boolean isFileName();
46
47    /**
48     * Returns TRUE if the text field may be spellchecked.
49     *
50     * To be overriden. By default, returns FALSE.
51     */
52    boolean isSpellCheckable();
53
54    /**
55     * Returns TRUE if the is text field may be scrolled.
56     *
57     * To be overriden. By default, returns FALSE.
58     */
59    boolean isScrollable();
60
61    /**
62     * Returns TRUE if the text field uses comb formatting.
63     *
64     * To be overriden. By default, returns FALSE.
65     */
66    boolean isComb();
67
68    /**
69     * Returns TRUE if the text field uses rich text formatting.
70     *
71     * To be overriden. By default, returns FALSE.
72     */
73    boolean isRichText();
74
75    /**
76     * Returns the maximum length of the text field.
77     *
78     * To be overriden. By default, returns 0.
79     */
80    long getMaximumLength();
81
82#ifdef __SOMIDL__
83
84    implementation
85    {
86        releaseorder: getContents, setContents, isMultiLine, isPassword,
87                      isFileName, isSpellCheckable, isScrollable, isComb,
88                      isRichText, getMaximumLength;
89    };
90
91#endif // __SOMIDL__
92};
93
94#endif // luitext_idl
Note: See TracBrowser for help on using the repository browser.