Enumerations.H 42 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019
  1. //
  2. // "$Id: Enumerations.H 10113 2014-02-25 04:24:41Z greg.ercolano $"
  3. //
  4. // Enumerations for the Fast Light Tool Kit (FLTK).
  5. //
  6. // Copyright 1998-2012 by Bill Spitzak and others.
  7. //
  8. // This library is free software. Distribution and use rights are outlined in
  9. // the file "COPYING" which should have been included with this file. If this
  10. // file is missing or damaged, see the license at:
  11. //
  12. // http://www.fltk.org/COPYING.php
  13. //
  14. // Please report all bugs and problems on the following page:
  15. //
  16. // http://www.fltk.org/str.php
  17. //
  18. /** \file
  19. This file contains type definitions and general enumerations.
  20. */
  21. #ifndef Fl_Enumerations_H
  22. #define Fl_Enumerations_H
  23. /* Uncomment the following FLTK_ABI_VERSION line to enable ABI breaking fixes
  24. * in the current patch release of FLTK. ** Use for static builds only! **
  25. * For more info on this macro, see: http://fltk.org/cmp.php#FLTK_ABI_VERSION
  26. */
  27. #define FLTK_ABI_VERSION 10303
  28. # include "Fl_Export.H"
  29. # include "fl_types.h"
  30. /** \name Version Numbers
  31. FLTK defines some constants to help the programmer to
  32. find out, for which FLTK version a program is compiled.
  33. The following constants are defined:
  34. */
  35. /*@{*/
  36. /**
  37. The major release version of this FLTK library.
  38. \sa FL_VERSION
  39. */
  40. #define FL_MAJOR_VERSION 1
  41. /**
  42. The minor release version for this library.
  43. FLTK remains mostly source-code compatible between minor version changes.
  44. */
  45. #define FL_MINOR_VERSION 3
  46. /**
  47. The patch version for this library.
  48. FLTK remains binary compatible between patches.
  49. */
  50. #define FL_PATCH_VERSION 2
  51. /**
  52. The FLTK version number as a \em double.
  53. FL_VERSION is a double that describes the major and minor version numbers.
  54. Version 1.1 is actually stored as 1.01 to allow for more than 9 minor
  55. releases.
  56. The FL_MAJOR_VERSION, FL_MINOR_VERSION, and FL_PATCH_VERSION constants
  57. give the integral values for the major, minor, and patch releases
  58. respectively.
  59. */
  60. #define FL_VERSION ((double)FL_MAJOR_VERSION + \
  61. (double)FL_MINOR_VERSION * 0.01 + \
  62. (double)FL_PATCH_VERSION * 0.0001)
  63. /*@}*/ // group: Version Numbers
  64. /**
  65. Every time a user moves the mouse pointer, clicks a button,
  66. or presses a key, an event is generated and sent to your
  67. application. Events can also come from other programs like the
  68. window manager.
  69. Events are identified by the integer argument passed to the
  70. Fl_Widget::handle() virtual method. Other information about the
  71. most recent event is stored in static locations and acquired by
  72. calling the Fl::event_*() methods. This static information remains
  73. valid until the next event is read from the window system, so it
  74. is ok to look at it outside of the handle() method.
  75. \sa Fl::event_text(), Fl::event_key(), class Fl::
  76. */
  77. enum Fl_Event { // events
  78. /** No event. */
  79. FL_NO_EVENT = 0,
  80. /** A mouse button has gone down with the mouse pointing at this
  81. widget. You can find out what button by calling Fl::event_button().
  82. You find out the mouse position by calling Fl::event_x() and
  83. Fl::event_y().
  84. A widget indicates that it "wants" the mouse click by returning non-zero
  85. from its Fl_Widget::handle() method. It will then become the
  86. Fl::pushed() widget and will get FL_DRAG and the matching FL_RELEASE events.
  87. If Fl_Widget::handle() returns zero then FLTK will try sending the FL_PUSH
  88. to another widget.
  89. */
  90. FL_PUSH = 1,
  91. /** A mouse button has been released. You can find out what button by
  92. calling Fl::event_button().
  93. In order to receive the FL_RELEASE event, the widget must return
  94. non-zero when handling FL_PUSH.
  95. */
  96. FL_RELEASE = 2,
  97. /** The mouse has been moved to point at this widget. This can
  98. be used for highlighting feedback. If a widget wants to
  99. highlight or otherwise track the mouse, it indicates this by
  100. returning non-zero from its handle() method. It then
  101. becomes the Fl::belowmouse() widget and will receive
  102. FL_MOVE and FL_LEAVE events.
  103. */
  104. FL_ENTER = 3,
  105. /** The mouse has moved out of the widget.
  106. In order to receive the FL_LEAVE event, the widget must
  107. return non-zero when handling FL_ENTER.
  108. */
  109. FL_LEAVE = 4,
  110. /** The mouse has moved with a button held down. The current button state
  111. is in Fl::event_state(). The mouse position is in Fl::event_x() and
  112. Fl::event_y().
  113. In order to receive FL_DRAG events, the widget must return non-zero
  114. when handling FL_PUSH.
  115. */
  116. FL_DRAG = 5,
  117. /** This indicates an <I>attempt</I> to give a widget the keyboard focus.
  118. If a widget wants the focus, it should change itself to display the
  119. fact that it has the focus, and return non-zero from its handle() method.
  120. It then becomes the Fl::focus() widget and gets FL_KEYDOWN, FL_KEYUP,
  121. and FL_UNFOCUS events.
  122. The focus will change either because the window manager changed which
  123. window gets the focus, or because the user tried to navigate using tab,
  124. arrows, or other keys. You can check Fl::event_key() to figure out why
  125. it moved. For navigation it will be the key pressed and for interaction
  126. with the window manager it will be zero.
  127. */
  128. FL_FOCUS = 6,
  129. /** This event is sent to the previous Fl::focus() widget when another
  130. widget gets the focus or the window loses focus.
  131. */
  132. FL_UNFOCUS = 7,
  133. /** A key was pressed (FL_KEYDOWN) or released (FL_KEYUP).
  134. Fl_KEYBOARD is a synonym for FL_KEYDOWN.
  135. The key can be found in Fl::event_key().
  136. The text that the key should insert can be found with Fl::event_text()
  137. and its length is in Fl::event_length(). If you use the key handle()
  138. should return 1. If you return zero then FLTK assumes you ignored the
  139. key and will then attempt to send it to a parent widget. If none of
  140. them want it, it will change the event into a FL_SHORTCUT event.
  141. To receive FL_KEYBOARD events you must also respond to the FL_FOCUS
  142. and FL_UNFOCUS events.
  143. If you are writing a text-editing widget you may also want to call
  144. the Fl::compose() function to translate individual keystrokes into
  145. non-ASCII characters.
  146. FL_KEYUP events are sent to the widget that currently has focus. This
  147. is not necessarily the same widget that received the corresponding
  148. FL_KEYDOWN event because focus may have changed between events.
  149. */
  150. FL_KEYDOWN = 8,
  151. /** Equivalent to FL_KEYDOWN.
  152. \see FL_KEYDOWN
  153. */
  154. FL_KEYBOARD = 8,
  155. /** Key release event.
  156. \see FL_KEYDOWN
  157. */
  158. FL_KEYUP = 9,
  159. /** The user clicked the close button of a window.
  160. This event is used internally only to trigger the callback of
  161. Fl_Window derived classed. The default callback closes the
  162. window calling Fl_Window::hide().
  163. */
  164. FL_CLOSE = 10,
  165. /** The mouse has moved without any mouse buttons held down.
  166. This event is sent to the Fl::belowmouse() widget.
  167. In order to receive FL_MOVE events, the widget must return
  168. non-zero when handling FL_ENTER.
  169. */
  170. FL_MOVE = 11,
  171. /** If the Fl::focus() widget is zero or ignores an FL_KEYBOARD
  172. event then FLTK tries sending this event to every widget it
  173. can, until one of them returns non-zero. FL_SHORTCUT is first
  174. sent to the Fl::belowmouse() widget, then its parents and siblings,
  175. and eventually to every widget in the window, trying to find an
  176. object that returns non-zero. FLTK tries really hard to not to ignore
  177. any keystrokes!
  178. You can also make "global" shortcuts by using Fl::add_handler(). A
  179. global shortcut will work no matter what windows are displayed or
  180. which one has the focus.
  181. */
  182. FL_SHORTCUT = 12,
  183. /** This widget is no longer active, due to Fl_Widget::deactivate()
  184. being called on it or one of its parents. Fl_Widget::active() may
  185. still be true after this, the widget is only active if Fl_Widget::active()
  186. is true on it and all its parents (use Fl_Widget::active_r() to check this).
  187. */
  188. FL_DEACTIVATE = 13,
  189. /** This widget is now active, due to Fl_Widget::activate() being
  190. called on it or one of its parents.
  191. */
  192. FL_ACTIVATE = 14,
  193. /** This widget is no longer visible, due to Fl_Widget::hide() being
  194. called on it or one of its parents, or due to a parent window being
  195. minimized. Fl_Widget::visible() may still be true after this, but the
  196. widget is visible only if visible() is true for it and all its
  197. parents (use Fl_Widget::visible_r() to check this).
  198. */
  199. FL_HIDE = 15,
  200. /** This widget is visible again, due to Fl_Widget::show() being called on
  201. it or one of its parents, or due to a parent window being restored.
  202. Child Fl_Windows respond to this by actually creating the window if not
  203. done already, so if you subclass a window, be sure to pass FL_SHOW
  204. to the base class Fl_Widget::handle() method!
  205. */
  206. FL_SHOW = 16,
  207. /** You should get this event some time after you call Fl::paste().
  208. The contents of Fl::event_text() is the text to insert and the number
  209. of characters is in Fl::event_length().
  210. */
  211. FL_PASTE = 17,
  212. /** The Fl::selection_owner() will get this event before the selection is
  213. moved to another widget. This indicates that some other widget or program
  214. has claimed the selection. Motif programs used this to clear the selection
  215. indication. Most modern programs ignore this.
  216. */
  217. FL_SELECTIONCLEAR = 18,
  218. /** The user has moved the mouse wheel. The Fl::event_dx() and Fl::event_dy()
  219. methods can be used to find the amount to scroll horizontally and vertically.
  220. */
  221. FL_MOUSEWHEEL = 19,
  222. /** The mouse has been moved to point at this widget. A widget that is
  223. interested in receiving drag'n'drop data must return 1 to receive
  224. FL_DND_DRAG, FL_DND_LEAVE and FL_DND_RELEASE events.
  225. */
  226. FL_DND_ENTER = 20,
  227. /** The mouse has been moved inside a widget while dragging data. A
  228. widget that is interested in receiving drag'n'drop data should
  229. indicate the possible drop position.
  230. */
  231. FL_DND_DRAG = 21,
  232. /** The mouse has moved out of the widget.
  233. */
  234. FL_DND_LEAVE = 22,
  235. /** The user has released the mouse button dropping data into the widget.
  236. If the widget returns 1, it will receive the data in the immediately
  237. following FL_PASTE event.
  238. */
  239. FL_DND_RELEASE = 23,
  240. /** The screen configuration (number, positions) was changed.
  241. Use Fl::add_handler() to be notified of this event.
  242. */
  243. FL_SCREEN_CONFIGURATION_CHANGED = 24,
  244. /** The fullscreen state of the window has changed
  245. */
  246. FL_FULLSCREEN = 25
  247. };
  248. /** \name When Conditions */
  249. /*@{*/
  250. /** These constants determine when a callback is performed.
  251. \sa Fl_Widget::when();
  252. \todo doxygen comments for values are incomplete and maybe wrong or unclear
  253. */
  254. enum Fl_When { // Fl_Widget::when():
  255. FL_WHEN_NEVER = 0, ///< Never call the callback
  256. FL_WHEN_CHANGED = 1, ///< Do the callback only when the widget value changes
  257. FL_WHEN_NOT_CHANGED = 2, ///< Do the callback whenever the user interacts with the widget
  258. FL_WHEN_RELEASE = 4, ///< Do the callback when the button or key is released and the value changes
  259. FL_WHEN_RELEASE_ALWAYS= 6, ///< Do the callback when the button or key is released, even if the value doesn't change
  260. FL_WHEN_ENTER_KEY = 8, ///< Do the callback when the user presses the ENTER key and the value changes
  261. FL_WHEN_ENTER_KEY_ALWAYS=10, ///< Do the callback when the user presses the ENTER key, even if the value doesn't change
  262. FL_WHEN_ENTER_KEY_CHANGED=11 ///< ?
  263. };
  264. /*@}*/ // group: When Conditions
  265. /** \name Mouse and Keyboard Events
  266. This and the following constants define the non-ASCII keys on the
  267. keyboard for FL_KEYBOARD and FL_SHORTCUT events.
  268. \todo FL_Button and FL_key... constants could be structured better
  269. (use an enum or some doxygen grouping ?)
  270. \sa Fl::event_key() and Fl::get_key(int) (use ascii letters for all other keys):
  271. */
  272. /*@{*/
  273. // FIXME: These codes collide with valid Unicode keys
  274. #define FL_Button 0xfee8 ///< A mouse button; use Fl_Button + n for mouse button n.
  275. #define FL_BackSpace 0xff08 ///< The backspace key.
  276. #define FL_Tab 0xff09 ///< The tab key.
  277. #define FL_Iso_Key 0xff0c ///< The additional key of ISO keyboards.
  278. #define FL_Enter 0xff0d ///< The enter key.
  279. #define FL_Pause 0xff13 ///< The pause key.
  280. #define FL_Scroll_Lock 0xff14 ///< The scroll lock key.
  281. #define FL_Escape 0xff1b ///< The escape key.
  282. #define FL_Kana 0xff2e ///< The Kana key of JIS keyboards.
  283. #define FL_Eisu 0xff2f ///< The Eisu key of JIS keyboards.
  284. #define FL_Yen 0xff30 ///< The Yen key of JIS keyboards.
  285. #define FL_JIS_Underscore 0xff31 ///< The underscore key of JIS keyboards.
  286. #define FL_Home 0xff50 ///< The home key.
  287. #define FL_Left 0xff51 ///< The left arrow key.
  288. #define FL_Up 0xff52 ///< The up arrow key.
  289. #define FL_Right 0xff53 ///< The right arrow key.
  290. #define FL_Down 0xff54 ///< The down arrow key.
  291. #define FL_Page_Up 0xff55 ///< The page-up key.
  292. #define FL_Page_Down 0xff56 ///< The page-down key.
  293. #define FL_End 0xff57 ///< The end key.
  294. #define FL_Print 0xff61 ///< The print (or print-screen) key.
  295. #define FL_Insert 0xff63 ///< The insert key.
  296. #define FL_Menu 0xff67 ///< The menu key.
  297. #define FL_Help 0xff68 ///< The 'help' key on Mac keyboards
  298. #define FL_Num_Lock 0xff7f ///< The num lock key.
  299. #define FL_KP 0xff80 ///< One of the keypad numbers; use FL_KP + 'n' for digit n.
  300. #define FL_KP_Enter 0xff8d ///< The enter key on the keypad, same as Fl_KP+'\\r'.
  301. #define FL_KP_Last 0xffbd ///< The last keypad key; use to range-check keypad.
  302. #define FL_F 0xffbd ///< One of the function keys; use FL_F + n for function key n.
  303. #define FL_F_Last 0xffe0 ///< The last function key; use to range-check function keys.
  304. #define FL_Shift_L 0xffe1 ///< The lefthand shift key.
  305. #define FL_Shift_R 0xffe2 ///< The righthand shift key.
  306. #define FL_Control_L 0xffe3 ///< The lefthand control key.
  307. #define FL_Control_R 0xffe4 ///< The righthand control key.
  308. #define FL_Caps_Lock 0xffe5 ///< The caps lock key.
  309. #define FL_Meta_L 0xffe7 ///< The left meta/Windows key.
  310. #define FL_Meta_R 0xffe8 ///< The right meta/Windows key.
  311. #define FL_Alt_L 0xffe9 ///< The left alt key.
  312. #define FL_Alt_R 0xffea ///< The right alt key.
  313. #define FL_Delete 0xffff ///< The delete key.
  314. // These use the Private Use Area (PUA) of the Basic Multilingual Plane
  315. // of Unicode. Guaranteed not to conflict with a proper Unicode character.
  316. // These primarily map to the XFree86 keysym range
  317. #define FL_Volume_Down 0xEF11 /* Volume control down */
  318. #define FL_Volume_Mute 0xEF12 /* Mute sound from the system */
  319. #define FL_Volume_Up 0xEF13 /* Volume control up */
  320. #define FL_Media_Play 0xEF14 /* Start playing of audio */
  321. #define FL_Media_Stop 0xEF15 /* Stop playing audio */
  322. #define FL_Media_Prev 0xEF16 /* Previous track */
  323. #define FL_Media_Next 0xEF17 /* Next track */
  324. #define FL_Home_Page 0xEF18 /* Display user's home page */
  325. #define FL_Mail 0xEF19 /* Invoke user's mail program */
  326. #define FL_Search 0xEF1B /* Search */
  327. #define FL_Back 0xEF26 /* Like back on a browser */
  328. #define FL_Forward 0xEF27 /* Like forward on a browser */
  329. #define FL_Stop 0xEF28 /* Stop current operation */
  330. #define FL_Refresh 0xEF29 /* Refresh the page */
  331. #define FL_Sleep 0xEF2F /* Put system to sleep */
  332. #define FL_Favorites 0xEF30 /* Show favorite locations */
  333. /*@}*/ // group: Mouse and Keyboard Events
  334. /** \name Mouse Buttons
  335. These constants define the button numbers for FL_PUSH and FL_RELEASE events.
  336. \sa Fl::event_button()
  337. */
  338. /*@{*/
  339. #define FL_LEFT_MOUSE 1 ///< The left mouse button
  340. #define FL_MIDDLE_MOUSE 2 ///< The middle mouse button
  341. #define FL_RIGHT_MOUSE 3 ///< The right mouse button
  342. /*@}*/ // group: Mouse Buttons
  343. /** \name Event States
  344. The following constants define bits in the Fl::event_state() value.
  345. */
  346. /*@{*/ // group: Event States
  347. // FIXME: it would be nice to have the modifiers in the upper 8 bit so that
  348. // a unicode ke (24bit) can be sent as an unsigned with the modifiers.
  349. #define FL_SHIFT 0x00010000 ///< One of the shift keys is down
  350. #define FL_CAPS_LOCK 0x00020000 ///< The caps lock is on
  351. #define FL_CTRL 0x00040000 ///< One of the ctrl keys is down
  352. #define FL_ALT 0x00080000 ///< One of the alt keys is down
  353. #define FL_NUM_LOCK 0x00100000 ///< The num lock is on
  354. // most X servers do this?
  355. #define FL_META 0x00400000 ///< One of the meta/Windows keys is down
  356. // correct for XFree86
  357. #define FL_SCROLL_LOCK 0x00800000 ///< The scroll lock is on
  358. // correct for XFree86
  359. #define FL_BUTTON1 0x01000000 ///< Mouse button 1 is pushed
  360. #define FL_BUTTON2 0x02000000 ///< Mouse button 2 is pushed
  361. #define FL_BUTTON3 0x04000000 ///< Mouse button 3 is pushed
  362. #define FL_BUTTONS 0x7f000000 ///< Any mouse button is pushed
  363. #define FL_BUTTON(n) (0x00800000<<(n)) ///< Mouse button n (n > 0) is pushed
  364. #define FL_KEY_MASK 0x0000ffff ///< All keys are 16 bit for now
  365. // FIXME: Unicode needs 24 bits!
  366. #ifdef __APPLE__
  367. # define FL_COMMAND FL_META ///< An alias for FL_CTRL on WIN32 and X11, or FL_META on MacOS X
  368. # define FL_CONTROL FL_CTRL ///< An alias for FL_META on WIN32 and X11, or FL_CTRL on MacOS X
  369. #else
  370. # define FL_COMMAND FL_CTRL ///< An alias for FL_CTRL on WIN32 and X11, or FL_META on MacOS X
  371. # define FL_CONTROL FL_META ///< An alias for FL_META on WIN32 and X11, or FL_CTRL on MacOS X
  372. #endif // __APPLE__
  373. /*@}*/ // group: Event States
  374. /** \name Box Types
  375. \brief FLTK standard box types
  376. This enum defines the standard box types included with FLTK.
  377. FL_NO_BOX means nothing is drawn at all, so whatever is already
  378. on the screen remains. The FL_..._FRAME types only draw their edges,
  379. leaving the interior unchanged. The blue color in Figure 1
  380. is the area that is not drawn by the frame types.
  381. \image html boxtypes.png "Figure 1: FLTK standard box types"
  382. \image latex boxtypes.png "FLTK standard box types" width=10cm
  383. \todo Description of boxtypes is incomplete.
  384. See below for the defined enum Fl_Boxtype.
  385. \see src/Fl_get_system_colors.cxx
  386. */
  387. /*@{*/
  388. enum Fl_Boxtype { // boxtypes (if you change these you must fix fl_boxtype.C):
  389. FL_NO_BOX = 0, ///< nothing is drawn at all, this box is invisible
  390. FL_FLAT_BOX, ///< a flat box
  391. FL_UP_BOX, ///< see figure 1
  392. FL_DOWN_BOX, ///< see figure 1
  393. FL_UP_FRAME, ///< see figure 1
  394. FL_DOWN_FRAME, ///< see figure 1
  395. FL_THIN_UP_BOX, ///< see figure 1
  396. FL_THIN_DOWN_BOX, ///< see figure 1
  397. FL_THIN_UP_FRAME, ///< see figure 1
  398. FL_THIN_DOWN_FRAME, ///< see figure 1
  399. FL_ENGRAVED_BOX, ///< see figure 1
  400. FL_EMBOSSED_BOX, ///< see figure 1
  401. FL_ENGRAVED_FRAME, ///< see figure 1
  402. FL_EMBOSSED_FRAME, ///< see figure 1
  403. FL_BORDER_BOX, ///< see figure 1
  404. _FL_SHADOW_BOX, ///< see figure 1
  405. FL_BORDER_FRAME, ///< see figure 1
  406. _FL_SHADOW_FRAME, ///< see figure 1
  407. _FL_ROUNDED_BOX, ///< see figure 1
  408. _FL_RSHADOW_BOX, ///< see figure 1
  409. _FL_ROUNDED_FRAME, ///< see figure 1
  410. _FL_RFLAT_BOX, ///< see figure 1
  411. _FL_ROUND_UP_BOX, ///< see figure 1
  412. _FL_ROUND_DOWN_BOX, ///< see figure 1
  413. _FL_DIAMOND_UP_BOX, ///< see figure 1
  414. _FL_DIAMOND_DOWN_BOX, ///< see figure 1
  415. _FL_OVAL_BOX, ///< see figure 1
  416. _FL_OSHADOW_BOX, ///< see figure 1
  417. _FL_OVAL_FRAME, ///< see figure 1
  418. _FL_OFLAT_BOX, ///< see figure 1
  419. _FL_PLASTIC_UP_BOX, ///< plastic version of FL_UP_BOX
  420. _FL_PLASTIC_DOWN_BOX, ///< plastic version of FL_DOWN_BOX
  421. _FL_PLASTIC_UP_FRAME, ///< plastic version of FL_UP_FRAME
  422. _FL_PLASTIC_DOWN_FRAME, ///< plastic version of FL_DOWN_FRAME
  423. _FL_PLASTIC_THIN_UP_BOX, ///< plastic version of FL_THIN_UP_BOX
  424. _FL_PLASTIC_THIN_DOWN_BOX, ///< plastic version of FL_THIN_DOWN_BOX
  425. _FL_PLASTIC_ROUND_UP_BOX, ///< plastic version of FL_ROUND_UP_BOX
  426. _FL_PLASTIC_ROUND_DOWN_BOX, ///< plastic version of FL_ROUND_DOWN_BOX
  427. _FL_GTK_UP_BOX, ///< gtk+ version of FL_UP_BOX
  428. _FL_GTK_DOWN_BOX, ///< gtk+ version of FL_DOWN_BOX
  429. _FL_GTK_UP_FRAME, ///< gtk+ version of FL_UP_FRAME
  430. _FL_GTK_DOWN_FRAME, ///< gtk+ version of FL_DOWN_RAME
  431. _FL_GTK_THIN_UP_BOX, ///< gtk+ version of FL_THIN_UP_BOX
  432. _FL_GTK_THIN_DOWN_BOX, ///< gtk+ version of FL_THIN_DOWN_BOX
  433. _FL_GTK_THIN_UP_FRAME, ///< gtk+ version of FL_UP_FRAME
  434. _FL_GTK_THIN_DOWN_FRAME, ///< gtk+ version of FL_THIN_DOWN_FRAME
  435. _FL_GTK_ROUND_UP_BOX, ///< gtk+ version of FL_ROUND_UP_BOX
  436. _FL_GTK_ROUND_DOWN_BOX, ///< gtk+ version of FL_ROUND_DOWN_BOX
  437. _FL_GLEAM_UP_BOX, ///< gleam version of FL_GLEAM_UP_BOX
  438. _FL_GLEAM_DOWN_BOX, ///< gleam version of FL_GLEAM_DOWN_BOX
  439. _FL_GLEAM_UP_FRAME, ///< gleam version of FL_GLEAM_UP_FRAME
  440. _FL_GLEAM_DOWN_FRAME, ///< gleam version of FL_GLEAM_DOWN_FRAME
  441. _FL_GLEAM_THIN_UP_BOX, ///< gleam version of FL_GLEAM_THIN_UP_BOX
  442. _FL_GLEAM_THIN_DOWN_BOX, ///< gleam version of FL_GLEAM_THIN_DOWN_BOX
  443. _FL_GLEAM_ROUND_UP_BOX, ///< gleam version of FL_GLEAM_ROUND_UP_BOX
  444. _FL_GLEAM_ROUND_DOWN_BOX, ///< gleam version of FL_GLEAM_ROUND_DOWN_BOX
  445. FL_FREE_BOXTYPE ///< the first free box type for creation of new box types
  446. };
  447. extern FL_EXPORT Fl_Boxtype fl_define_FL_ROUND_UP_BOX();
  448. #define FL_ROUND_UP_BOX fl_define_FL_ROUND_UP_BOX()
  449. #define FL_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_ROUND_UP_BOX()+1)
  450. extern FL_EXPORT Fl_Boxtype fl_define_FL_SHADOW_BOX();
  451. #define FL_SHADOW_BOX fl_define_FL_SHADOW_BOX()
  452. #define FL_SHADOW_FRAME (Fl_Boxtype)(fl_define_FL_SHADOW_BOX()+2)
  453. extern FL_EXPORT Fl_Boxtype fl_define_FL_ROUNDED_BOX();
  454. #define FL_ROUNDED_BOX fl_define_FL_ROUNDED_BOX()
  455. #define FL_ROUNDED_FRAME (Fl_Boxtype)(fl_define_FL_ROUNDED_BOX()+2)
  456. extern FL_EXPORT Fl_Boxtype fl_define_FL_RFLAT_BOX();
  457. #define FL_RFLAT_BOX fl_define_FL_RFLAT_BOX()
  458. extern FL_EXPORT Fl_Boxtype fl_define_FL_RSHADOW_BOX();
  459. #define FL_RSHADOW_BOX fl_define_FL_RSHADOW_BOX()
  460. extern FL_EXPORT Fl_Boxtype fl_define_FL_DIAMOND_BOX();
  461. #define FL_DIAMOND_UP_BOX fl_define_FL_DIAMOND_BOX()
  462. #define FL_DIAMOND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_DIAMOND_BOX()+1)
  463. extern FL_EXPORT Fl_Boxtype fl_define_FL_OVAL_BOX();
  464. #define FL_OVAL_BOX fl_define_FL_OVAL_BOX()
  465. #define FL_OSHADOW_BOX (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+1)
  466. #define FL_OVAL_FRAME (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+2)
  467. #define FL_OFLAT_BOX (Fl_Boxtype)(fl_define_FL_OVAL_BOX()+3)
  468. extern FL_EXPORT Fl_Boxtype fl_define_FL_PLASTIC_UP_BOX();
  469. #define FL_PLASTIC_UP_BOX fl_define_FL_PLASTIC_UP_BOX()
  470. #define FL_PLASTIC_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+1)
  471. #define FL_PLASTIC_UP_FRAME (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+2)
  472. #define FL_PLASTIC_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+3)
  473. #define FL_PLASTIC_THIN_UP_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+4)
  474. #define FL_PLASTIC_THIN_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+5)
  475. #define FL_PLASTIC_ROUND_UP_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+6)
  476. #define FL_PLASTIC_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_PLASTIC_UP_BOX()+7)
  477. extern FL_EXPORT Fl_Boxtype fl_define_FL_GTK_UP_BOX();
  478. #define FL_GTK_UP_BOX fl_define_FL_GTK_UP_BOX()
  479. #define FL_GTK_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+1)
  480. #define FL_GTK_UP_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+2)
  481. #define FL_GTK_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+3)
  482. #define FL_GTK_THIN_UP_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+4)
  483. #define FL_GTK_THIN_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+5)
  484. #define FL_GTK_THIN_UP_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+6)
  485. #define FL_GTK_THIN_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+7)
  486. #define FL_GTK_ROUND_UP_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+8)
  487. #define FL_GTK_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GTK_UP_BOX()+9)
  488. extern FL_EXPORT Fl_Boxtype fl_define_FL_GLEAM_UP_BOX();
  489. #define FL_GLEAM_UP_BOX fl_define_FL_GLEAM_UP_BOX()
  490. #define FL_GLEAM_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+1)
  491. #define FL_GLEAM_UP_FRAME (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+2)
  492. #define FL_GLEAM_DOWN_FRAME (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+3)
  493. #define FL_GLEAM_THIN_UP_BOX (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+4)
  494. #define FL_GLEAM_THIN_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+5)
  495. #define FL_GLEAM_ROUND_UP_BOX (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+6)
  496. #define FL_GLEAM_ROUND_DOWN_BOX (Fl_Boxtype)(fl_define_FL_GLEAM_UP_BOX()+7)
  497. // conversions of box types to other boxtypes:
  498. /**
  499. Get the filled version of a frame.
  500. If no filled version of a given frame exists, the behavior of this function
  501. is undefined and some random box or frame is returned.
  502. */
  503. inline Fl_Boxtype fl_box(Fl_Boxtype b) {
  504. return (Fl_Boxtype)((b<FL_UP_BOX||b%4>1)?b:(b-2));
  505. }
  506. /**
  507. Get the "pressed" or "down" version of a box.
  508. If no "down" version of a given box exists, the behavior of this function
  509. is undefined and some random box or frame is returned.
  510. */
  511. inline Fl_Boxtype fl_down(Fl_Boxtype b) {
  512. return (Fl_Boxtype)((b<FL_UP_BOX)?b:(b|1));
  513. }
  514. /**
  515. Get the unfilled, frame only version of a box.
  516. If no frame version of a given box exists, the behavior of this function
  517. is undefined and some random box or frame is returned.
  518. */
  519. inline Fl_Boxtype fl_frame(Fl_Boxtype b) {
  520. return (Fl_Boxtype)((b%4<2)?b:(b+2));
  521. }
  522. // back-compatibility box types:
  523. #define FL_FRAME FL_ENGRAVED_FRAME
  524. #define FL_FRAME_BOX FL_ENGRAVED_BOX
  525. #define FL_CIRCLE_BOX FL_ROUND_DOWN_BOX
  526. #define FL_DIAMOND_BOX FL_DIAMOND_DOWN_BOX
  527. /*@}*/ // group: Box Types
  528. /**
  529. The labeltype() method sets the type of the label.
  530. The following standard label types are included:
  531. \todo The doxygen comments are incomplete, and some labeltypes
  532. are starting with an underscore. Also, there are three
  533. external functions undocumented (yet):
  534. - fl_define_FL_SHADOW_LABEL()
  535. - fl_define_FL_ENGRAVED_LABEL()
  536. - fl_define_FL_EMBOSSED_LABEL()
  537. */
  538. enum Fl_Labeltype { // labeltypes:
  539. FL_NORMAL_LABEL = 0, ///< draws the text (0)
  540. FL_NO_LABEL, ///< does nothing
  541. _FL_SHADOW_LABEL, ///< draws a drop shadow under the text
  542. _FL_ENGRAVED_LABEL, ///< draws edges as though the text is engraved
  543. _FL_EMBOSSED_LABEL, ///< draws edges as though the text is raised
  544. _FL_MULTI_LABEL, ///< ?
  545. _FL_ICON_LABEL, ///< draws the icon associated with the text
  546. _FL_IMAGE_LABEL, ///< ?
  547. FL_FREE_LABELTYPE ///< first free labeltype to use for creating own labeltypes
  548. };
  549. /**
  550. Sets the current label type and return its corresponding Fl_Labeltype value.
  551. @{
  552. */
  553. #define FL_SYMBOL_LABEL FL_NORMAL_LABEL
  554. extern Fl_Labeltype FL_EXPORT fl_define_FL_SHADOW_LABEL();
  555. #define FL_SHADOW_LABEL fl_define_FL_SHADOW_LABEL()
  556. extern Fl_Labeltype FL_EXPORT fl_define_FL_ENGRAVED_LABEL();
  557. #define FL_ENGRAVED_LABEL fl_define_FL_ENGRAVED_LABEL()
  558. extern Fl_Labeltype FL_EXPORT fl_define_FL_EMBOSSED_LABEL();
  559. #define FL_EMBOSSED_LABEL fl_define_FL_EMBOSSED_LABEL()
  560. /** @} */
  561. /** \name Alignment Flags
  562. Flags to control the label alignment.
  563. This controls how the label is displayed next to or inside the widget.
  564. The default value is FL_ALIGN_CENTER for most widgets, which centers the label
  565. inside the widget.
  566. Flags can be or'd to achieve a combination of alignments.
  567. \code
  568. Outside alignments:
  569. TOP_LEFT TOP TOP_RIGHT
  570. LEFT_TOP+---------------------------------+RIGHT_TOP
  571. | |
  572. LEFT| |RIGHT
  573. | |
  574. LEFT_BOTTOM+---------------------------------+RIGHT_BOTTOM
  575. BOTTOM_RIGHT BOTTOM BOTTOM_LEFT
  576. Inside alignments:
  577. +---------------------------------+
  578. |TOP_LEFT TOP TOP_RIGHT|
  579. | |
  580. |LEFT RIGHT|
  581. | |
  582. |BOTTOM_RIGHT BOTTOM BOTTOM_LEFT|
  583. +---------------------------------+
  584. \endcode
  585. \see #FL_ALIGN_CENTER, etc.
  586. */
  587. /*@{*/
  588. /** FLTK type for alignment control */
  589. typedef unsigned Fl_Align;
  590. /** Align the label horizontally in the middle. */
  591. const Fl_Align FL_ALIGN_CENTER = (Fl_Align)0;
  592. /** Align the label at the top of the widget. Inside labels appear below the top,
  593. outside labels are drawn on top of the widget. */
  594. const Fl_Align FL_ALIGN_TOP = (Fl_Align)1;
  595. /** Align the label at the bottom of the widget. */
  596. const Fl_Align FL_ALIGN_BOTTOM = (Fl_Align)2;
  597. /** Align the label at the left of the widget. Inside labels appear left-justified
  598. starting at the left side of the widget, outside labels are right-justified and
  599. drawn to the left of the widget. */
  600. const Fl_Align FL_ALIGN_LEFT = (Fl_Align)4;
  601. /** Align the label to the right of the widget. */
  602. const Fl_Align FL_ALIGN_RIGHT = (Fl_Align)8;
  603. /** Draw the label inside of the widget. */
  604. const Fl_Align FL_ALIGN_INSIDE = (Fl_Align)16;
  605. /** If the label contains an image, draw the text on top of the image. */
  606. const Fl_Align FL_ALIGN_TEXT_OVER_IMAGE = (Fl_Align)0x0020;
  607. /** If the label contains an image, draw the text below the image. */
  608. const Fl_Align FL_ALIGN_IMAGE_OVER_TEXT = (Fl_Align)0x0000;
  609. /** All parts of the label that are lager than the widget will not be drawn . */
  610. const Fl_Align FL_ALIGN_CLIP = (Fl_Align)64;
  611. /** Wrap text that does not fit the width of the widget. */
  612. const Fl_Align FL_ALIGN_WRAP = (Fl_Align)128;
  613. /** If the label contains an image, draw the text to the right of the image. */
  614. const Fl_Align FL_ALIGN_IMAGE_NEXT_TO_TEXT = (Fl_Align)0x0100;
  615. /** If the label contains an image, draw the text to the left of the image. */
  616. const Fl_Align FL_ALIGN_TEXT_NEXT_TO_IMAGE = (Fl_Align)0x0120;
  617. /** If the label contains an image, draw the image or deimage in the background. */
  618. const Fl_Align FL_ALIGN_IMAGE_BACKDROP = (Fl_Align)0x0200;
  619. const Fl_Align FL_ALIGN_TOP_LEFT = FL_ALIGN_TOP | FL_ALIGN_LEFT;
  620. const Fl_Align FL_ALIGN_TOP_RIGHT = FL_ALIGN_TOP | FL_ALIGN_RIGHT;
  621. const Fl_Align FL_ALIGN_BOTTOM_LEFT = FL_ALIGN_BOTTOM | FL_ALIGN_LEFT;
  622. const Fl_Align FL_ALIGN_BOTTOM_RIGHT = FL_ALIGN_BOTTOM | FL_ALIGN_RIGHT;
  623. const Fl_Align FL_ALIGN_LEFT_TOP = 0x0007; // magic value
  624. const Fl_Align FL_ALIGN_RIGHT_TOP = 0x000b; // magic value
  625. const Fl_Align FL_ALIGN_LEFT_BOTTOM = 0x000d; // magic value
  626. const Fl_Align FL_ALIGN_RIGHT_BOTTOM = 0x000e; // magic value
  627. const Fl_Align FL_ALIGN_NOWRAP = (Fl_Align)0; // for back compatibility
  628. const Fl_Align FL_ALIGN_POSITION_MASK = 0x000f; // left, right, top, bottom
  629. const Fl_Align FL_ALIGN_IMAGE_MASK = 0x0320; // l/r, t/b, backdrop
  630. /*@}*/
  631. /** \name Font Numbers
  632. The following constants define the standard FLTK fonts:
  633. */
  634. /*@{*/
  635. /** A font number is an index into the internal font table. */
  636. typedef int Fl_Font;
  637. const Fl_Font FL_HELVETICA = 0; ///< Helvetica (or Arial) normal (0)
  638. const Fl_Font FL_HELVETICA_BOLD = 1; ///< Helvetica (or Arial) bold
  639. const Fl_Font FL_HELVETICA_ITALIC = 2; ///< Helvetica (or Arial) oblique
  640. const Fl_Font FL_HELVETICA_BOLD_ITALIC = 3; ///< Helvetica (or Arial) bold-oblique
  641. const Fl_Font FL_COURIER = 4; ///< Courier normal
  642. const Fl_Font FL_COURIER_BOLD = 5; ///< Courier bold
  643. const Fl_Font FL_COURIER_ITALIC = 6; ///< Courier italic
  644. const Fl_Font FL_COURIER_BOLD_ITALIC = 7; ///< Courier bold-italic
  645. const Fl_Font FL_TIMES = 8; ///< Times roman
  646. const Fl_Font FL_TIMES_BOLD = 9; ///< Times roman bold
  647. const Fl_Font FL_TIMES_ITALIC = 10; ///< Times roman italic
  648. const Fl_Font FL_TIMES_BOLD_ITALIC = 11; ///< Times roman bold-italic
  649. const Fl_Font FL_SYMBOL = 12; ///< Standard symbol font
  650. const Fl_Font FL_SCREEN = 13; ///< Default monospaced screen font
  651. const Fl_Font FL_SCREEN_BOLD = 14; ///< Default monospaced bold screen font
  652. const Fl_Font FL_ZAPF_DINGBATS = 15; ///< Zapf-dingbats font
  653. const Fl_Font FL_FREE_FONT = 16; ///< first one to allocate
  654. const Fl_Font FL_BOLD = 1; ///< add this to helvetica, courier, or times
  655. const Fl_Font FL_ITALIC = 2; ///< add this to helvetica, courier, or times
  656. const Fl_Font FL_BOLD_ITALIC = 3; ///< add this to helvetica, courier, or times
  657. /*@}*/
  658. /** Size of a font in pixels.
  659. This is the approximate height of a font in pixels.
  660. */
  661. typedef int Fl_Fontsize;
  662. extern FL_EXPORT Fl_Fontsize FL_NORMAL_SIZE; ///< normal font size
  663. /** \name Colors
  664. The Fl_Color type holds an FLTK color value.
  665. Colors are either 8-bit indexes into a virtual colormap
  666. or 24-bit RGB color values. (See \ref drawing_colors for the default FLTK colormap)
  667. Color indices occupy the lower 8 bits of the value, while
  668. RGB colors occupy the upper 24 bits, for a byte organization of RGBI.
  669. <pre>
  670. Fl_Color => 0xrrggbbii
  671. | | | |
  672. | | | +--- \ref drawing_colors "index" between 0 and 255
  673. | | +----- blue color component (8 bit)
  674. | +------- green component (8 bit)
  675. +--------- red component (8 bit)
  676. </pre>
  677. A color can have either an index or an rgb value. Colors with rgb set
  678. and an index >0 are reserved for special use.
  679. */
  680. /*@{*/
  681. /** An FLTK color value; see also \ref drawing_colors */
  682. typedef unsigned int Fl_Color;
  683. // Standard colors. These are used as default colors in widgets and altered as necessary
  684. const Fl_Color FL_FOREGROUND_COLOR = 0; ///< the default foreground color (0) used for labels and text
  685. const Fl_Color FL_BACKGROUND2_COLOR = 7; ///< the default background color for text, list, and valuator widgets
  686. const Fl_Color FL_INACTIVE_COLOR = 8; ///< the inactive foreground color
  687. const Fl_Color FL_SELECTION_COLOR = 15; ///< the default selection/highlight color
  688. // boxtypes generally limit themselves to these colors so
  689. // the whole ramp is not allocated:
  690. const Fl_Color FL_GRAY0 = 32; // 'A'
  691. const Fl_Color FL_DARK3 = 39; // 'H'
  692. const Fl_Color FL_DARK2 = 45; // 'N'
  693. const Fl_Color FL_DARK1 = 47; // 'P'
  694. const Fl_Color FL_BACKGROUND_COLOR = 49; // 'R' default background color
  695. const Fl_Color FL_LIGHT1 = 50; // 'S'
  696. const Fl_Color FL_LIGHT2 = 52; // 'U'
  697. const Fl_Color FL_LIGHT3 = 54; // 'W'
  698. // FLTK provides a 5x8x5 color cube that is used with colormap visuals
  699. const Fl_Color FL_BLACK = 56;
  700. const Fl_Color FL_RED = 88;
  701. const Fl_Color FL_GREEN = 63;
  702. const Fl_Color FL_YELLOW = 95;
  703. const Fl_Color FL_BLUE = 216;
  704. const Fl_Color FL_MAGENTA = 248;
  705. const Fl_Color FL_CYAN = 223;
  706. const Fl_Color FL_DARK_RED = 72;
  707. const Fl_Color FL_DARK_GREEN = 60;
  708. const Fl_Color FL_DARK_YELLOW = 76;
  709. const Fl_Color FL_DARK_BLUE = 136;
  710. const Fl_Color FL_DARK_MAGENTA = 152;
  711. const Fl_Color FL_DARK_CYAN = 140;
  712. const Fl_Color FL_WHITE = 255;
  713. #define FL_FREE_COLOR (Fl_Color)16
  714. #define FL_NUM_FREE_COLOR 16
  715. #define FL_GRAY_RAMP (Fl_Color)32
  716. #define FL_NUM_GRAY 24
  717. #define FL_GRAY FL_BACKGROUND_COLOR
  718. #define FL_COLOR_CUBE (Fl_Color)56
  719. #define FL_NUM_RED 5
  720. #define FL_NUM_GREEN 8
  721. #define FL_NUM_BLUE 5
  722. FL_EXPORT Fl_Color fl_inactive(Fl_Color c);
  723. FL_EXPORT Fl_Color fl_contrast(Fl_Color fg, Fl_Color bg);
  724. FL_EXPORT Fl_Color fl_color_average(Fl_Color c1, Fl_Color c2, float weight);
  725. /** Returns a lighter version of the specified color. */
  726. inline Fl_Color fl_lighter(Fl_Color c) { return fl_color_average(c, FL_WHITE, .67f); }
  727. /** Returns a darker version of the specified color. */
  728. inline Fl_Color fl_darker(Fl_Color c) { return fl_color_average(c, FL_BLACK, .67f); }
  729. /** Returns the 24-bit color value closest to \p r, \p g, \p b. */
  730. inline Fl_Color fl_rgb_color(uchar r, uchar g, uchar b) {
  731. if (!r && !g && !b) return FL_BLACK;
  732. else return (Fl_Color)(((((r << 8) | g) << 8) | b) << 8);
  733. }
  734. /** Returns the 24-bit color value closest to \p g (grayscale). */
  735. inline Fl_Color fl_rgb_color(uchar g) {
  736. if (!g) return FL_BLACK;
  737. else return (Fl_Color)(((((g << 8) | g) << 8) | g) << 8);
  738. }
  739. /** Returns a gray color value from black (i == 0) to white (i == FL_NUM_GRAY - 1).
  740. FL_NUM_GRAY is defined to be 24 in the current FLTK release.
  741. To get the closest FLTK gray value to an 8-bit grayscale color 'I' use:
  742. \code
  743. fl_gray_ramp(I * (FL_NUM_GRAY - 1) / 255)
  744. \endcode
  745. */
  746. inline Fl_Color fl_gray_ramp(int i) {return (Fl_Color)(i+FL_GRAY_RAMP);}
  747. /** Returns a color out of the color cube.
  748. \p r must be in the range 0 to FL_NUM_RED (5) minus 1,
  749. \p g must be in the range 0 to FL_NUM_GREEN (8) minus 1,
  750. \p b must be in the range 0 to FL_NUM_BLUE (5) minus 1.
  751. To get the closest color to a 8-bit set of R,G,B values use:
  752. \code
  753. fl_color_cube(R * (FL_NUM_RED - 1) / 255,
  754. G * (FL_NUM_GREEN - 1) / 255,
  755. B * (FL_NUM_BLUE - 1) / 255);
  756. \endcode
  757. */
  758. inline Fl_Color fl_color_cube(int r, int g, int b) {
  759. return (Fl_Color)((b*FL_NUM_RED + r) * FL_NUM_GREEN + g + FL_COLOR_CUBE);}
  760. /*@}*/ // group: Colors
  761. /** \name Cursors */
  762. /*@{*/
  763. /** The following constants define the mouse cursors that are available in FLTK.
  764. The double-headed arrows are bitmaps provided by FLTK on X, the others
  765. are provided by system-defined cursors.
  766. \todo enum Fl_Cursor needs maybe an image.
  767. */
  768. enum Fl_Cursor {
  769. FL_CURSOR_DEFAULT = 0, /**< the default cursor, usually an arrow. */
  770. FL_CURSOR_ARROW = 35, /**< an arrow pointer. */
  771. FL_CURSOR_CROSS = 66, /**< crosshair. */
  772. FL_CURSOR_WAIT = 76, /**< watch or hourglass. */
  773. FL_CURSOR_INSERT = 77, /**< I-beam. */
  774. FL_CURSOR_HAND = 31, /**< hand (uparrow on MSWindows). */
  775. FL_CURSOR_HELP = 47, /**< question mark. */
  776. FL_CURSOR_MOVE = 27, /**< 4-pointed arrow. */
  777. // fltk provides bitmaps for these:
  778. FL_CURSOR_NS = 78, /**< up/down arrow. */
  779. FL_CURSOR_WE = 79, /**< left/right arrow. */
  780. FL_CURSOR_NWSE = 80, /**< diagonal arrow. */
  781. FL_CURSOR_NESW = 81, /**< diagonal arrow. */
  782. FL_CURSOR_NONE =255, /**< invisible. */
  783. // for back compatibility (non MSWindows ones):
  784. FL_CURSOR_N = 70, /**< for back compatibility. */
  785. FL_CURSOR_NE = 69, /**< for back compatibility. */
  786. FL_CURSOR_E = 49, /**< for back compatibility. */
  787. FL_CURSOR_SE = 8, /**< for back compatibility. */
  788. FL_CURSOR_S = 9, /**< for back compatibility. */
  789. FL_CURSOR_SW = 7, /**< for back compatibility. */
  790. FL_CURSOR_W = 36, /**< for back compatibility. */
  791. FL_CURSOR_NW = 68 /**< for back compatibility. */
  792. };
  793. /*@}*/ // group: Cursors
  794. /** FD "when" conditions */
  795. enum { // values for "when" passed to Fl::add_fd()
  796. FL_READ = 1, /**< Call the callback when there is data to be read. */
  797. FL_WRITE = 4, /**< Call the callback when data can be written without blocking. */
  798. FL_EXCEPT = 8 /**< Call the callback if an exception occurs on the file. */
  799. };
  800. /** visual types and Fl_Gl_Window::mode() (values match Glut) */
  801. enum Fl_Mode {
  802. FL_RGB = 0,
  803. FL_INDEX = 1,
  804. FL_SINGLE = 0,
  805. FL_DOUBLE = 2,
  806. FL_ACCUM = 4,
  807. FL_ALPHA = 8,
  808. FL_DEPTH = 16,
  809. FL_STENCIL = 32,
  810. FL_RGB8 = 64,
  811. FL_MULTISAMPLE= 128,
  812. FL_STEREO = 256,
  813. FL_FAKE_SINGLE = 512 // Fake single buffered windows using double-buffer
  814. };
  815. // image alpha blending
  816. #define FL_IMAGE_WITH_ALPHA 0x40000000
  817. /** Damage masks */
  818. enum Fl_Damage {
  819. FL_DAMAGE_CHILD = 0x01, /**< A child needs to be redrawn. */
  820. FL_DAMAGE_EXPOSE = 0x02, /**< The window was exposed. */
  821. FL_DAMAGE_SCROLL = 0x04, /**< The Fl_Scroll widget was scrolled. */
  822. FL_DAMAGE_OVERLAY = 0x08, /**< The overlay planes need to be redrawn. */
  823. FL_DAMAGE_USER1 = 0x10, /**< First user-defined damage bit. */
  824. FL_DAMAGE_USER2 = 0x20, /**< Second user-defined damage bit. */
  825. FL_DAMAGE_ALL = 0x80 /**< Everything needs to be redrawn. */
  826. };
  827. // FLTK 1.0.x compatibility definitions...
  828. # ifdef FLTK_1_0_COMPAT
  829. # define contrast fl_contrast
  830. # define down fl_down
  831. # define frame fl_frame
  832. # define inactive fl_inactive
  833. # endif // FLTK_1_0_COMPAT
  834. /*!
  835. Values of the bits stored in Fl_Widget::layout_damage().
  836. When a widget resized or moved (or when it is initially created),
  837. flags are set in Fl_Widget::layout_damage() to indicate the layout is
  838. damaged. This will cause the virtual function Fl_Widget::layout() to be
  839. called just before fltk attempts to draw the windows on the screen.
  840. This is useful because often calculating the new layout is quite
  841. expensive, this expense is now deferred until the user will actually
  842. see the new size.
  843. Some Group widgets such as Fl_Pack will also use the
  844. virtual Fl_Widget::layout() function to find out how big a widget
  845. should be. A Fl_Widget is allowed to change it's own dimensions in
  846. layout() (except it is not allowed to change it if called a second
  847. time with no changes other than it's x/y position). This allows
  848. widgets to resize to fit their contents.
  849. The layout bits are turned on by calling Fl_Widget::relayout().
  850. */
  851. enum Fl_Layout {
  852. FL_LAYOUT_X = 0x01, /*!< Fl_Widget::x() changed by resize() */
  853. FL_LAYOUT_Y = 0x02, /*!< Fl_Widget::y() changed by resize() */
  854. FL_LAYOUT_XY = 0x03, /*!< Same as FL_LAYOUT_X|FL_LAYOUT_Y */
  855. FL_LAYOUT_W = 0x04, /*!< Fl_Widget::w() changed by resize() */
  856. FL_LAYOUT_H = 0x08, /*!< Fl_Widget::h() changed by resize() */
  857. FL_LAYOUT_WH = 0x0C, /*!< Same as FL_LAYOUT_W|FL_LAYOUT_H */
  858. FL_LAYOUT_XYWH = 0x0F, /*!< Same as FL_LAYOUT_XY|FL_LAYOUT_WH */
  859. FL_LAYOUT_CHILD = 0x10, /*!< Fl_Widget::layout() needs to be called on a child of this group widget. */
  860. FL_LAYOUT_USER = 0x20, /*!< The moving/resizing is being caused by the user and not internal code. */
  861. FL_LAYOUT_DAMAGE = 0x80 /*!< Fl_Widget::relayout() was called. */
  862. };
  863. #endif
  864. //
  865. // End of "$Id: Enumerations.H 10113 2014-02-25 04:24:41Z greg.ercolano $".
  866. //