source: trunk/Lucide/plugins/ludoc/luichoice.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.7 KB
Line 
1#ifndef luichoice_idl
2#define luichoice_idl
3
4#include <somobj.idl>
5#include <luifield.idl>
6
7/**
8 * LuInputChoice represents a choice box.
9 */
10interface LuInputChoice : LuInputField
11{
12    /**
13     * Returns the number of options in the choice box.
14     *
15     * To be overriden. By default, returns 0.
16     */
17    long getCount();
18
19    /**
20     * Returns the display name corresponding to the option with the given
21     * (zero-based) number.
22     *
23     * To be overriden. By default, does nothing.
24     */
25    string getChoice(in long aNumber);
26
27    /**
28     * Selects the option with the given (zero-based) number.
29     *
30     * To be overriden. By default, does nothing.
31     */
32    void select(in long aNumber);
33
34    /**
35     * Toggles the selection of the option with the given (zero-based) number.
36     *
37     * To be overriden. By default, does nothing.
38     */
39    void toggle(in long aNumber);
40
41    /**
42     * Deselects all options.
43     *
44     * To be overriden. By default, does nothing.
45     */
46    void deselectAll();
47
48    /**
49     * Sets the custom text for this choice box. Does nothing if isEditable()
50     * is FALSE.
51     *
52     * To be overriden. By default, does nothing.
53     */
54    void setChoiceText(in string aText);
55
56    /**
57     * Returns the custom text set for this choice box or a NULL string
58     * if isEditable() is FALSE.
59     *
60     * To be overriden. By default, returns NULL.
61     */
62    string getChoiceText();
63
64    /**
65     * Returns TRUE if the option with the given (zero-based) number is
66     * selected.
67     *
68     * To be overriden. By default, returns FALSE.
69     */
70    boolean isSelected(in long aNumber);
71
72    /**
73     * Returns TRUE if this is a combo box FALSE if this is a list box.
74     *
75     * To be overriden. By default, returns FALSE.
76     */
77    boolean isComboBox();
78
79    /**
80     * Returns TRUE if the choice box is editable. See setChoiceText().
81     *
82     * To be overriden. By default, returns FALSE.
83     */
84    boolean isEditable();
85
86    /**
87     * Returns TRUE if multiple options may be selected in this choice box.
88     *
89     * To be overriden. By default, returns FALSE.
90     */
91    boolean isMultiSelectable();
92
93    /**
94     * Returns TRUE if the text field may be spellchecked.
95     *
96     * To be overriden. By default, returns FALSE.
97     */
98    boolean isSpellCheckable();
99
100#ifdef __SOMIDL__
101
102    implementation
103    {
104        releaseorder: getCount, getChoice, select, toggle, deselectAll,
105                      setChoiceText, getChoiceText, isSelected, isComboBox,
106                      isEditable, isMultiSelectable, isSpellCheckable;
107    };
108
109#endif // __SOMIDL__
110};
111
112#endif // luichoice_idl
Note: See TracBrowser for help on using the repository browser.