Add documentation for Fl::reset_marked_text() and Fl::insertion_point_location().
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12930 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
parent
af3625eb20
commit
c886fe9c33
4
FL/Fl.H
4
FL/Fl.H
@ -140,6 +140,8 @@ public:
|
||||
|
||||
static Fl_Screen_Driver *screen_driver();
|
||||
static Fl_System_Driver *system_driver();
|
||||
static void reset_marked_text(); // resets marked text
|
||||
static void insertion_point_location(int x, int y, int height); // sets window coordinates & height of insertion point
|
||||
|
||||
public: // run time information about compile time configuration
|
||||
/** \defgroup cfg_gfx runtime graphics driver configuration */
|
||||
@ -197,8 +199,6 @@ public: // should be private!
|
||||
static Fl_Window* grab_;
|
||||
static int compose_state; // used for dead keys (Windows) or marked text (MacOS)
|
||||
static void call_screen_init(); // recompute screen number and dimensions
|
||||
static void reset_marked_text(); // resets marked text
|
||||
static void insertion_point_location(int x, int y, int height); // sets window coordinates & height of insertion point
|
||||
#endif // FL_DOXYGEN
|
||||
|
||||
|
||||
|
@ -1947,8 +1947,6 @@ int Fl::dnd()
|
||||
return Fl::screen_driver()->dnd();
|
||||
}
|
||||
|
||||
#if !defined(FL_DOXYGEN) // FIXME - silence Doxygen warnings
|
||||
|
||||
/**
|
||||
* Resets marked text.
|
||||
*
|
||||
@ -1969,14 +1967,12 @@ void Fl::reset_marked_text() {
|
||||
/**
|
||||
Sets window coordinates and height of insertion point.
|
||||
|
||||
\todo Please explain what exactly this does and how to use it.
|
||||
\see Fl::compose(int& del) for a detailed description.
|
||||
*/
|
||||
void Fl::insertion_point_location(int x, int y, int height) {
|
||||
Fl::screen_driver()->insertion_point_location(x, y, height);
|
||||
}
|
||||
|
||||
#endif // !defined(FL_DOXYGEN) // FIXME - silence Doxygen warnings
|
||||
|
||||
int Fl::event_key(int k) {
|
||||
return system_driver()->event_key(k);
|
||||
}
|
||||
|
@ -50,8 +50,8 @@ int Fl::compose_state = 0;
|
||||
marked text, usually underlining it. Widgets can use
|
||||
<tt>int Fl::compose_state</tt> <i>after</i> having called Fl::compose(int&)
|
||||
to obtain the length in bytes of marked text that always finishes at the
|
||||
current insertion point. It's the widget's task to underline marked text.
|
||||
Widgets should also call <tt>void Fl::reset_marked_text()</tt> when processing FL_UNFOCUS
|
||||
current insertion point. Widgets should also call
|
||||
<tt>void Fl::reset_marked_text()</tt> when processing FL_UNFOCUS
|
||||
events. Optionally, widgets can also call
|
||||
<tt>void Fl::insertion_point_location(int x, int y, int height)</tt> to indicate the window
|
||||
coordinates of the bottom of the current insertion point and the line height.
|
||||
@ -63,7 +63,7 @@ int Fl::compose_state = 0;
|
||||
text input will work, but will not signal to the user what text is marked.
|
||||
Finally, text editing widgets should call <tt>set_flag(MAC_USE_ACCENTS_MENU);</tt>
|
||||
in their constructor if they want to use the feature introduced with Mac OS 10.7 "Lion"
|
||||
where pressing and holding a key on the keyboard opens an accented-character menu window.
|
||||
where pressing and holding certain keys on the keyboard opens an accented-character menu window.
|
||||
|
||||
<p>Though the current implementation returns immediately, future
|
||||
versions may take quite awhile, as they may pop up a window or do
|
||||
|
Loading…
Reference in New Issue
Block a user