fxruby 1.6.22 → 1.6.23

Sign up to get free protection for your applications and to get access to all the features.
Files changed (201) hide show
  1. data/.gitignore +14 -0
  2. data/.yardopts +8 -0
  3. data/History.txt +6 -0
  4. data/Manifest.txt +317 -24
  5. data/README.git +3 -0
  6. data/README.rdoc +537 -0
  7. data/Rakefile +62 -46
  8. data/Rakefile.cross +397 -0
  9. data/doap.rdf +3 -3
  10. data/doap.rdf.erb +87 -0
  11. data/examples/WhatAQuietStiff.rb +356 -0
  12. data/examples/canvasdemo.rb +88 -0
  13. data/examples/gdchart.rb +76 -0
  14. data/examples/gembrowser.rb +289 -0
  15. data/examples/rmagick.rb +44 -0
  16. data/lib/fox16/canvas.rb +606 -0
  17. data/lib/fox16/irb.rb +1 -0
  18. data/lib/fox16/splashscreen.rb +1 -0
  19. data/lib/fox16/tkcompat.rb +56 -0
  20. data/lib/fox16/version.rb +1 -1
  21. data/rdoc-sources/FX4Splitter.rb +44 -44
  22. data/rdoc-sources/FX7Segment.rb +3 -3
  23. data/rdoc-sources/FXAccelTable.rb +1 -1
  24. data/rdoc-sources/FXApp.rb +51 -51
  25. data/rdoc-sources/FXArrowButton.rb +6 -6
  26. data/rdoc-sources/FXBMPIcon.rb +12 -12
  27. data/rdoc-sources/FXBMPImage.rb +6 -6
  28. data/rdoc-sources/FXBitmap.rb +9 -9
  29. data/rdoc-sources/FXBitmapFrame.rb +3 -3
  30. data/rdoc-sources/FXBitmapView.rb +12 -12
  31. data/rdoc-sources/FXButton.rb +5 -5
  32. data/rdoc-sources/FXCanvas.rb +4 -4
  33. data/rdoc-sources/FXCheckButton.rb +7 -7
  34. data/rdoc-sources/FXChoiceBox.rb +16 -16
  35. data/rdoc-sources/FXColorBar.rb +9 -9
  36. data/rdoc-sources/FXColorDialog.rb +4 -4
  37. data/rdoc-sources/FXColorList.rb +1 -1
  38. data/rdoc-sources/FXColorRing.rb +4 -4
  39. data/rdoc-sources/FXColorSelector.rb +38 -38
  40. data/rdoc-sources/FXColorWell.rb +15 -15
  41. data/rdoc-sources/FXColorWheel.rb +8 -8
  42. data/rdoc-sources/FXComboBox.rb +24 -24
  43. data/rdoc-sources/FXCursor.rb +12 -12
  44. data/rdoc-sources/FXDC.rb +176 -176
  45. data/rdoc-sources/FXDCPrint.rb +20 -20
  46. data/rdoc-sources/FXDCWindow.rb +2 -2
  47. data/rdoc-sources/FXDataTarget.rb +1 -1
  48. data/rdoc-sources/FXDebugTarget.rb +1 -1
  49. data/rdoc-sources/FXDelegator.rb +2 -2
  50. data/rdoc-sources/FXDial.rb +9 -9
  51. data/rdoc-sources/FXDialogBox.rb +3 -3
  52. data/rdoc-sources/FXDict.rb +2 -3
  53. data/rdoc-sources/FXDirBox.rb +2 -2
  54. data/rdoc-sources/FXDirList.rb +14 -14
  55. data/rdoc-sources/FXDirSelector.rb +14 -14
  56. data/rdoc-sources/FXDockBar.rb +35 -35
  57. data/rdoc-sources/FXDockHandler.rb +2 -2
  58. data/rdoc-sources/FXDockSite.rb +11 -11
  59. data/rdoc-sources/FXDockTitle.rb +2 -2
  60. data/rdoc-sources/FXDocument.rb +2 -2
  61. data/rdoc-sources/FXDragCorner.rb +2 -2
  62. data/rdoc-sources/FXDrawable.rb +5 -5
  63. data/rdoc-sources/FXDriveBox.rb +3 -3
  64. data/rdoc-sources/FXFileDialog.rb +24 -24
  65. data/rdoc-sources/FXFileDict.rb +11 -11
  66. data/rdoc-sources/FXFileList.rb +25 -25
  67. data/rdoc-sources/FXFileSelector.rb +31 -31
  68. data/rdoc-sources/FXFileStream.rb +3 -3
  69. data/rdoc-sources/FXFoldingList.rb +76 -76
  70. data/rdoc-sources/FXFont.rb +133 -133
  71. data/rdoc-sources/FXFontDialog.rb +1 -1
  72. data/rdoc-sources/FXFontSelector.rb +14 -14
  73. data/rdoc-sources/FXFrame.rb +5 -5
  74. data/rdoc-sources/FXGIFCursor.rb +6 -6
  75. data/rdoc-sources/FXGIFIcon.rb +6 -6
  76. data/rdoc-sources/FXGIFImage.rb +5 -5
  77. data/rdoc-sources/FXGLContext.rb +1 -1
  78. data/rdoc-sources/FXGLObject.rb +8 -8
  79. data/rdoc-sources/FXGLShape.rb +23 -23
  80. data/rdoc-sources/FXGLViewer.rb +51 -51
  81. data/rdoc-sources/FXGLVisual.rb +1 -0
  82. data/rdoc-sources/FXGradientBar.rb +31 -31
  83. data/rdoc-sources/FXGroupBox.rb +6 -6
  84. data/rdoc-sources/FXHeader.rb +30 -33
  85. data/rdoc-sources/FXHorizontalFrame.rb +12 -12
  86. data/rdoc-sources/FXICOIcon.rb +14 -14
  87. data/rdoc-sources/FXICOImage.rb +5 -5
  88. data/rdoc-sources/FXIcon.rb +7 -7
  89. data/rdoc-sources/FXIconDict.rb +1 -0
  90. data/rdoc-sources/FXIconList.rb +60 -60
  91. data/rdoc-sources/FXId.rb +1 -1
  92. data/rdoc-sources/FXImage.rb +49 -49
  93. data/rdoc-sources/FXImageFrame.rb +12 -12
  94. data/rdoc-sources/FXImageView.rb +10 -10
  95. data/rdoc-sources/FXInputDialog.rb +4 -4
  96. data/rdoc-sources/FXJPGIcon.rb +13 -13
  97. data/rdoc-sources/FXJPGImage.rb +5 -5
  98. data/rdoc-sources/FXKnob.rb +12 -12
  99. data/rdoc-sources/FXLabel.rb +3 -3
  100. data/rdoc-sources/FXList.rb +31 -31
  101. data/rdoc-sources/FXListBox.rb +7 -7
  102. data/rdoc-sources/FXMDIChild.rb +24 -24
  103. data/rdoc-sources/FXMDIClient.rb +1 -1
  104. data/rdoc-sources/FXMatrix.rb +2 -2
  105. data/rdoc-sources/FXMemoryBuffer.rb +1 -1
  106. data/rdoc-sources/FXMemoryStream.rb +1 -1
  107. data/rdoc-sources/FXMenuButton.rb +20 -19
  108. data/rdoc-sources/FXMenuCaption.rb +9 -9
  109. data/rdoc-sources/FXMenuCascade.rb +1 -1
  110. data/rdoc-sources/FXMenuCheck.rb +2 -2
  111. data/rdoc-sources/FXMenuCommand.rb +1 -1
  112. data/rdoc-sources/FXMenuRadio.rb +2 -2
  113. data/rdoc-sources/FXMenuSeparator.rb +2 -2
  114. data/rdoc-sources/FXMenuTitle.rb +5 -5
  115. data/rdoc-sources/FXMessageBox.rb +16 -16
  116. data/rdoc-sources/FXOptionMenu.rb +14 -14
  117. data/rdoc-sources/FXPCXIcon.rb +12 -12
  118. data/rdoc-sources/FXPCXImage.rb +5 -5
  119. data/rdoc-sources/FXPNGIcon.rb +12 -12
  120. data/rdoc-sources/FXPNGImage.rb +5 -5
  121. data/rdoc-sources/FXPPMIcon.rb +6 -6
  122. data/rdoc-sources/FXPPMImage.rb +5 -5
  123. data/rdoc-sources/FXPacker.rb +4 -4
  124. data/rdoc-sources/FXPopup.rb +5 -5
  125. data/rdoc-sources/FXPrintDialog.rb +21 -21
  126. data/rdoc-sources/FXProgressBar.rb +10 -10
  127. data/rdoc-sources/FXProgressDialog.rb +3 -3
  128. data/rdoc-sources/FXQuatd.rb +19 -19
  129. data/rdoc-sources/FXQuatf.rb +23 -23
  130. data/rdoc-sources/FXRGBIcon.rb +13 -13
  131. data/rdoc-sources/FXRGBImage.rb +5 -5
  132. data/rdoc-sources/FXRadioButton.rb +10 -10
  133. data/rdoc-sources/FXRanged.rb +2 -2
  134. data/rdoc-sources/FXRangef.rb +2 -2
  135. data/rdoc-sources/FXRealSlider.rb +33 -33
  136. data/rdoc-sources/FXRealSpinner.rb +31 -31
  137. data/rdoc-sources/FXRecentFiles.rb +14 -14
  138. data/rdoc-sources/FXRectangle.rb +22 -22
  139. data/rdoc-sources/FXRegistry.rb +3 -3
  140. data/rdoc-sources/FXReplaceDialog.rb +20 -20
  141. data/rdoc-sources/FXRootWindow.rb +2 -2
  142. data/rdoc-sources/FXRuler.rb +28 -28
  143. data/rdoc-sources/FXRulerView.rb +5 -5
  144. data/rdoc-sources/FXScrollArea.rb +27 -27
  145. data/rdoc-sources/FXScrollBar.rb +26 -26
  146. data/rdoc-sources/FXScrollPane.rb +3 -3
  147. data/rdoc-sources/FXScrollWindow.rb +6 -6
  148. data/rdoc-sources/FXSearchDialog.rb +8 -8
  149. data/rdoc-sources/FXSeparator.rb +24 -24
  150. data/rdoc-sources/FXSettings.rb +44 -44
  151. data/rdoc-sources/FXShutter.rb +35 -35
  152. data/rdoc-sources/FXSize.rb +14 -14
  153. data/rdoc-sources/FXSlider.rb +33 -33
  154. data/rdoc-sources/FXSphered.rb +2 -2
  155. data/rdoc-sources/FXSpheref.rb +2 -2
  156. data/rdoc-sources/FXSpinner.rb +30 -30
  157. data/rdoc-sources/FXSplashWindow.rb +5 -5
  158. data/rdoc-sources/FXSplitter.rb +18 -18
  159. data/rdoc-sources/FXSpring.rb +15 -15
  160. data/rdoc-sources/FXStatusBar.rb +14 -14
  161. data/rdoc-sources/FXStatusLine.rb +7 -7
  162. data/rdoc-sources/FXStream.rb +20 -20
  163. data/rdoc-sources/FXSwitcher.rb +23 -23
  164. data/rdoc-sources/FXTGAIcon.rb +12 -12
  165. data/rdoc-sources/FXTGAImage.rb +5 -5
  166. data/rdoc-sources/FXTIFIcon.rb +13 -13
  167. data/rdoc-sources/FXTIFImage.rb +5 -5
  168. data/rdoc-sources/FXTabBar.rb +31 -31
  169. data/rdoc-sources/FXTabBook.rb +13 -13
  170. data/rdoc-sources/FXTabItem.rb +22 -22
  171. data/rdoc-sources/FXTable.rb +148 -148
  172. data/rdoc-sources/FXText.rb +91 -91
  173. data/rdoc-sources/FXTextField.rb +39 -39
  174. data/rdoc-sources/FXToggleButton.rb +32 -32
  175. data/rdoc-sources/FXToolBar.rb +25 -25
  176. data/rdoc-sources/FXToolBarGrip.rb +12 -12
  177. data/rdoc-sources/FXToolBarShell.rb +13 -13
  178. data/rdoc-sources/FXToolBarTab.rb +16 -16
  179. data/rdoc-sources/FXTopWindow.rb +18 -18
  180. data/rdoc-sources/FXTranslator.rb +1 -1
  181. data/rdoc-sources/FXTreeList.rb +66 -66
  182. data/rdoc-sources/FXTreeListBox.rb +20 -20
  183. data/rdoc-sources/FXTriStateButton.rb +23 -23
  184. data/rdoc-sources/FXVec2d.rb +1 -1
  185. data/rdoc-sources/FXVec2f.rb +1 -1
  186. data/rdoc-sources/FXVec3d.rb +1 -1
  187. data/rdoc-sources/FXVec3f.rb +1 -1
  188. data/rdoc-sources/FXVec4d.rb +1 -1
  189. data/rdoc-sources/FXVec4f.rb +1 -1
  190. data/rdoc-sources/FXVerticalFrame.rb +12 -12
  191. data/rdoc-sources/FXVisual.rb +19 -19
  192. data/rdoc-sources/FXWindow.rb +96 -96
  193. data/rdoc-sources/FXWizard.rb +9 -9
  194. data/rdoc-sources/FXXBMIcon.rb +7 -7
  195. data/rdoc-sources/FXXBMImage.rb +6 -6
  196. data/rdoc-sources/FXXPMIcon.rb +13 -13
  197. data/rdoc-sources/FXXPMImage.rb +5 -5
  198. data/rdoc-sources/Makefile +3 -3
  199. metadata +44 -31
  200. data/README +0 -39
  201. data/README.txt +0 -483
@@ -18,19 +18,19 @@ module Fox
18
18
  #
19
19
  # ==== Parameters:
20
20
  #
21
- # +p+:: the "dry dock" window for this tool bar [FXComposite]
22
- # +q+:: the "wet dock" window for this tool bar [FXComposite]
23
- # +opts+:: tool bar options [Integer]
24
- # +x+:: initial x-position [Integer]
25
- # +y+:: initial y-position [Integer]
26
- # +width+:: initial width [Integer]
27
- # +height+:: initial height [Integer]
28
- # +padLeft+:: internal padding on the left side, in pixels [Integer]
29
- # +padRight+:: internal padding on the right side, in pixels [Integer]
30
- # +padTop+:: internal padding on the top side, in pixels [Integer]
31
- # +padBottom+:: internal padding on the bottom side, in pixels [Integer]
32
- # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
33
- # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
21
+ # +p+:: the "dry dock" window for this tool bar {FXComposite}
22
+ # +q+:: the "wet dock" window for this tool bar {FXComposite}
23
+ # +opts+:: tool bar options [Integer]
24
+ # +x+:: initial x-position [Integer]
25
+ # +y+:: initial y-position [Integer]
26
+ # +width+:: initial width [Integer]
27
+ # +height+:: initial height [Integer]
28
+ # +padLeft+:: internal padding on the left side, in pixels [Integer]
29
+ # +padRight+:: internal padding on the right side, in pixels [Integer]
30
+ # +padTop+:: internal padding on the top side, in pixels [Integer]
31
+ # +padBottom+:: internal padding on the bottom side, in pixels [Integer]
32
+ # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
33
+ # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
34
34
  #
35
35
  def initialize(p, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theToolBar
36
36
  end
@@ -41,18 +41,18 @@ module Fox
41
41
  #
42
42
  # ==== Parameters:
43
43
  #
44
- # +p+:: the parent window for this tool bar [FXComposite]
45
- # +opts+:: tool bar options [Integer]
46
- # +x+:: initial x-position [Integer]
47
- # +y+:: initial y-position [Integer]
48
- # +width+:: initial width [Integer]
49
- # +height+:: initial height [Integer]
50
- # +padLeft+:: internal padding on the left side, in pixels [Integer]
51
- # +padRight+:: internal padding on the right side, in pixels [Integer]
52
- # +padTop+:: internal padding on the top side, in pixels [Integer]
53
- # +padBottom+:: internal padding on the bottom side, in pixels [Integer]
54
- # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
55
- # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
44
+ # +p+:: the parent window for this tool bar {FXComposite}
45
+ # +opts+:: tool bar options [Integer]
46
+ # +x+:: initial x-position [Integer]
47
+ # +y+:: initial y-position [Integer]
48
+ # +width+:: initial width [Integer]
49
+ # +height+:: initial height [Integer]
50
+ # +padLeft+:: internal padding on the left side, in pixels [Integer]
51
+ # +padRight+:: internal padding on the right side, in pixels [Integer]
52
+ # +padTop+:: internal padding on the top side, in pixels [Integer]
53
+ # +padBottom+:: internal padding on the bottom side, in pixels [Integer]
54
+ # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
55
+ # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
56
56
  #
57
57
  def initialize(p, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theToolBar
58
58
  end
@@ -12,15 +12,15 @@ module Fox
12
12
  #
13
13
  # === Toolbar Grip styles
14
14
  #
15
- # +TOOLBARGRIP_SINGLE+:: Single bar mode for movable tool bars
16
- # +TOOLBARGRIP_DOUBLE+:: Double bar mode for dockable tool bars
15
+ # +TOOLBARGRIP_SINGLE+:: Single bar mode for movable tool bars
16
+ # +TOOLBARGRIP_DOUBLE+:: Double bar mode for dockable tool bars
17
17
  #
18
18
  class FXToolBarGrip < FXDockHandler
19
19
 
20
20
  # Indicates whether the grip is displayed as a double-bar [Boolean]
21
- attr_writer :doubleBar
21
+ attr_writer :doubleBar
22
22
 
23
- # Active color [FXColor]
23
+ # Active color {FXColor}
24
24
  attr_accessor :activeColor
25
25
 
26
26
  #
@@ -28,14 +28,14 @@ module Fox
28
28
  #
29
29
  # ==== Parameters:
30
30
  #
31
- # +p+:: the parent window for this tool bar grip [FXComposite]
32
- # +target+:: the message target, if any, for this tool bar grip [FXObject]
33
- # +selector+:: the message identifier for this tool bar grip [Integer]
34
- # +opts+:: tool bar grip options [Integer]
35
- # +x+:: initial x-position [Integer]
36
- # +y+:: initial y-position [Integer]
37
- # +width+:: initial width [Integer]
38
- # +height+:: initial height [Integer]
31
+ # +p+:: the parent window for this tool bar grip {FXComposite}
32
+ # +target+:: the message target, if any, for this tool bar grip {FXObject}
33
+ # +selector+:: the message identifier for this tool bar grip [Integer]
34
+ # +opts+:: tool bar grip options [Integer]
35
+ # +x+:: initial x-position [Integer]
36
+ # +y+:: initial y-position [Integer]
37
+ # +width+:: initial width [Integer]
38
+ # +height+:: initial height [Integer]
39
39
  #
40
40
  def initialize(p, target=nil, selector=0, opts=TOOLBARGRIP_SINGLE, x=0, y=0, width=0, height=0) # :yields: theToolBarGrip
41
41
  end
@@ -9,18 +9,18 @@ module Fox
9
9
  attr_accessor :frameStyle
10
10
 
11
11
  # Border width [Integer]
12
- attr_reader :borderWidth
12
+ attr_reader :borderWidth
13
13
 
14
- # Highlight color [FXColor]
14
+ # Highlight color {FXColor}
15
15
  attr_accessor :hiliteColor
16
16
 
17
- # Shadow color [FXColor]
17
+ # Shadow color {FXColor}
18
18
  attr_accessor :shadowColor
19
19
 
20
- # Border color [FXColor]
20
+ # Border color {FXColor}
21
21
  attr_accessor :borderColor
22
22
 
23
- # Base GUI color [FXColor]
23
+ # Base GUI color {FXColor}
24
24
  attr_accessor :baseColor
25
25
 
26
26
  #
@@ -28,14 +28,14 @@ module Fox
28
28
  #
29
29
  # ==== Parameters:
30
30
  #
31
- # +owner+:: the owner window for this tool bar shell [FXWindow]
32
- # +opts+:: tool bar shell options [Integer]
33
- # +x+:: initial x-position [Integer]
34
- # +y+:: initial y-position [Integer]
35
- # +width+:: initial width [Integer]
36
- # +height+:: initial height [Integer]
37
- # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
38
- # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
31
+ # +owner+:: the owner window for this tool bar shell {FXWindow}
32
+ # +opts+:: tool bar shell options [Integer]
33
+ # +x+:: initial x-position [Integer]
34
+ # +y+:: initial y-position [Integer]
35
+ # +width+:: initial width [Integer]
36
+ # +height+:: initial height [Integer]
37
+ # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
38
+ # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
39
39
  #
40
40
  def initialize(owner, opts=FRAME_RAISED|FRAME_THICK, x=0, y=0, width=0, height=0, hSpacing=4, vSpacing=4) # :yields: theToolBarShell
41
41
  end
@@ -16,26 +16,26 @@ module Fox
16
16
  #
17
17
  # The following messages are sent by FXToolBarTab to its target:
18
18
  #
19
- # +SEL_KEYPRESS+:: Sent when a key goes down; the message data is an FXEvent instance.
20
- # +SEL_KEYRELEASE+:: Sent when a key goes up; the message data is an FXEvent instance.
21
- # +SEL_COMMAND+:: Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it's +true+ if the toolbar tab is now collapsed, +false+ if it is now uncollapsed).
19
+ # +SEL_KEYPRESS+:: Sent when a key goes down; the message data is an FXEvent instance.
20
+ # +SEL_KEYRELEASE+:: Sent when a key goes up; the message data is an FXEvent instance.
21
+ # +SEL_COMMAND+:: Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it's +true+ if the toolbar tab is now collapsed, +false+ if it is now uncollapsed).
22
22
  #
23
23
  # === Toolbar tab styles
24
24
  #
25
- # +TOOLBARTAB_HORIZONTAL+:: Default is for horizontal toolbar
26
- # +TOOLBARTAB_VERTICAL+:: For vertical toolbar
25
+ # +TOOLBARTAB_HORIZONTAL+:: Default is for horizontal toolbar
26
+ # +TOOLBARTAB_VERTICAL+:: For vertical toolbar
27
27
  #
28
28
  # === Message identifiers
29
29
  #
30
- # +ID_COLLAPSE+:: Collapse the toolbar tab
31
- # +ID_UNCOLLAPSE+:: Uncollapse the toolbar tab
30
+ # +ID_COLLAPSE+:: Collapse the toolbar tab
31
+ # +ID_UNCOLLAPSE+:: Uncollapse the toolbar tab
32
32
  #
33
33
  class FXToolBarTab < FXFrame
34
34
 
35
35
  # The tab style [Integer]
36
36
  attr_accessor :tabStyle
37
37
 
38
- # The active color [FXColor]
38
+ # The active color {FXColor}
39
39
  attr_accessor :activeColor
40
40
 
41
41
  # Tooltip message [String]
@@ -46,14 +46,14 @@ module Fox
46
46
  #
47
47
  # ==== Parameters:
48
48
  #
49
- # +p+:: the parent window for this toolbar tab [FXWindow]
50
- # +target+:: the message target [FXObject]
51
- # +selector+:: the message identifier [Integer]
52
- # +opts+:: the options [Integer]
53
- # +x+:: x-coordinate of window upper left corner [Integer]
54
- # +y+:: y-coordinate of window upper left corner [Integer]
55
- # +width+:: window width [Integer]
56
- # +height+:: window height [Integer]
49
+ # +p+:: the parent window for this toolbar tab {FXWindow}
50
+ # +target+:: the message target {FXObject}
51
+ # +selector+:: the message identifier [Integer]
52
+ # +opts+:: the options [Integer]
53
+ # +x+:: x-coordinate of window upper left corner [Integer]
54
+ # +y+:: y-coordinate of window upper left corner [Integer]
55
+ # +width+:: window width [Integer]
56
+ # +height+:: window height [Integer]
57
57
  #
58
58
  def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yield: theToolBarTab
59
59
  end
@@ -73,47 +73,47 @@ module Fox
73
73
  #
74
74
  # === Message identifiers
75
75
  #
76
- # +ID_MAXIMIZE+:: Maximize the window
77
- # +ID_MINIMIZE+:: Minimize the window
78
- # +ID_RESTORE+:: Restore the window
79
- # +ID_CLOSE+:: Close the window
80
- # +ID_QUERY_DOCK+:: Toolbar asks to dock
76
+ # +ID_MAXIMIZE+:: Maximize the window
77
+ # +ID_MINIMIZE+:: Minimize the window
78
+ # +ID_RESTORE+:: Restore the window
79
+ # +ID_CLOSE+:: Close the window
80
+ # +ID_QUERY_DOCK+:: Toolbar asks to dock
81
81
  #
82
82
 
83
83
  class FXTopWindow < FXShell
84
84
 
85
85
  # Window title [String]
86
- attr_accessor :title
86
+ attr_accessor :title
87
87
 
88
88
  # Top padding, in pixels [Integer]
89
- attr_accessor :padTop
89
+ attr_accessor :padTop
90
90
 
91
91
  # Bottom padding, in pixels [Integer]
92
- attr_accessor :padBottom
92
+ attr_accessor :padBottom
93
93
 
94
94
  # Left padding, in pixels [Integer]
95
- attr_accessor :padLeft
95
+ attr_accessor :padLeft
96
96
 
97
97
  # Right padding, in pixels [Integer]
98
- attr_accessor :padRight
98
+ attr_accessor :padRight
99
99
 
100
100
  # Horizontal spacing between child widgets, in pixels [Integer]
101
- attr_accessor :hSpacing
101
+ attr_accessor :hSpacing
102
102
 
103
103
  # Vertical spacing between child widgets, in pixels [Integer]
104
- attr_accessor :vSpacing
104
+ attr_accessor :vSpacing
105
105
 
106
106
  # Packing hints for child widgets [Integer]
107
- attr_accessor :packingHints
107
+ attr_accessor :packingHints
108
108
 
109
109
  # Title and border decorations (see above) [Integer]
110
- attr_accessor :decorations
110
+ attr_accessor :decorations
111
111
 
112
- # Window icon [FXIcon]
113
- attr_accessor :icon
112
+ # Window icon {FXIcon}
113
+ attr_accessor :icon
114
114
 
115
- # Window mini (title) icon [FXIcon]
116
- attr_accessor :miniIcon
115
+ # Window mini (title) icon {FXIcon}
116
+ attr_accessor :miniIcon
117
117
 
118
118
  # Show this window with given _placement_
119
119
  # (one of +PLACEMENT_DEFAULT+, +PLACEMENT_VISIBLE+, +PLACEMENT_CURSOR+, +PLACEMENT_OWNER+, +PLACEMENT_SCREEN+ or +PLACEMENT_MAXIMIZED+).
@@ -4,7 +4,7 @@ module Fox
4
4
  #
5
5
  class FXTranslator
6
6
 
7
- # The application associated with this translator [FXApp]
7
+ # The application associated with this translator {FXApp}
8
8
  attr_reader :app
9
9
 
10
10
  #
@@ -3,8 +3,8 @@ module Fox
3
3
  # Each item in an FXTreeList is an instance of FXTreeItem.
4
4
  #
5
5
  # A tree item can contain zero or more child items, and those items are arranged
6
- # as a linked list. The FXTreeItem#first method returns the a reference to the
7
- # first child item, if any, and the FXTreeItem#last method returns a reference to
6
+ # as a linked list. The {FXTreeItem#first} method returns the a reference to the
7
+ # first child item, if any, and the {FXTreeItem#last} method returns a reference to
8
8
  # the last child item.
9
9
  #
10
10
  class FXTreeItem < FXObject
@@ -174,98 +174,98 @@ module Fox
174
174
  #
175
175
  # The following messages are sent by FXTreeList to its target:
176
176
  #
177
- # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance.
178
- # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance.
179
- # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
180
- # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
181
- # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down; the message data is an FXEvent instance.
182
- # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up; the message data is an FXEvent instance.
183
- # +SEL_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXTreeItem instance).
184
- # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
185
- # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
186
- # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
187
- # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXTreeItem instance).
188
- # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXTreeItem instance).
189
- # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance).
190
- # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance).
191
- # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXTreeItem instance).
192
- # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXTreeItem instance).
193
- # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXTreeItem instance).
194
- # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXTreeItem instance).
195
- # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXTreeItem instance).
177
+ # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance.
178
+ # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance.
179
+ # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
180
+ # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
181
+ # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down; the message data is an FXEvent instance.
182
+ # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up; the message data is an FXEvent instance.
183
+ # +SEL_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXTreeItem instance).
184
+ # +SEL_CLICKED+:: sent when the left mouse button is single-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
185
+ # +SEL_DOUBLECLICKED+:: sent when the left mouse button is double-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
186
+ # +SEL_TRIPLECLICKED+:: sent when the left mouse button is triple-clicked in the list; the message data is a reference to the item clicked (an FXTreeItem instance) or +nil+ if no item was clicked.
187
+ # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXTreeItem instance).
188
+ # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXTreeItem instance).
189
+ # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance).
190
+ # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXTreeItem instance).
191
+ # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXTreeItem instance).
192
+ # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXTreeItem instance).
193
+ # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXTreeItem instance).
194
+ # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXTreeItem instance).
195
+ # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXTreeItem instance).
196
196
  #
197
197
  # === Tree list styles
198
198
  #
199
- # +TREELIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items
200
- # +TREELIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected
201
- # +TREELIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times
202
- # +TREELIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items
203
- # +TREELIST_AUTOSELECT+:: Automatically select under cursor
204
- # +TREELIST_SHOWS_LINES+:: Lines shown
205
- # +TREELIST_SHOWS_BOXES+:: Boxes to expand shown
206
- # +TREELIST_ROOT_BOXES+:: Display root boxes also
207
- # +TREELIST_NORMAL+:: same as +TREELIST_EXTENDEDLIST+
199
+ # +TREELIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items
200
+ # +TREELIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected
201
+ # +TREELIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times
202
+ # +TREELIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items
203
+ # +TREELIST_AUTOSELECT+:: Automatically select under cursor
204
+ # +TREELIST_SHOWS_LINES+:: Lines shown
205
+ # +TREELIST_SHOWS_BOXES+:: Boxes to expand shown
206
+ # +TREELIST_ROOT_BOXES+:: Display root boxes also
207
+ # +TREELIST_NORMAL+:: same as +TREELIST_EXTENDEDLIST+
208
208
 
209
209
  class FXTreeList < FXScrollArea
210
210
 
211
211
  # Number of items [Integer]
212
- attr_reader :numItems
212
+ attr_reader :numItems
213
213
 
214
214
  # Number of visible items [Integer]
215
- attr_accessor :numVisible
215
+ attr_accessor :numVisible
216
216
 
217
- # First root-level item [FXTreeItem]
218
- attr_reader :firstItem
217
+ # First root-level item {FXTreeItem}
218
+ attr_reader :firstItem
219
219
 
220
- # Last root-level item [FXTreeItem]
221
- attr_reader :lastItem
220
+ # Last root-level item {FXTreeItem}
221
+ attr_reader :lastItem
222
222
 
223
- # Current item, if any [FXTreeItem]
224
- attr_accessor :currentItem
223
+ # Current item, if any {FXTreeItem}
224
+ attr_accessor :currentItem
225
225
 
226
- # Anchor item, if any [FXTreeItem]
227
- attr_accessor :anchorItem
226
+ # Anchor item, if any {FXTreeItem}
227
+ attr_accessor :anchorItem
228
228
 
229
- # Item under the cursor, if any [FXTreeItem]
230
- attr_reader :cursorItem
229
+ # Item under the cursor, if any {FXTreeItem}
230
+ attr_reader :cursorItem
231
231
 
232
- # Text font [FXFont]
233
- attr_accessor :font
232
+ # Text font {FXFont}
233
+ attr_accessor :font
234
234
 
235
235
  # Parent-child indent amount, in pixels [Integer]
236
- attr_accessor :indent
236
+ attr_accessor :indent
237
237
 
238
- # Normal text color [FXColor]
239
- attr_accessor :textColor
238
+ # Normal text color {FXColor}
239
+ attr_accessor :textColor
240
240
 
241
- # Selected text background color [FXColor]
242
- attr_accessor :selBackColor
241
+ # Selected text background color {FXColor}
242
+ attr_accessor :selBackColor
243
243
 
244
- # Selected text color [FXColor]
245
- attr_accessor :selTextColor
244
+ # Selected text color {FXColor}
245
+ attr_accessor :selTextColor
246
246
 
247
- # Line color [FXColor]
248
- attr_accessor :lineColor
247
+ # Line color {FXColor}
248
+ attr_accessor :lineColor
249
249
 
250
250
  # List style [Integer]
251
- attr_accessor :listStyle
251
+ attr_accessor :listStyle
252
252
 
253
253
  # Status line help text for this list [String]
254
- attr_accessor :helpText
254
+ attr_accessor :helpText
255
255
 
256
256
  #
257
257
  # Construct a new, initially empty tree list.
258
258
  #
259
259
  # ==== Parameters:
260
260
  #
261
- # +p+:: the parent window for this tree list [FXComposite]
262
- # +target+:: the message target, if any, for this tree list [FXObject]
263
- # +selector+:: the message identifier for this tree list [Integer]
264
- # +opts+:: tree list options [Integer]
265
- # +x+:: initial x-position [Integer]
266
- # +y+:: initial y-position [Integer]
267
- # +width+:: initial width [Integer]
268
- # +height+:: initial height [Integer]
261
+ # +p+:: the parent window for this tree list {FXComposite}
262
+ # +target+:: the message target, if any, for this tree list {FXObject}
263
+ # +selector+:: the message identifier for this tree list [Integer]
264
+ # +opts+:: tree list options [Integer]
265
+ # +x+:: initial x-position [Integer]
266
+ # +y+:: initial y-position [Integer]
267
+ # +width+:: initial width [Integer]
268
+ # +height+:: initial height [Integer]
269
269
  #
270
270
  def initialize(p, target=nil, selector=0, opts=TREELIST_NORMAL, x=0, y=0, width=0, height=0) # :yields: theTreeList
271
271
  end
@@ -331,7 +331,7 @@ module Fox
331
331
  # Remove item.
332
332
  # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
333
333
  # target before the item is removed.
334
- def removeItem(item, notify=false);
334
+ def removeItem(item, notify=false); end
335
335
 
336
336
  # Remove items in range [_fromItem_, _toItem_] inclusively.
337
337
  # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
@@ -455,7 +455,7 @@ module Fox
455
455
  #
456
456
  # Set this item's state to opened. The primary result of this change is
457
457
  # that the item's icon will change to its "open" icon.
458
- # This is different from the #expandTree method, which actually
458
+ # This is different from the {#expandTree} method, which actually
459
459
  # collapses part of the tree list, making some items invisible.
460
460
  # If _notify_ is +true+, a +SEL_OPENED+ message is sent to the list's
461
461
  # message target after the item is opened.
@@ -465,7 +465,7 @@ module Fox
465
465
  #
466
466
  # Set this item's state to closed. The primary result of this change is
467
467
  # that the item's icon will change to its "closed" icon.
468
- # This is different from the #collapseTree method, which actually
468
+ # This is different from the {#collapseTree} method, which actually
469
469
  # collapses part of the tree list, making some items invisible.
470
470
  # If _notify_ is +true+, a +SEL_CLOSED+ message is sent to the list's
471
471
  # message target after the item is closed.