diff options
| author | Manolo Gouy <Manolo> | 2018-05-24 10:58:47 +0000 |
|---|---|---|
| committer | Manolo Gouy <Manolo> | 2018-05-24 10:58:47 +0000 |
| commit | c886fe9c33e6894c2e70f07857b4c29cfa77d60a (patch) | |
| tree | fbd701859293a05a2b706b074c65df27d7b22e25 | |
| parent | af3625eb209f68eccb5bd281f768aba606e8b811 (diff) | |
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
| -rw-r--r-- | FL/Fl.H | 4 | ||||
| -rw-r--r-- | src/Fl.cxx | 6 | ||||
| -rw-r--r-- | src/Fl_compose.cxx | 6 |
3 files changed, 6 insertions, 10 deletions
@@ -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 diff --git a/src/Fl.cxx b/src/Fl.cxx index 81aecdb25..0ba7f17e1 100644 --- a/src/Fl.cxx +++ b/src/Fl.cxx @@ -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); } diff --git a/src/Fl_compose.cxx b/src/Fl_compose.cxx index 8a65841a8..6d4aa9032 100644 --- a/src/Fl_compose.cxx +++ b/src/Fl_compose.cxx @@ -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 |
