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
@@ -8,10 +8,10 @@ module Fox
8
8
  # Caption text for the grip [String]
9
9
  attr_accessor :caption
10
10
 
11
- # Caption font [FXFont]
11
+ # Caption font {FXFont}
12
12
  attr_accessor :font
13
13
 
14
- # Caption color [FXColor]
14
+ # Caption color {FXColor}
15
15
  attr_accessor :captionColor
16
16
 
17
17
  # Current justification mode [Integer]
@@ -4,8 +4,8 @@ module Fox
4
4
  #
5
5
  # === Message identifiers
6
6
  #
7
- # +ID_TITLE+:: x
8
- # +ID_FILENAME+:: x
7
+ # +ID_TITLE+:: x
8
+ # +ID_FILENAME+:: x
9
9
  #
10
10
  class FXDocument < FXObject
11
11
 
@@ -5,10 +5,10 @@ module Fox
5
5
  #
6
6
  class FXDragCorner < FXWindow
7
7
 
8
- # Highlight color [FXColor]
8
+ # Highlight color {FXColor}
9
9
  attr_accessor :hiliteColor
10
10
 
11
- # Shadow color [FXColor]
11
+ # Shadow color {FXColor}
12
12
  attr_accessor :shadowColor
13
13
 
14
14
  # Construct a drag corner
@@ -6,12 +6,12 @@ module Fox
6
6
  class FXDrawable < FXId
7
7
 
8
8
  # Width of drawable, in pixels [Integer]
9
- attr_reader :width
9
+ attr_reader :width
10
10
 
11
11
  # Height of drawable, in pixels [Integer]
12
- attr_reader :height
12
+ attr_reader :height
13
13
 
14
- # Visual [FXVisual]
14
+ # Visual {FXVisual}
15
15
  attr_accessor :visual
16
16
 
17
17
  #
@@ -19,8 +19,8 @@ module Fox
19
19
  #
20
20
  # ==== Parameters:
21
21
  #
22
- # +width+:: new drawable width, in pixels [Integer]
23
- # +height+:: new drawable height, in pixels [Integer]
22
+ # +width+:: new drawable width, in pixels [Integer]
23
+ # +height+:: new drawable height, in pixels [Integer]
24
24
  #
25
25
  def resize(w, h); end
26
26
  end
@@ -6,15 +6,15 @@ module Fox
6
6
  #
7
7
  # The following messages are sent by FXDriveBox to its target:
8
8
  #
9
- # +SEL_CHANGED+:: sent when the current item changes; the message data is the current drive
10
- # +SEL_COMMAND+:: sent when a new item is selected from the list; the message data is the drive
9
+ # +SEL_CHANGED+:: sent when the current item changes; the message data is the current drive
10
+ # +SEL_COMMAND+:: sent when a new item is selected from the list; the message data is the drive
11
11
  #
12
12
  class FXDriveBox < FXListBox
13
13
 
14
14
  # Current drive [String]
15
15
  attr_accessor :drive
16
16
 
17
- # File associations [FXFileDict]
17
+ # File associations {FXFileDict}
18
18
  attr_accessor :associations
19
19
 
20
20
  # Returns an initialized FXDriveBox instance
@@ -22,11 +22,11 @@ module Fox
22
22
  #
23
23
  # === Wildcard matching modes
24
24
  #
25
- # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows).
26
- # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\").
27
- # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix).
28
- # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match.
29
- # +FILEMATCH_CASEFOLD+:: Compare without regard to case.
25
+ # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows).
26
+ # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\").
27
+ # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix).
28
+ # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match.
29
+ # +FILEMATCH_CASEFOLD+:: Compare without regard to case.
30
30
  #
31
31
  # Note that under Windows, +FILEMATCH_NOESCAPE+ must be passed.
32
32
  #
@@ -83,7 +83,7 @@ module Fox
83
83
  #
84
84
  # will both set the same three patterns, but the former shows no pattern names.
85
85
  #
86
- # For compatibility with the FOX C++ library API of the same name, #setPatternList
86
+ # For compatibility with the FOX C++ library API of the same name, {#setPatternList}
87
87
  # also accepts a _patterns_ value that is a single string, with each pattern
88
88
  # separated by newline characters, e.g.
89
89
  #
@@ -163,11 +163,11 @@ module Fox
163
163
  #
164
164
  # ==== Parameters:
165
165
  #
166
- # +owner+:: the owner window for the dialog box [FXWindow]
167
- # +caption+:: the caption for the dialog box [String]
168
- # +path+:: the initial filename [String]
169
- # +patterns+:: the pattern list [String]
170
- # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
166
+ # +owner+:: the owner window for the dialog box {FXWindow}
167
+ # +caption+:: the caption for the dialog box [String]
168
+ # +path+:: the initial filename [String]
169
+ # +patterns+:: the pattern list [String]
170
+ # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
171
171
  #
172
172
  def FXFileDialog.getOpenFilename(owner, caption, path, patterns="*", initial=0); end
173
173
 
@@ -178,11 +178,11 @@ module Fox
178
178
  #
179
179
  # ==== Parameters:
180
180
  #
181
- # +owner+:: the owner window for the dialog box [FXWindow]
182
- # +caption+:: the caption for the dialog box [String]
183
- # +path+:: the initial filename [String]
184
- # +patterns+:: the pattern list [String]
185
- # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
181
+ # +owner+:: the owner window for the dialog box {FXWindow}
182
+ # +caption+:: the caption for the dialog box [String]
183
+ # +path+:: the initial filename [String]
184
+ # +patterns+:: the pattern list [String]
185
+ # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
186
186
  #
187
187
  def FXFileDialog.getOpenFilenames(owner, caption, path, patterns="*", initial=0); end
188
188
 
@@ -193,11 +193,11 @@ module Fox
193
193
  #
194
194
  # ==== Parameters:
195
195
  #
196
- # +owner+:: the owner window for the dialog box [FXWindow]
197
- # +caption+:: the caption for the dialog box [String]
198
- # +path+:: the initial filename [String]
199
- # +patterns+:: the pattern list [String]
200
- # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
196
+ # +owner+:: the owner window for the dialog box {FXWindow}
197
+ # +caption+:: the caption for the dialog box [String]
198
+ # +path+:: the initial filename [String]
199
+ # +patterns+:: the pattern list [String]
200
+ # +initial+:: the initial pattern to be used (an index into the pattern list) [Integer]
201
201
  #
202
202
  def FXFileDialog.getSaveFilename(owner, caption, path, patterns="*", initial=0); end
203
203
 
@@ -207,9 +207,9 @@ module Fox
207
207
  #
208
208
  # ==== Parameters:
209
209
  #
210
- # +owner+:: the owner window for the dialog box [FXWindow]
211
- # +caption+:: the caption for the dialog box [String]
212
- # +path+:: the initial directory path [String]
210
+ # +owner+:: the owner window for the dialog box {FXWindow}
211
+ # +caption+:: the caption for the dialog box [String]
212
+ # +path+:: the initial directory path [String]
213
213
  #
214
214
  def FXFileDialog.getOpenDirectory(owner, caption, path); end
215
215
  end
@@ -12,19 +12,19 @@ module Fox
12
12
  # Mime type name [String]
13
13
  attr_accessor :mimetype
14
14
 
15
- # Big normal icon [FXIcon]
15
+ # Big normal icon {FXIcon}
16
16
  attr_accessor :bigicon
17
17
 
18
- # Big open icon [FXIcon]
18
+ # Big open icon {FXIcon}
19
19
  attr_accessor :bigiconopen
20
20
 
21
- # Mini normal icon [FXIcon]
21
+ # Mini normal icon {FXIcon}
22
22
  attr_accessor :miniicon
23
23
 
24
- # Mini open icon [FXIcon]
24
+ # Mini open icon {FXIcon}
25
25
  attr_accessor :miniiconopen
26
26
 
27
- # Registered drag type [FXDragType]
27
+ # Registered drag type [Integer]
28
28
  attr_accessor :dragtype
29
29
 
30
30
  # Flags [Integer]
@@ -65,10 +65,10 @@ module Fox
65
65
  #
66
66
  class FXFileDict < FXDict
67
67
 
68
- # Settings database [FXSettings]
68
+ # Settings database {FXSettings}
69
69
  attr_accessor :settings
70
70
 
71
- # Current icon search path [FXIconDict]
71
+ # Current icon search path {FXIconDict}
72
72
  attr_accessor :iconDict
73
73
 
74
74
  # Current icon search path [String]
@@ -91,8 +91,8 @@ module Fox
91
91
  #
92
92
  # ==== Parameters:
93
93
  #
94
- # +app+: Application [FXApp]
95
- # +db+:: Settings database [FXSettings]
94
+ # +app+: Application {FXApp}
95
+ # +db+:: Settings database {FXSettings}
96
96
  #
97
97
  def initialize(app, db=nil); end
98
98
 
@@ -102,8 +102,8 @@ module Fox
102
102
  #
103
103
  # ==== Parameters:
104
104
  #
105
- # +ext+:: Extension [String]
106
- # +str+:: String [String]
105
+ # +ext+:: Extension [String]
106
+ # +str+:: String [String]
107
107
  #
108
108
  def replace(ext, str); end
109
109
 
@@ -4,7 +4,7 @@ module Fox
4
4
  #
5
5
  class FXFileItem < FXIconItem
6
6
 
7
- # The file association object for this item [FXFileAssoc]
7
+ # The file association object for this item {FXFileAssoc}
8
8
  attr_reader :assoc
9
9
 
10
10
  # The file size for this item [Integer]
@@ -57,32 +57,32 @@ module Fox
57
57
  #
58
58
  # === File List options
59
59
  #
60
- # +FILELIST_SHOWHIDDEN+:: Show hidden files or directories
61
- # +FILELIST_SHOWDIRS+:: Show only directories
62
- # +FILELIST_SHOWFILES+:: Show only files
63
- # +FILELIST_SHOWIMAGES+:: Show preview of images
64
- # +FILELIST_NO_OWN_ASSOC+:: Do not create associations for files
65
- # +FILELIST_NO_PARENT+:: Suppress display of '.' and '..'
60
+ # +FILELIST_SHOWHIDDEN+:: Show hidden files or directories
61
+ # +FILELIST_SHOWDIRS+:: Show only directories
62
+ # +FILELIST_SHOWFILES+:: Show only files
63
+ # +FILELIST_SHOWIMAGES+:: Show preview of images
64
+ # +FILELIST_NO_OWN_ASSOC+:: Do not create associations for files
65
+ # +FILELIST_NO_PARENT+:: Suppress display of '.' and '..'
66
66
  #
67
67
  # === Message identifiers
68
68
  #
69
- # +ID_SORT_BY_NAME+:: Sort by name
70
- # +ID_SORT_BY_TYPE+:: Sort by type
71
- # +ID_SORT_BY_SIZE+:: Sort by size
72
- # +ID_SORT_BY_TIME+:: Sort by access time
73
- # +ID_SORT_BY_USER+:: Sort by user name
74
- # +ID_SORT_BY_GROUP+:: Sort by group name
75
- # +ID_SORT_REVERSE+:: Reverse sort order
76
- # +ID_DIRECTORY_UP+:: Move up one directory
77
- # +ID_SET_PATTERN+:: Set match pattern
78
- # +ID_SET_DIRECTORY+:: Set directory
79
- # +ID_SHOW_HIDDEN+:: Show hidden files
80
- # +ID_HIDE_HIDDEN+:: Hide hidden files
81
- # +ID_TOGGLE_HIDDEN+:: Toggle visibility of hidden files
82
- # +ID_REFRESHTIMER+:: x
83
- # +ID_OPENTIMER+:: x
84
- # +ID_TOGGLE_IMAGES+:: Toggle display of images
85
- # +ID_REFRESH+:: Refresh immediately
69
+ # +ID_SORT_BY_NAME+:: Sort by name
70
+ # +ID_SORT_BY_TYPE+:: Sort by type
71
+ # +ID_SORT_BY_SIZE+:: Sort by size
72
+ # +ID_SORT_BY_TIME+:: Sort by access time
73
+ # +ID_SORT_BY_USER+:: Sort by user name
74
+ # +ID_SORT_BY_GROUP+:: Sort by group name
75
+ # +ID_SORT_REVERSE+:: Reverse sort order
76
+ # +ID_DIRECTORY_UP+:: Move up one directory
77
+ # +ID_SET_PATTERN+:: Set match pattern
78
+ # +ID_SET_DIRECTORY+:: Set directory
79
+ # +ID_SHOW_HIDDEN+:: Show hidden files
80
+ # +ID_HIDE_HIDDEN+:: Hide hidden files
81
+ # +ID_TOGGLE_HIDDEN+:: Toggle visibility of hidden files
82
+ # +ID_REFRESHTIMER+:: x
83
+ # +ID_OPENTIMER+:: x
84
+ # +ID_TOGGLE_IMAGES+:: Toggle display of images
85
+ # +ID_REFRESH+:: Refresh immediately
86
86
  #
87
87
  class FXFileList < FXIconList
88
88
 
@@ -98,7 +98,7 @@ module Fox
98
98
  # Wildcard matching mode [Integer]
99
99
  attr_accessor :matchMode
100
100
 
101
- # File associations [FXFileDict]
101
+ # File associations {FXFileDict}
102
102
  attr_accessor :associations
103
103
 
104
104
  # Image size for preview images [Integer]
@@ -4,49 +4,49 @@ module Fox
4
4
  #
5
5
  # === File selection modes
6
6
  #
7
- # +SELECTFILE_ANY+:: A single file, existing or not (to save to)
8
- # +SELECTFILE_EXISTING+:: An existing file (to load)
9
- # +SELECTFILE_MULTIPLE+:: Multiple existing files
10
- # +SELECTFILE_MULTIPLE_ALL+:: Multiple existing files or directories, but not '.' and '..'
11
- # +SELECTFILE_DIRECTORY+:: Existing directory, including '.' or '..'
7
+ # +SELECTFILE_ANY+:: A single file, existing or not (to save to)
8
+ # +SELECTFILE_EXISTING+:: An existing file (to load)
9
+ # +SELECTFILE_MULTIPLE+:: Multiple existing files
10
+ # +SELECTFILE_MULTIPLE_ALL+:: Multiple existing files or directories, but not '.' and '..'
11
+ # +SELECTFILE_DIRECTORY+:: Existing directory, including '.' or '..'
12
12
  #
13
13
  # === Wildcard matching modes
14
14
  #
15
- # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows).
16
- # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\").
17
- # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix).
18
- # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match.
19
- # +FILEMATCH_CASEFOLD+:: Compare without regard to case.
15
+ # +FILEMATCH_FILE_NAME+:: No wildcard can ever match "/" (or "\","/" under Windows).
16
+ # +FILEMATCH_NOESCAPE+:: Backslashes don't quote special chars ("\" is treated as "\").
17
+ # +FILEMATCH_PERIOD+:: Leading "." is matched only explicitly (Useful to match hidden files on Unix).
18
+ # +FILEMATCH_LEADING_DIR+:: Ignore "/..." after a match.
19
+ # +FILEMATCH_CASEFOLD+:: Compare without regard to case.
20
20
  #
21
21
  # Note that under Windows, +FILEMATCH_NOESCAPE+ must be passed.
22
22
  #
23
23
  # === Message identifiers
24
24
  #
25
- # +ID_FILEFILTER+:: x
26
- # +ID_ACCEPT+:: x
27
- # +ID_FILELIST+:: x
28
- # +ID_DIRECTORY_UP+:: x
29
- # +ID_DIRTREE+:: x
30
- # +ID_NORMAL_SIZE+:: x
31
- # +ID_MEDIUM_SIZE+:: x
32
- # +ID_GIANT_SIZE+:: x
33
- # +ID_HOME+:: x
34
- # +ID_WORK+:: x
35
- # +ID_BOOKMARK+:: x
36
- # +ID_BOOKMENU+:: x
37
- # +ID_VISIT+:: x
38
- # +ID_NEW+:: x
39
- # +ID_DELETE+:: x
40
- # +ID_MOVE+:: x
41
- # +ID_COPY+:: x
42
- # +ID_LINK+:: x
25
+ # +ID_FILEFILTER+:: x
26
+ # +ID_ACCEPT+:: x
27
+ # +ID_FILELIST+:: x
28
+ # +ID_DIRECTORY_UP+:: x
29
+ # +ID_DIRTREE+:: x
30
+ # +ID_NORMAL_SIZE+:: x
31
+ # +ID_MEDIUM_SIZE+:: x
32
+ # +ID_GIANT_SIZE+:: x
33
+ # +ID_HOME+:: x
34
+ # +ID_WORK+:: x
35
+ # +ID_BOOKMARK+:: x
36
+ # +ID_BOOKMENU+:: x
37
+ # +ID_VISIT+:: x
38
+ # +ID_NEW+:: x
39
+ # +ID_DELETE+:: x
40
+ # +ID_MOVE+:: x
41
+ # +ID_COPY+:: x
42
+ # +ID_LINK+:: x
43
43
  #
44
44
  class FXFileSelector < FXPacker
45
45
 
46
- # The "Accept" button [FXButton]
46
+ # The "Accept" button {FXButton}
47
47
  attr_reader :acceptButton
48
48
 
49
- # The "Cancel" button [FXButton]
49
+ # The "Cancel" button {FXButton}
50
50
  attr_reader :cancelButton
51
51
 
52
52
  # File name [String]
@@ -104,7 +104,7 @@ module Fox
104
104
  #
105
105
  # will both set the same three patterns, but the former shows no pattern names.
106
106
  #
107
- # For compatibility with the FOX C++ library API of the same name, #setPatternList
107
+ # For compatibility with the FOX C++ library API of the same name, {#setPatternList}
108
108
  # also accepts a _patterns_ value that is a single string, with each pattern
109
109
  # separated by newline characters, e.g.
110
110
  #
@@ -17,9 +17,9 @@ module Fox
17
17
  #
18
18
  # ==== Parameters:
19
19
  #
20
- # +filename+:: name of the file to open [String]
21
- # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer]
22
- # +size+:: buffer size [Integer]
20
+ # +filename+:: name of the file to open [String]
21
+ # +save_or_load+:: access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer]
22
+ # +size+:: buffer size [Integer]
23
23
  #
24
24
  def open(filename, save_or_load, size=8192); end
25
25
  end
@@ -4,56 +4,56 @@ module Fox
4
4
  #
5
5
  class FXFoldingItem < FXObject
6
6
 
7
- # Parent item [FXFoldingItem]
8
- attr_reader :parent
7
+ # Parent item {FXFoldingItem}
8
+ attr_reader :parent
9
9
 
10
- # Next sibling item [FXFoldingItem]
11
- attr_reader :next
10
+ # Next sibling item {FXFoldingItem}
11
+ attr_reader :next
12
12
 
13
- # Previous sibling item [FXFoldingItem]
14
- attr_reader :prev
13
+ # Previous sibling item {FXFoldingItem}
14
+ attr_reader :prev
15
15
 
16
- # First child item [FXFoldingItem]
17
- attr_reader :first
16
+ # First child item {FXFoldingItem}
17
+ attr_reader :first
18
18
 
19
- # Last child item [FXFoldingItem]
20
- attr_reader :last
19
+ # Last child item {FXFoldingItem}
20
+ attr_reader :last
21
21
 
22
- # Item logically below this item [FXFoldingItem]
23
- attr_reader :below
22
+ # Item logically below this item {FXFoldingItem}
23
+ attr_reader :below
24
24
 
25
- # Item logically above this item [FXFoldingItem]
26
- attr_reader :above
25
+ # Item logically above this item {FXFoldingItem}
26
+ attr_reader :above
27
27
 
28
28
  # Number of child items [Integer]
29
- attr_reader :numChildren
29
+ attr_reader :numChildren
30
30
 
31
31
  # Item text [String]
32
- attr_accessor :text
32
+ attr_accessor :text
33
33
 
34
- # Open icon [FXIcon]
35
- attr_accessor :openIcon
34
+ # Open icon {FXIcon}
35
+ attr_accessor :openIcon
36
36
 
37
- # Closed icon [FXIcon]
38
- attr_accessor :closedIcon
37
+ # Closed icon {FXIcon}
38
+ attr_accessor :closedIcon
39
39
 
40
40
  # User data [Object]
41
- attr_accessor :data
41
+ attr_accessor :data
42
42
 
43
43
  # Indicates whether the item is selected [Boolean]
44
- attr_writer :selected
44
+ attr_writer :selected
45
45
 
46
46
  # Indicates whether the item is opened [Boolean]
47
- attr_writer :opened
47
+ attr_writer :opened
48
48
 
49
49
  # Indicates whether the item is expanded [Boolean]
50
- attr_writer :expanded
50
+ attr_writer :expanded
51
51
 
52
52
  # Indicates whether the item is enabled [Boolean]
53
- attr_writer :enabled
53
+ attr_writer :enabled
54
54
 
55
55
  # Indicates whether the item is draggable [Boolean]
56
- attr_writer :draggable
56
+ attr_writer :draggable
57
57
 
58
58
  # Construct a new folding item
59
59
  def initialize(text, openIcon=nil, closedIcon=nil, data=nil) # :yields: theItem
@@ -154,83 +154,83 @@ module Fox
154
154
  #
155
155
  # The following messages are sent by FXFoldingList to its target:
156
156
  #
157
- # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance.
158
- # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance.
159
- # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
160
- # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
161
- # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down; the message data is an FXEvent instance.
162
- # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up; the message data is an FXEvent instance.
163
- # +SEL_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXFoldingItem instance).
164
- # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
165
- # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
166
- # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
167
- # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXFoldingItem instance).
168
- # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXFoldingItem instance).
169
- # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).
170
- # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).
171
- # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXFoldingItem instance).
172
- # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXFoldingItem instance).
173
- # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXFoldingItem instance).
174
- # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXFoldingItem instance).
175
- # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXFoldingItem instance).
157
+ # +SEL_KEYPRESS+:: sent when a key goes down; the message data is an FXEvent instance.
158
+ # +SEL_KEYRELEASE+:: sent when a key goes up; the message data is an FXEvent instance.
159
+ # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
160
+ # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
161
+ # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down; the message data is an FXEvent instance.
162
+ # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up; the message data is an FXEvent instance.
163
+ # +SEL_COMMAND+:: sent when a list item is clicked on; the message data is a reference to the item (an FXFoldingItem instance).
164
+ # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
165
+ # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
166
+ # +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 FXFoldingItem instance) or +nil+ if no item was clicked.
167
+ # +SEL_OPENED+:: sent when an item is opened; the message data is a reference to the item (an FXFoldingItem instance).
168
+ # +SEL_CLOSED+:: sent when an item is closed; the message data is a reference to the item (an FXFoldingItem instance).
169
+ # +SEL_EXPANDED+:: sent when a sub-tree is expanded; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).
170
+ # +SEL_COLLAPSED+:: sent when a sub-tree is collapsed; the message data is a reference to the root item for the sub-tree (an FXFoldingItem instance).
171
+ # +SEL_SELECTED+:: sent when an item is selected; the message data is a reference to the item (an FXFoldingItem instance).
172
+ # +SEL_DESELECTED+:: sent when an item is deselected; the message data is a reference to the item (an FXFoldingItem instance).
173
+ # +SEL_CHANGED+:: sent when the current item changes; the message data is a reference to the current item (an FXFoldingItem instance).
174
+ # +SEL_INSERTED+:: sent after an item is added to the list; the message data is a reference to the item (an FXFoldingItem instance).
175
+ # +SEL_DELETED+:: sent before an item is removed from the list; the message data is a reference to the item (an FXFoldingItem instance).
176
176
  #
177
177
  # === Folding list styles
178
178
  #
179
- # +FOLDINGLIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items
180
- # +FOLDINGLIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected
181
- # +FOLDINGLIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times
182
- # +FOLDINGLIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items
183
- # +FOLDINGLIST_AUTOSELECT+:: Automatically select under cursor
184
- # +FOLDINGLIST_SHOWS_LINES+:: Lines shown
185
- # +FOLDINGLIST_SHOWS_BOXES+:: Boxes to expand shown
186
- # +FOLDINGLIST_ROOT_BOXES+:: Display root boxes also
187
- # +FOLDINGLIST_NORMAL+:: same as +FOLDINGLIST_EXTENDEDSELECT+
179
+ # +FOLDINGLIST_EXTENDEDSELECT+:: Extended selection mode allows for drag-selection of ranges of items
180
+ # +FOLDINGLIST_SINGLESELECT+:: Single selection mode allows up to one item to be selected
181
+ # +FOLDINGLIST_BROWSESELECT+:: Browse selection mode enforces one single item to be selected at all times
182
+ # +FOLDINGLIST_MULTIPLESELECT+:: Multiple selection mode is used for selection of individual items
183
+ # +FOLDINGLIST_AUTOSELECT+:: Automatically select under cursor
184
+ # +FOLDINGLIST_SHOWS_LINES+:: Lines shown
185
+ # +FOLDINGLIST_SHOWS_BOXES+:: Boxes to expand shown
186
+ # +FOLDINGLIST_ROOT_BOXES+:: Display root boxes also
187
+ # +FOLDINGLIST_NORMAL+:: same as +FOLDINGLIST_EXTENDEDSELECT+
188
188
 
189
189
  class FXFoldingList < FXScrollArea
190
190
 
191
- # Header control [FXHeader]
191
+ # Header control {FXHeader}
192
192
  attr_reader :header
193
193
 
194
194
  # Number of header items [Integer]
195
195
  attr_reader :numHeaders
196
196
 
197
197
  # Number of items [Integer]
198
- attr_reader :numItems
198
+ attr_reader :numItems
199
199
 
200
200
  # Number of visible items [Integer]
201
201
  attr_accessor :numVisible
202
202
 
203
- # First root-level item [FXFoldingItem]
203
+ # First root-level item {FXFoldingItem}
204
204
  attr_reader :firstItem
205
205
 
206
- # Last root-level item [FXFoldingItem]
206
+ # Last root-level item {FXFoldingItem}
207
207
  attr_reader :lastItem
208
208
 
209
- # Current item, if any [FXFoldingItem]
209
+ # Current item, if any {FXFoldingItem}
210
210
  attr_accessor :currentItem
211
211
 
212
- # Anchor item, if any [FXFoldingItem]
212
+ # Anchor item, if any {FXFoldingItem}
213
213
  attr_accessor :anchorItem
214
214
 
215
- # Item under the cursor, if any [FXFoldingItem]
216
- attr_reader :cursorItem
215
+ # Item under the cursor, if any {FXFoldingItem}
216
+ attr_reader :cursorItem
217
217
 
218
- # Text font [FXFont]
218
+ # Text font {FXFont}
219
219
  attr_accessor :font
220
220
 
221
221
  # Parent-child indent amount, in pixels [Integer]
222
222
  attr_accessor :indent
223
223
 
224
- # Normal text color [FXColor]
224
+ # Normal text color {FXColor}
225
225
  attr_accessor :textColor
226
226
 
227
- # Selected text background color [FXColor]
227
+ # Selected text background color {FXColor}
228
228
  attr_accessor :selBackColor
229
229
 
230
- # Selected text color [FXColor]
230
+ # Selected text color {FXColor}
231
231
  attr_accessor :selTextColor
232
232
 
233
- # Line color [FXColor]
233
+ # Line color {FXColor}
234
234
  attr_accessor :lineColor
235
235
 
236
236
  # List style [Integer]
@@ -244,14 +244,14 @@ module Fox
244
244
  #
245
245
  # ==== Parameters:
246
246
  #
247
- # +p+:: the parent window for this folding list [FXComposite]
248
- # +target+:: the message target, if any, for this folding list [FXObject]
249
- # +selector+:: the message identifier for this folding list [Integer]
250
- # +opts+:: folding list options [Integer]
251
- # +x+:: initial x-position [Integer]
252
- # +y+:: initial y-position [Integer]
253
- # +width+:: initial width [Integer]
254
- # +height+:: initial height [Integer]
247
+ # +p+:: the parent window for this folding list {FXComposite}
248
+ # +target+:: the message target, if any, for this folding list {FXObject}
249
+ # +selector+:: the message identifier for this folding list [Integer]
250
+ # +opts+:: folding list options [Integer]
251
+ # +x+:: initial x-position [Integer]
252
+ # +y+:: initial y-position [Integer]
253
+ # +width+:: initial width [Integer]
254
+ # +height+:: initial height [Integer]
255
255
  #
256
256
  def initialize(p, target=nil, selector=0, opts=TREELIST_NORMAL, x=0, y=0, width=0, height=0) # :yields: theFoldingList
257
257
  end
@@ -343,7 +343,7 @@ module Fox
343
343
  # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
344
344
  # target before the item is removed.
345
345
  #
346
- def removeItem(item, notify=false);
346
+ def removeItem(item, notify=false); end
347
347
 
348
348
  # Remove items in range [_fromItem_, _toItem_] inclusively.
349
349
  # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message