diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/Fl_Input_Choice.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_Tooltip.cxx | 2 | ||||
| -rw-r--r-- | src/Fl_lock.cxx | 44 | ||||
| -rw-r--r-- | src/Fl_win32.cxx | 2 | ||||
| -rw-r--r-- | src/drivers/Wayland/Fl_Wayland_Screen_Driver.cxx | 8 |
5 files changed, 29 insertions, 29 deletions
diff --git a/src/Fl_Input_Choice.cxx b/src/Fl_Input_Choice.cxx index 4183b3e65..ea5fb35e5 100644 --- a/src/Fl_Input_Choice.cxx +++ b/src/Fl_Input_Choice.cxx @@ -57,7 +57,7 @@ FLTK triggers an `FL_BEFORE_MENU` event for this widget right before displaying the menu. This event provides an opportunity to update menu item states and activation. - + \par Example Use of Fl_Input_Choice \code #include <stdio.h> diff --git a/src/Fl_Tooltip.cxx b/src/Fl_Tooltip.cxx index 572d763d1..81a741f30 100644 --- a/src/Fl_Tooltip.cxx +++ b/src/Fl_Tooltip.cxx @@ -173,7 +173,7 @@ static void tooltip_hide_timeout(void*) { \return always 1, so this call can finish the FL_BEFORE_TOOLTIP event handling. \see void Fl_Widget::tooltip(const char *text). - + \see `test/color_chooser.cxx` for a usage example. */ int Fl_Tooltip::override_text(const char *new_text) { diff --git a/src/Fl_lock.cxx b/src/Fl_lock.cxx index 41c050e94..3f891c9c4 100644 --- a/src/Fl_lock.cxx +++ b/src/Fl_lock.cxx @@ -77,7 +77,7 @@ bool Fl_System_Driverawake_pending_ = false; #endif -/** +/** \brief Adds an awake handler for use in awake(). \internal Adds an awake handler for use in awake(). @@ -103,7 +103,7 @@ int Fl_System_Driver::push_awake_handler(Fl_Awake_Handler func, void *data, bool } // If we want to add the handler only once, go through the list of existing - // handlers and remove any handler with the same function pointer + // handlers and remove any handler with the same function pointer // and data pointer. if (once) { int src = awake_ring_tail_; @@ -144,9 +144,9 @@ int Fl_System_Driver::push_awake_handler(Fl_Awake_Handler func, void *data, bool return ret; } -/** +/** \brief Gets the last stored awake handler for use in awake(). - \internal Used in the main event loop when an Awake message is received. + \internal Used in the main event loop when an Awake message is received. */ int Fl_System_Driver::pop_awake_handler(Fl_Awake_Handler &func, void *&data) { @@ -168,7 +168,7 @@ int Fl_System_Driver::pop_awake_handler(Fl_Awake_Handler &func, void *&data) /** \brief Checks if the awake ring buffer is empty. - \internal Used in the main event loop when an Awake message is received. + \internal Used in the main event loop when an Awake message is received. */ bool Fl_System_Driver::awake_ring_empty() { Fl::system_driver()->lock_ring(); @@ -180,9 +180,9 @@ bool Fl_System_Driver::awake_ring_empty() { /** \brief Notifies the main GUI thread from a worker thread. - In FLTK, worker threads can update the UI, but all UI changes must be wrapped - between Fl::lock() and Fl::unlock(). After calling Fl::unlock(), the worker - thread should call Fl::awake() to signal the main thread that + In FLTK, worker threads can update the UI, but all UI changes must be wrapped + between Fl::lock() and Fl::unlock(). After calling Fl::unlock(), the worker + thread should call Fl::awake() to signal the main thread that updates are pending. \note Worker threads must not create, show, or hide windows. @@ -201,12 +201,12 @@ void Fl::awake() { \deprecated Use Fl::awake() or Fl::awake(Fl_Awake_Handler, void*) instead. This method is deprecated. The API can not ensure that Fl::thread_message() - returns the messages sent by Fl::awake(void *v) complete and in the correct + returns the messages sent by Fl::awake(void *v) complete and in the correct order. Use Fl::awake() instead if you do not need to send a specific message. Use Fl::awake(Fl_Awake_Handler, void*) or Fl::awake_once(Fl_Awake_Handler, void*) - if you need to send a message to the main thread and ensure that all messages + if you need to send a message to the main thread and ensure that all messages are processed in the order they were sent. \see \ref advanced_multithreading @@ -225,16 +225,16 @@ void Fl::awake(void *v) { be run by the main thread, passing optional user data. The callback will be executed during the main thread's next event handling cycle. - The queue holding the list of handlers is limited to 1024 entries. + The queue holding the list of handlers is limited to 1024 entries. If the queue is full, the function will return -1 and the callback will not be - scheduled. However the main thread will still be woken up to process any + scheduled. However the main thread will still be woken up to process any other pending events. \note If user_data points to dynamically allocated memory, it is the responsibility of the caller to ensure that the memory is valid until the callback is executed. The callback will be executed during the main thread's - next event handling cycle, but depending on the sytems load, this may take - several seconds. + next event handling cycle, but depending on the sytems load, this may take + several seconds. \return 0 if the callback was successfully scheduled \return -1 if the queue is full. @@ -273,15 +273,15 @@ int Fl::awake_once(Fl_Awake_Handler handler, void *user_data) { /** \brief Returns the last message sent by a child thread. - - \deprecated Use Fl::awake(Fl_Awake_Handler, void*) or + + \deprecated Use Fl::awake(Fl_Awake_Handler, void*) or Fl::awake_once(Fl_Awake_Handler, void*) instead. The thread_message() method returns the last message that was sent from a child by the Fl::awake(void*) method. This method is deprecated. The API can not ensure that Fl::thread_message() - returns the messages sent by Fl::awake(void *v) complete and in the correct + returns the messages sent by Fl::awake(void *v) complete and in the correct order. \see \ref advanced_multithreading @@ -300,14 +300,14 @@ void* Fl::thread_message() { The lock() method blocks the current thread until it can safely access FLTK widgets and data. Child threads should call this method prior to updating any widgets or accessing - data. The main thread must call Fl::lock() once before any windows are shown + data. The main thread must call Fl::lock() once before any windows are shown to initialize the threading support in FLTK. The initial Fl::lock() call will return non-zero if threading is not available on the platform. - Child threads enclose calls to FLTK functions between Fl::lock() and + Child threads enclose calls to FLTK functions between Fl::lock() and Fl::unlock() accessing FLTK. When a child thread has finshed accessing FLTK and wants the main thread to update the UI, it should call Fl::awake(). - + Child threads can never create, show, or hide windows. When the wait() method is waiting @@ -327,10 +327,10 @@ int Fl::lock() { return Fl::system_driver()->lock(); } -/** +/** \brief Release the global UI lock set by Fl::lock(). - The unlock() method releases the lock that was set using the lock() method. + The unlock() method releases the lock that was set using the lock() method. Child threads should call this method as soon as they are finished accessing FLTK. diff --git a/src/Fl_win32.cxx b/src/Fl_win32.cxx index b70f45bb2..ac3bd1460 100644 --- a/src/Fl_win32.cxx +++ b/src/Fl_win32.cxx @@ -2342,7 +2342,7 @@ void Fl_WinAPI_Window_Driver::makeWindow() { if (!im_enabled) flImmAssociateContextEx((HWND)x->xid, 0, 0); - + if (w->fullscreen_active()) Fl::handle(FL_FULLSCREEN, w); } diff --git a/src/drivers/Wayland/Fl_Wayland_Screen_Driver.cxx b/src/drivers/Wayland/Fl_Wayland_Screen_Driver.cxx index e6f4ad65f..0b3732879 100644 --- a/src/drivers/Wayland/Fl_Wayland_Screen_Driver.cxx +++ b/src/drivers/Wayland/Fl_Wayland_Screen_Driver.cxx @@ -1607,7 +1607,7 @@ static int workarea_xywh[4] = { -1, -1, -1, -1 }; /* Implementation note about computing work area and about handling fractional scaling. - + FLTK computes 2 pairs of (WxH) values for each display: 1) (pixel_width x pixel_height) gives the size in pixel of a display. It's unchanged by any scaling applied by the compositor; it's assigned by function output_mode(). @@ -1615,7 +1615,7 @@ static int workarea_xywh[4] = { -1, -1, -1, -1 }; When the active scaling is non-fractional, these equations hold: pixel_width = width = wld_scale * configured-width-of-fullscreen-window pixel_height = height = wld_scale * configured-height-of-fullscreen-window - + When fractional scaling is active, buffers received from client are scaled down by the compositor and mapped to screen. These equations hold: pixel_width < width = wld_scale * configured-width-of-fullscreen-window @@ -1624,7 +1624,7 @@ static int workarea_xywh[4] = { -1, -1, -1, -1 }; One way for a client to discover that fractional scaling is active on a given display is to ask for a fullscreen window on that display, get its configured size and compare it to that display's pixel size. That's what function compute_full_and_maximized_areas() does. - + One way for a client to discover the work area size of a display is to get the configured size of a maximized window on that display. FLTK didn't find a way to control in general on what display the compositor puts a maximized window. One procedure which works @@ -1634,7 +1634,7 @@ static int workarea_xywh[4] = { -1, -1, -1, -1 }; display as the fullscreen one, giving the size of that display's work area. Therefore, FLTK computes an exact work area size only with MUTTER or when the system contains a single display. That's also done by function compute_full_and_maximized_areas(). - + The procedure to compute the work area size also reveals which display is primary: that with a work area vertically smaller than the display's pixel height. This allows to place the primary display as FLTK display #0. Again, FLTK guarantees to identify |