Skip to content

GitLab

Commit 4374f189 authored by Davis King's avatar Davis King
Browse files

clarified spec

parent cab98cc1
Hide whitespace changes
Inline Side-by-side
Showing with 7 additions and 7 deletions
dlib/gui_widgets/widgets_abstract.h
View file @ 4374f189
...@@ -2761,7 +2761,7 @@ namespace dlib ...@@ -2761,7 +2761,7 @@ namespace dlib
requires requires
- event_handler is a valid pointer to a member function in T - event_handler is a valid pointer to a member function in T
ensures ensures
- The event_handler function is called on object when the user clicks - The event_handler function is called on object when the user left clicks
anywhere on the image. When they do so this callback is called with the anywhere on the image. When they do so this callback is called with the
location of the image pixel which was clicked. The is_double_click bool location of the image pixel which was clicked. The is_double_click bool
will also tell you if it was a double click or single click. will also tell you if it was a double click or single click.
...@@ -2777,10 +2777,10 @@ namespace dlib ...@@ -2777,10 +2777,10 @@ namespace dlib
); );
/* /*
ensures ensures
- The event_handler function is called when the user clicks anywhere on the - The event_handler function is called when the user left clicks anywhere
image. When they do so this callback is called with the location of the on the image. When they do so this callback is called with the location
image pixel which was clicked. The is_double_click bool will also tell of the image pixel which was clicked. The is_double_click bool will also
you if it was a double click or single click. tell you if it was a double click or single click.
- Any previous calls to this function are overridden by this new call. - Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this event at a (i.e. you can only have one event handler associated with this event at a
time) time)
...@@ -3024,8 +3024,8 @@ namespace dlib ...@@ -3024,8 +3024,8 @@ namespace dlib
); );
/*! /*!
ensures ensures
- This function blocks until the user double clicks on the image - This function blocks until the user double left clicks on the image or
or the window is closed by the user. the window is closed by the user.
- if (this function returns true) then - if (this function returns true) then
- #p == the next image pixel the user clicked. - #p == the next image pixel the user clicked.
!*/ !*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment