mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make Windows-specific HICON-using functions visible in doc.

Browse Source
This commit is contained in:
ManoloFLTK 2022-10-06 13:15:16 +02:00
parent 6732044a07
commit 5f189aa213
2 changed files with 31 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
FL/Fl_Window.H
View File

@ -351,13 +351,42 @@ public:
void icon(const Fl_RGB_Image*); void icon(const Fl_RGB_Image*);
void icons(const Fl_RGB_Image*[], int); void icons(const Fl_RGB_Image*[], int);
#if defined(_WIN32) && !defined(FL_DOXYGEN) #if defined(_WIN32) || defined(FL_DOXYGEN)
typedef struct HICON__* HICON; typedef struct HICON__* HICON;
// These 2 member functions break the driver model but are kept for back compatibility. // These 2 member functions break the driver model but are kept for back compatibility.
// They are implemented in Fl_win32.cxx // They are implemented in Fl_win32.cxx
/** Sets the default window icons (Windows platform only).
Convenience function to set the default icons using Windows'
native HICON icon handles.
The given icons are copied. You can free the icons immediately after
this call.
\param[in] big_icon default large icon for all windows
subsequently created
\param[in] small_icon default small icon for all windows
subsequently created
\see Fl_Window::default_icon(const Fl_RGB_Image *)
\see Fl_Window::default_icons(const Fl_RGB_Image *[], int)
\see Fl_Window::icon(const Fl_RGB_Image *)
\see Fl_Window::icons(const Fl_RGB_Image *[], int)
\see Fl_Window::icons(HICON, HICON)
*/
static void default_icons(HICON big_icon, HICON small_icon); static void default_icons(HICON big_icon, HICON small_icon);
/** Sets the window icons using HICON handles (Windows platform only).
The given icons are copied. You can free the icons immediately after
this call.
\param[in] big_icon large window icon
\param[in] small_icon small window icon
*/
void icons(HICON big_icon, HICON small_icon); void icons(HICON big_icon, HICON small_icon);
#endif #endif // defined(_WIN32) || defined(FL_DOXYGEN)
/* for legacy compatibility */ /* for legacy compatibility */
const void* icon() const; const void* icon() const;

26
src/Fl_win32.cxx
View File

@ -2447,14 +2447,7 @@ void Fl_WinAPI_Screen_Driver::default_icons(const Fl_RGB_Image *icons[], int cou
} }
} }
/** Sets the window icons using Windows' native HICON icon handles.
The given icons are copied. You can free the icons immediately after
this call.
\param[in] big_icon large window icon
\param[in] small_icon small window icon
*/
void Fl_Window::icons(HICON big_icon, HICON small_icon) { void Fl_Window::icons(HICON big_icon, HICON small_icon) {
free_icons(); free_icons();
if (big_icon != NULL) if (big_icon != NULL)
@ -2465,25 +2458,6 @@ void Fl_Window::icons(HICON big_icon, HICON small_icon) {
Fl_WinAPI_Window_Driver::driver(this)->set_icons(); Fl_WinAPI_Window_Driver::driver(this)->set_icons();
} }
/** Sets the default window icons.
Convenience function to set the default icons using Windows'
native HICON icon handles.
The given icons are copied. You can free the icons immediately after
this call.
\param[in] big_icon default large icon for all windows
subsequently created
\param[in] small_icon default small icon for all windows
subsequently created
\see Fl_Window::default_icon(const Fl_RGB_Image *)
\see Fl_Window::default_icons(const Fl_RGB_Image *[], int)
\see Fl_Window::icon(const Fl_RGB_Image *)
\see Fl_Window::icons(const Fl_RGB_Image *[], int)
\see Fl_Window::icons(HICON, HICON)
*/
void Fl_Window::default_icons(HICON big_icon, HICON small_icon) { void Fl_Window::default_icons(HICON big_icon, HICON small_icon) {
if (default_big_icon != NULL) if (default_big_icon != NULL)
DestroyIcon(default_big_icon); DestroyIcon(default_big_icon);