fxruby 1.6.39-x64-mingw32 → 1.6.44-x64-mingw32
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.travis.yml +3 -14
- data/.yardopts +1 -1
- data/Gemfile +4 -5
- data/History.md +1345 -22
- data/README.rdoc +5 -5
- data/Rakefile +100 -68
- data/appveyor.yml +11 -16
- data/docs/Fox.html +11184 -0
- data/docs/Fox/Canvas.html +141 -0
- data/docs/Fox/Canvas/CanvasError.html +124 -0
- data/docs/Fox/Canvas/CircleShape.html +477 -0
- data/docs/Fox/Canvas/ImageShape.html +477 -0
- data/docs/Fox/Canvas/LineShape.html +1005 -0
- data/docs/Fox/Canvas/PolygonShape.html +145 -0
- data/docs/Fox/Canvas/RectangleShape.html +439 -0
- data/docs/Fox/Canvas/SelectionPolicy.html +352 -0
- data/docs/Fox/Canvas/Shape.html +1955 -0
- data/docs/Fox/Canvas/ShapeCanvas.html +2031 -0
- data/docs/Fox/Canvas/ShapeGroup.html +527 -0
- data/docs/Fox/Canvas/SingleSelectionPolicy.html +291 -0
- data/docs/Fox/Canvas/TextShape.html +609 -0
- data/docs/Fox/FTNonModal.html +550 -0
- data/docs/Fox/FX4Splitter.html +1336 -0
- data/docs/Fox/FX7Segment.html +1010 -0
- data/docs/Fox/FXAccelTable.html +715 -0
- data/docs/Fox/FXApp.html +7998 -0
- data/docs/Fox/FXArc.html +562 -0
- data/docs/Fox/FXArrowButton.html +865 -0
- data/docs/Fox/FXBMPIcon.html +450 -0
- data/docs/Fox/FXBMPImage.html +434 -0
- data/docs/Fox/FXBitmap.html +1362 -0
- data/docs/Fox/FXBitmapFrame.html +595 -0
- data/docs/Fox/FXBitmapView.html +1451 -0
- data/docs/Fox/FXButton.html +534 -0
- data/docs/Fox/FXCURCursor.html +261 -0
- data/docs/Fox/FXCalendar.html +880 -0
- data/docs/Fox/FXCanvas.html +311 -0
- data/docs/Fox/FXCheckButton.html +949 -0
- data/docs/Fox/FXChoiceBox.html +472 -0
- data/docs/Fox/FXColor.html +1519 -0
- data/docs/Fox/FXColorBar.html +759 -0
- data/docs/Fox/FXColorDialog.html +591 -0
- data/docs/Fox/FXColorItem.html +323 -0
- data/docs/Fox/FXColorList.html +712 -0
- data/docs/Fox/FXColorRing.html +817 -0
- data/docs/Fox/FXColorSelector.html +796 -0
- data/docs/Fox/FXColorWell.html +850 -0
- data/docs/Fox/FXColorWheel.html +770 -0
- data/docs/Fox/FXComboBox.html +2939 -0
- data/docs/Fox/FXComboTableItem.html +544 -0
- data/docs/Fox/FXCommand.html +526 -0
- data/docs/Fox/FXComposite.html +433 -0
- data/docs/Fox/FXCursor.html +779 -0
- data/docs/Fox/FXDC.html +5231 -0
- data/docs/Fox/FXDCPrint.html +696 -0
- data/docs/Fox/FXDCWindow.html +358 -0
- data/docs/Fox/FXDataTarget.html +573 -0
- data/docs/Fox/FXDebugTarget.html +305 -0
- data/docs/Fox/FXDelegator.html +305 -0
- data/docs/Fox/FXDial.html +1133 -0
- data/docs/Fox/FXDialogBox.html +413 -0
- data/docs/Fox/FXDict.html +1063 -0
- data/docs/Fox/FXDirBox.html +752 -0
- data/docs/Fox/FXDirDialog.html +914 -0
- data/docs/Fox/FXDirItem.html +989 -0
- data/docs/Fox/FXDirList.html +1554 -0
- data/docs/Fox/FXDirSelector.html +995 -0
- data/docs/Fox/FXDockBar.html +1451 -0
- data/docs/Fox/FXDockHandler.html +468 -0
- data/docs/Fox/FXDockSite.html +678 -0
- data/docs/Fox/FXDockTitle.html +606 -0
- data/docs/Fox/FXDocument.html +536 -0
- data/docs/Fox/FXDragCorner.html +440 -0
- data/docs/Fox/FXDrawable.html +478 -0
- data/docs/Fox/FXDriveBox.html +746 -0
- data/docs/Fox/FXEvent.html +1736 -0
- data/docs/Fox/FXExtentd.html +1374 -0
- data/docs/Fox/FXExtentf.html +1374 -0
- data/docs/Fox/FXFileAssoc.html +850 -0
- data/docs/Fox/FXFileDialog.html +2688 -0
- data/docs/Fox/FXFileDict.html +1058 -0
- data/docs/Fox/FXFileItem.html +1141 -0
- data/docs/Fox/FXFileList.html +2259 -0
- data/docs/Fox/FXFileSelector.html +2529 -0
- data/docs/Fox/FXFileStream.html +503 -0
- data/docs/Fox/FXFoldingItem.html +2822 -0
- data/docs/Fox/FXFoldingList.html +5189 -0
- data/docs/Fox/FXFont.html +2998 -0
- data/docs/Fox/FXFontDesc.html +710 -0
- data/docs/Fox/FXFontDialog.html +420 -0
- data/docs/Fox/FXFontSelector.html +576 -0
- data/docs/Fox/FXFrame.html +1012 -0
- data/docs/Fox/FXGIFCursor.html +337 -0
- data/docs/Fox/FXGIFIcon.html +450 -0
- data/docs/Fox/FXGIFImage.html +434 -0
- data/docs/Fox/FXGLCanvas.html +700 -0
- data/docs/Fox/FXGLCone.html +785 -0
- data/docs/Fox/FXGLContext.html +649 -0
- data/docs/Fox/FXGLCube.html +703 -0
- data/docs/Fox/FXGLCylinder.html +791 -0
- data/docs/Fox/FXGLGroup.html +1385 -0
- data/docs/Fox/FXGLLine.html +653 -0
- data/docs/Fox/FXGLObject.html +759 -0
- data/docs/Fox/FXGLPoint.html +561 -0
- data/docs/Fox/FXGLShape.html +714 -0
- data/docs/Fox/FXGLSphere.html +626 -0
- data/docs/Fox/FXGLViewer.html +3506 -0
- data/docs/Fox/FXGLVisual.html +2147 -0
- data/docs/Fox/FXGradient.html +562 -0
- data/docs/Fox/FXGradientBar.html +2479 -0
- data/docs/Fox/FXGroupBox.html +688 -0
- data/docs/Fox/FXHeader.html +3040 -0
- data/docs/Fox/FXHeaderItem.html +1353 -0
- data/docs/Fox/FXHiliteStyle.html +804 -0
- data/docs/Fox/FXHorizontalFrame.html +359 -0
- data/docs/Fox/FXHorizontalSeparator.html +349 -0
- data/docs/Fox/FXICOIcon.html +450 -0
- data/docs/Fox/FXICOImage.html +434 -0
- data/docs/Fox/FXIcon.html +384 -0
- data/docs/Fox/FXIconDict.html +752 -0
- data/docs/Fox/FXIconItem.html +1518 -0
- data/docs/Fox/FXIconList.html +4676 -0
- data/docs/Fox/FXIconSource.html +963 -0
- data/docs/Fox/FXId.html +712 -0
- data/docs/Fox/FXImage.html +2328 -0
- data/docs/Fox/FXImageFrame.html +489 -0
- data/docs/Fox/FXImageView.html +504 -0
- data/docs/Fox/FXInputDialog.html +894 -0
- data/docs/Fox/FXIrb.html +942 -0
- data/docs/Fox/FXJPGIcon.html +607 -0
- data/docs/Fox/FXJPGImage.html +591 -0
- data/docs/Fox/FXKnob.html +1048 -0
- data/docs/Fox/FXLabel.html +1013 -0
- data/docs/Fox/FXLight.html +920 -0
- data/docs/Fox/FXList.html +3717 -0
- data/docs/Fox/FXListBox.html +2518 -0
- data/docs/Fox/FXListItem.html +1459 -0
- data/docs/Fox/FXMDIChild.html +2175 -0
- data/docs/Fox/FXMDIClient.html +781 -0
- data/docs/Fox/FXMDIDeleteButton.html +334 -0
- data/docs/Fox/FXMDIMaximizeButton.html +334 -0
- data/docs/Fox/FXMDIMenu.html +335 -0
- data/docs/Fox/FXMDIMinimizeButton.html +334 -0
- data/docs/Fox/FXMDIRestoreButton.html +334 -0
- data/docs/Fox/FXMDIWindowButton.html +334 -0
- data/docs/Fox/FXMainWindow.html +337 -0
- data/docs/Fox/FXMaterial.html +570 -0
- data/docs/Fox/FXMatrix.html +734 -0
- data/docs/Fox/FXMemoryBuffer.html +472 -0
- data/docs/Fox/FXMemoryStream.html +632 -0
- data/docs/Fox/FXMenuBar.html +347 -0
- data/docs/Fox/FXMenuButton.html +829 -0
- data/docs/Fox/FXMenuCaption.html +1080 -0
- data/docs/Fox/FXMenuCascade.html +388 -0
- data/docs/Fox/FXMenuCheck.html +721 -0
- data/docs/Fox/FXMenuCommand.html +400 -0
- data/docs/Fox/FXMenuPane.html +333 -0
- data/docs/Fox/FXMenuRadio.html +721 -0
- data/docs/Fox/FXMenuSeparator.html +440 -0
- data/docs/Fox/FXMenuTitle.html +405 -0
- data/docs/Fox/FXMessageBox.html +658 -0
- data/docs/Fox/FXObject.html +545 -0
- data/docs/Fox/FXOption.html +491 -0
- data/docs/Fox/FXOptionMenu.html +885 -0
- data/docs/Fox/FXPCXIcon.html +450 -0
- data/docs/Fox/FXPCXImage.html +434 -0
- data/docs/Fox/FXPNGIcon.html +524 -0
- data/docs/Fox/FXPNGImage.html +508 -0
- data/docs/Fox/FXPPMIcon.html +450 -0
- data/docs/Fox/FXPPMImage.html +373 -0
- data/docs/Fox/FXPSBounds.html +500 -0
- data/docs/Fox/FXPacker.html +1229 -0
- data/docs/Fox/FXPicker.html +345 -0
- data/docs/Fox/FXPopup.html +1099 -0
- data/docs/Fox/FXPrintDialog.html +485 -0
- data/docs/Fox/FXPrinter.html +1330 -0
- data/docs/Fox/FXProgressBar.html +1150 -0
- data/docs/Fox/FXProgressDialog.html +715 -0
- data/docs/Fox/FXPseudoKeyboard.html +428 -0
- data/docs/Fox/FXPseudoMouse.html +800 -0
- data/docs/Fox/FXPseudoTarget.html +472 -0
- data/docs/Fox/FXQuatd.html +1377 -0
- data/docs/Fox/FXQuatf.html +1392 -0
- data/docs/Fox/FXRGBIcon.html +450 -0
- data/docs/Fox/FXRGBImage.html +434 -0
- data/docs/Fox/FXRadioButton.html +885 -0
- data/docs/Fox/FXRanged.html +1522 -0
- data/docs/Fox/FXRangef.html +1522 -0
- data/docs/Fox/FXRealSlider.html +1187 -0
- data/docs/Fox/FXRealSpinner.html +2175 -0
- data/docs/Fox/FXRecentFiles.html +841 -0
- data/docs/Fox/FXRectangle.html +802 -0
- data/docs/Fox/FXRegion.html +841 -0
- data/docs/Fox/FXRegistry.html +682 -0
- data/docs/Fox/FXReplaceDialog.html +648 -0
- data/docs/Fox/FXRootWindow.html +312 -0
- data/docs/Fox/FXRuler.html +2000 -0
- data/docs/Fox/FXRulerView.html +3997 -0
- data/docs/Fox/FXScintilla.html +49117 -0
- data/docs/Fox/FXScrollArea.html +1363 -0
- data/docs/Fox/FXScrollBar.html +1019 -0
- data/docs/Fox/FXScrollCorner.html +290 -0
- data/docs/Fox/FXScrollPane.html +499 -0
- data/docs/Fox/FXScrollWindow.html +409 -0
- data/docs/Fox/FXSearchDialog.html +382 -0
- data/docs/Fox/FXSegment.html +422 -0
- data/docs/Fox/FXSeparator.html +402 -0
- data/docs/Fox/FXSettings.html +1861 -0
- data/docs/Fox/FXShell.html +233 -0
- data/docs/Fox/FXShutter.html +472 -0
- data/docs/Fox/FXShutterItem.html +669 -0
- data/docs/Fox/FXSize.html +592 -0
- data/docs/Fox/FXSlider.html +1129 -0
- data/docs/Fox/FXSphered.html +906 -0
- data/docs/Fox/FXSpheref.html +906 -0
- data/docs/Fox/FXSpinner.html +2102 -0
- data/docs/Fox/FXSplashScreen.html +497 -0
- data/docs/Fox/FXSplashWindow.html +494 -0
- data/docs/Fox/FXSplitter.html +643 -0
- data/docs/Fox/FXSpring.html +517 -0
- data/docs/Fox/FXStatusBar.html +593 -0
- data/docs/Fox/FXStatusLine.html +754 -0
- data/docs/Fox/FXStream.html +1372 -0
- data/docs/Fox/FXStreamAllocError.html +148 -0
- data/docs/Fox/FXStreamEndError.html +148 -0
- data/docs/Fox/FXStreamError.html +259 -0
- data/docs/Fox/FXStreamFailureError.html +148 -0
- data/docs/Fox/FXStreamFormatError.html +148 -0
- data/docs/Fox/FXStreamFullError.html +148 -0
- data/docs/Fox/FXStreamNoReadError.html +148 -0
- data/docs/Fox/FXStreamNoWriteError.html +148 -0
- data/docs/Fox/FXStreamUnknownError.html +148 -0
- data/docs/Fox/FXStringDict.html +552 -0
- data/docs/Fox/FXSwitcher.html +619 -0
- data/docs/Fox/FXTGAIcon.html +450 -0
- data/docs/Fox/FXTGAImage.html +434 -0
- data/docs/Fox/FXTIFIcon.html +604 -0
- data/docs/Fox/FXTIFImage.html +588 -0
- data/docs/Fox/FXTabBar.html +644 -0
- data/docs/Fox/FXTabBook.html +373 -0
- data/docs/Fox/FXTabItem.html +478 -0
- data/docs/Fox/FXTable.html +10107 -0
- data/docs/Fox/FXTableItem.html +2195 -0
- data/docs/Fox/FXTablePos.html +360 -0
- data/docs/Fox/FXTableRange.html +360 -0
- data/docs/Fox/FXText.html +6870 -0
- data/docs/Fox/FXTextChange.html +492 -0
- data/docs/Fox/FXTextField.html +2016 -0
- data/docs/Fox/FXToggleButton.html +844 -0
- data/docs/Fox/FXToolBar.html +452 -0
- data/docs/Fox/FXToolBarGrip.html +584 -0
- data/docs/Fox/FXToolBarShell.html +788 -0
- data/docs/Fox/FXToolBarTab.html +729 -0
- data/docs/Fox/FXToolTip.html +761 -0
- data/docs/Fox/FXTopWindow.html +1716 -0
- data/docs/Fox/FXTranslator.html +481 -0
- data/docs/Fox/FXTreeItem.html +2813 -0
- data/docs/Fox/FXTreeList.html +5095 -0
- data/docs/Fox/FXTreeListBox.html +3080 -0
- data/docs/Fox/FXTriStateButton.html +681 -0
- data/docs/Fox/FXUndoList.html +2560 -0
- data/docs/Fox/FXVec2d.html +1450 -0
- data/docs/Fox/FXVec2f.html +1442 -0
- data/docs/Fox/FXVec3d.html +1649 -0
- data/docs/Fox/FXVec3f.html +1649 -0
- data/docs/Fox/FXVec4d.html +1858 -0
- data/docs/Fox/FXVec4f.html +1858 -0
- data/docs/Fox/FXVerticalFrame.html +359 -0
- data/docs/Fox/FXVerticalSeparator.html +349 -0
- data/docs/Fox/FXViewport.html +780 -0
- data/docs/Fox/FXVisual.html +1023 -0
- data/docs/Fox/FXWindow.html +9948 -0
- data/docs/Fox/FXWizard.html +1052 -0
- data/docs/Fox/FXXBMIcon.html +453 -0
- data/docs/Fox/FXXBMImage.html +437 -0
- data/docs/Fox/FXXPMIcon.html +450 -0
- data/docs/Fox/FXXPMImage.html +434 -0
- data/docs/Fox/NotifyHeader.html +286 -0
- data/docs/Fox/SCNotification.html +1438 -0
- data/docs/Fox/TextRange.html +281 -0
- data/docs/IRB.html +204 -0
- data/docs/Responder.html +693 -0
- data/docs/Responder2.html +225 -0
- data/docs/_index.html +2101 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.History.html +869 -0
- data/docs/file.README.html +104 -0
- data/docs/file_list.html +66 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +614 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +31043 -0
- data/docs/top-level-namespace.html +214 -0
- data/examples/canvasdemo.rb +5 -1
- data/examples/gltest.rb +162 -106
- data/examples/glviewer.rb +12 -8
- data/examples/inputs.rb +9 -4
- data/examples/pig.rb +2 -2
- data/examples/unicode.rb +6 -27
- data/ext/fox16_c/FXRbApp.cpp +3 -17
- data/ext/fox16_c/FXRuby.cpp +36 -46
- data/ext/fox16_c/extconf.rb +50 -34
- data/ext/fox16_c/impl.cpp +1 -1
- data/ext/fox16_c/include/FXRbApp.h +2 -2
- data/ext/fox16_c/include/FXRbCommon.h +0 -2
- data/ext/fox16_c/include/FXRbText.h +82 -2
- data/ext/fox16_c/include/FXRbTextVirtuals.h +22 -0
- data/ext/fox16_c/include/FXRuby.h +21 -3
- data/ext/fox16_c/include/gvl_wrappers.h +29 -11
- data/ext/fox16_c/make_impl.rb +1 -1
- data/fxruby.gemspec +2 -1
- data/lib/fox16/aliases.rb +3 -0
- data/lib/fox16/bitmapview.rb +0 -0
- data/lib/fox16/calendar.rb +6 -8
- data/lib/fox16/canvas.rb +93 -62
- data/lib/fox16/chore.rb +0 -0
- data/lib/fox16/colors.rb +0 -0
- data/lib/fox16/core.rb +18 -18
- data/lib/fox16/dict.rb +0 -0
- data/lib/fox16/glgroup.rb +5 -5
- data/lib/fox16/glshapes.rb +111 -99
- data/lib/fox16/input.rb +9 -7
- data/lib/fox16/irb.rb +0 -0
- data/lib/fox16/iterators.rb +0 -0
- data/lib/fox16/keys.rb +0 -0
- data/lib/fox16/missingdep.rb +0 -0
- data/lib/fox16/pseudokeyboard.rb +0 -0
- data/lib/fox16/pseudomouse.rb +0 -0
- data/lib/fox16/responder.rb +0 -0
- data/lib/fox16/responder2.rb +0 -0
- data/lib/fox16/scintilla.rb +0 -0
- data/lib/fox16/settings.rb +0 -0
- data/lib/fox16/signal.rb +0 -0
- data/lib/fox16/timeout.rb +0 -0
- data/lib/fox16/tkcompat.rb +0 -0
- data/lib/fox16/undolist.rb +8 -8
- data/lib/fox16/version.rb +1 -1
- data/rdoc-sources/FXGLVisual.rb +1 -1
- data/rdoc-sources/FXIconList.rb +2 -0
- data/rdoc-sources/FXImage.rb +5 -0
- data/rdoc-sources/FXList.rb +2 -0
- data/rdoc-sources/FXListBox.rb +1 -1
- data/rdoc-sources/FXText.rb +4 -2
- data/swig-interfaces/FXImage.i +9 -4
- data/swig-interfaces/FXMemoryBuffer.i +2 -2
- data/swig-interfaces/FXText.i +10 -8
- data/swig-interfaces/macros.i +9 -0
- data/test/TC_FXImage.rb +8 -0
- data/test/TC_FXList.rb +8 -8
- data/test/TC_FXText.rb +19 -0
- data/test/TC_FXVec4f.rb +26 -12
- metadata +300 -10
|
@@ -0,0 +1,1372 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Fox::FXStream
|
|
8
|
+
|
|
9
|
+
— FXRuby API Documentation
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Fox::FXStream";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (F)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">FXStream</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Fox::FXStream
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Fox::FXStream</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>rdoc-sources/FXStream.rb<span class="defines">,<br />
|
|
98
|
+
lib/fox16/iterators.rb</span>
|
|
99
|
+
</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>A stream is a way to serialize data and objects into a byte stream. Each item of data that is saved or loaded from the stream may be byte-swapped, thus allowing little-endian machines to read data produced on big endian ones and vice-versa. Data is serialized exactly as-is. There are no tags or other markers inserted into the stream; thus, the stream may be used to save or load arbitrary binary data. Objects derived from FXObjects may be serialized also; whenever a reference to an object is serialized, a table is consulted to determine if the same object has been encountered previously; if not, the object is added to the table and then its contents are serialized. If the object has been encountered before, only a reference to the object is serialized. When loading back a serialized object, new instances are constructed using the default constructor, and subsequently the object's contents are loaded. A special container object may be passed in which is placed in the table as if it had been encountered before; this will cause only references to this object to be saved. The container object is typically the top-level document object which manages all objects contained by it. Additional objects may be added using addObject(); these will not be actually saved or loaded.</p>
|
|
108
|
+
|
|
109
|
+
<h3 id="label-Stream+status+codes">Stream status codes</h3>
|
|
110
|
+
<dl class="rdoc-list note-list"><dt><code>FXStreamOK</code>
|
|
111
|
+
<dd>
|
|
112
|
+
<p>OK</p>
|
|
113
|
+
</dd><dt><code>FXStreamEnd</code>
|
|
114
|
+
<dd>
|
|
115
|
+
<p>Try read past end of stream</p>
|
|
116
|
+
</dd><dt><code>FXStreamFull</code>
|
|
117
|
+
<dd>
|
|
118
|
+
<p>Filled up stream buffer or disk full</p>
|
|
119
|
+
</dd><dt><code>FXStreamNoWrite</code>
|
|
120
|
+
<dd>
|
|
121
|
+
<p>Unable to open for write</p>
|
|
122
|
+
</dd><dt><code>FXStreamNoRead</code>
|
|
123
|
+
<dd>
|
|
124
|
+
<p>Unable to open for read</p>
|
|
125
|
+
</dd><dt><code>FXStreamFormat</code>
|
|
126
|
+
<dd>
|
|
127
|
+
<p>Stream format error</p>
|
|
128
|
+
</dd><dt><code>FXStreamUnknown</code>
|
|
129
|
+
<dd>
|
|
130
|
+
<p>Trying to read unknown class</p>
|
|
131
|
+
</dd><dt><code>FXStreamAlloc</code>
|
|
132
|
+
<dd>
|
|
133
|
+
<p>Alloc failed</p>
|
|
134
|
+
</dd><dt><code>FXStreamFailure</code>
|
|
135
|
+
<dd>
|
|
136
|
+
<p>General failure</p>
|
|
137
|
+
</dd></dl>
|
|
138
|
+
|
|
139
|
+
<h3 id="label-Stream+data+flow+direction">Stream data flow direction</h3>
|
|
140
|
+
<dl class="rdoc-list note-list"><dt><code>FXStreamDead</code>
|
|
141
|
+
<dd>
|
|
142
|
+
<p>Unopened stream</p>
|
|
143
|
+
</dd><dt><code>FXStreamSave</code>
|
|
144
|
+
<dd>
|
|
145
|
+
<p>Saving stuff to stream</p>
|
|
146
|
+
</dd><dt><code>FXStreamLoad</code>
|
|
147
|
+
<dd>
|
|
148
|
+
<p>Loading stuff from stream</p>
|
|
149
|
+
</dd></dl>
|
|
150
|
+
|
|
151
|
+
<h3 id="label-Stream+seeking">Stream seeking</h3>
|
|
152
|
+
<dl class="rdoc-list note-list"><dt><code>FXFromStart</code>
|
|
153
|
+
<dd>
|
|
154
|
+
<p>Seek from start position</p>
|
|
155
|
+
</dd><dt><code>FXFromCurrent</code>
|
|
156
|
+
<dd>
|
|
157
|
+
<p>Seek from current position</p>
|
|
158
|
+
</dd><dt><code>FXFromEnd</code>
|
|
159
|
+
<dd>
|
|
160
|
+
<p>Seek from end position</p>
|
|
161
|
+
</dd></dl>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</div>
|
|
165
|
+
</div>
|
|
166
|
+
<div class="tags">
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</div><div id="subclasses">
|
|
170
|
+
<h2>Direct Known Subclasses</h2>
|
|
171
|
+
<p class="children"><span class='object_link'><a href="FXFileStream.html" title="Fox::FXFileStream (class)">FXFileStream</a></span>, <span class='object_link'><a href="FXMemoryStream.html" title="Fox::FXMemoryStream (class)">FXMemoryStream</a></span></p>
|
|
172
|
+
</div>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
178
|
+
<ul class="summary">
|
|
179
|
+
|
|
180
|
+
<li class="public ">
|
|
181
|
+
<span class="summary_signature">
|
|
182
|
+
|
|
183
|
+
<a href="#container-instance_method" title="#container (instance method)">#<strong>container</strong> ⇒ Object </a>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</span>
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<span class="note title readonly">readonly</span>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<span class="summary_desc"><div class='inline'>
|
|
203
|
+
<p>Parent object <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span>.</p>
|
|
204
|
+
</div></span>
|
|
205
|
+
|
|
206
|
+
</li>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<li class="public ">
|
|
210
|
+
<span class="summary_signature">
|
|
211
|
+
|
|
212
|
+
<a href="#direction-instance_method" title="#direction (instance method)">#<strong>direction</strong> ⇒ Object </a>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
</span>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<span class="note title readonly">readonly</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class="summary_desc"><div class='inline'>
|
|
232
|
+
<p>Stream direction, one of <code>FXStreamSave</code>, <code>FXStreamLoad</code> or <code>FXStreamDead</code>.</p>
|
|
233
|
+
</div></span>
|
|
234
|
+
|
|
235
|
+
</li>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<li class="public ">
|
|
239
|
+
<span class="summary_signature">
|
|
240
|
+
|
|
241
|
+
<a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> ⇒ Object </a>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</span>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<span class="summary_desc"><div class='inline'>
|
|
259
|
+
<p>Stream position (an offset from the beginning of the stream) [Integer].</p>
|
|
260
|
+
</div></span>
|
|
261
|
+
|
|
262
|
+
</li>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<li class="public ">
|
|
266
|
+
<span class="summary_signature">
|
|
267
|
+
|
|
268
|
+
<a href="#space-instance_method" title="#space (instance method)">#<strong>space</strong> ⇒ Object </a>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
</span>
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<span class="summary_desc"><div class='inline'>
|
|
286
|
+
<p>Available buffer space.</p>
|
|
287
|
+
</div></span>
|
|
288
|
+
|
|
289
|
+
</li>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<li class="public ">
|
|
293
|
+
<span class="summary_signature">
|
|
294
|
+
|
|
295
|
+
<a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> ⇒ Object </a>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
</span>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<span class="note title readonly">readonly</span>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
<span class="summary_desc"><div class='inline'>
|
|
315
|
+
<p>Stream status [Integer].</p>
|
|
316
|
+
</div></span>
|
|
317
|
+
|
|
318
|
+
</li>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
</ul>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<h2>
|
|
328
|
+
Instance Method Summary
|
|
329
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
330
|
+
</h2>
|
|
331
|
+
|
|
332
|
+
<ul class="summary">
|
|
333
|
+
|
|
334
|
+
<li class="public ">
|
|
335
|
+
<span class="summary_signature">
|
|
336
|
+
|
|
337
|
+
<a href="#bigEndian=-instance_method" title="#bigEndian= (instance method)">#<strong>bigEndian=</strong>(big) ⇒ Object </a>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
</span>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class="summary_desc"><div class='inline'>
|
|
352
|
+
<p>Set stream to big endian mode if <code>true</code>.</p>
|
|
353
|
+
</div></span>
|
|
354
|
+
|
|
355
|
+
</li>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<li class="public ">
|
|
359
|
+
<span class="summary_signature">
|
|
360
|
+
|
|
361
|
+
<a href="#bigEndian%3F-instance_method" title="#bigEndian? (instance method)">#<strong>bigEndian?</strong> ⇒ Boolean </a>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<span class="summary_desc"><div class='inline'>
|
|
376
|
+
<p>Return <code>true</code> if big endian mode.</p>
|
|
377
|
+
</div></span>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<li class="public ">
|
|
383
|
+
<span class="summary_signature">
|
|
384
|
+
|
|
385
|
+
<a href="#bytesSwapped=-instance_method" title="#bytesSwapped= (instance method)">#<strong>bytesSwapped=</strong>(swapBytes) ⇒ Object </a>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<span class="summary_desc"><div class='inline'>
|
|
400
|
+
<p>Set the byte-swapped flag to <code>true</code> or <code>false</code>.</p>
|
|
401
|
+
</div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#bytesSwapped%3F-instance_method" title="#bytesSwapped? (instance method)">#<strong>bytesSwapped?</strong> ⇒ Boolean </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'>
|
|
424
|
+
<p>Returns <code>true</code> if bytes are swapped for this stream.</p>
|
|
425
|
+
</div></span>
|
|
426
|
+
|
|
427
|
+
</li>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
<li class="public ">
|
|
431
|
+
<span class="summary_signature">
|
|
432
|
+
|
|
433
|
+
<a href="#close-instance_method" title="#close (instance method)">#<strong>close</strong> ⇒ Object </a>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
</span>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<span class="summary_desc"><div class='inline'>
|
|
448
|
+
<p>Close stream; returns <code>true</code> if OK.</p>
|
|
449
|
+
</div></span>
|
|
450
|
+
|
|
451
|
+
</li>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<li class="public ">
|
|
455
|
+
<span class="summary_signature">
|
|
456
|
+
|
|
457
|
+
<a href="#eof%3F-instance_method" title="#eof? (instance method)">#<strong>eof?</strong> ⇒ Boolean </a>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
</span>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<span class="summary_desc"><div class='inline'>
|
|
472
|
+
<p>Return <code>true</code> if at end of file or error.</p>
|
|
473
|
+
</div></span>
|
|
474
|
+
|
|
475
|
+
</li>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<li class="public ">
|
|
479
|
+
<span class="summary_signature">
|
|
480
|
+
|
|
481
|
+
<a href="#error=-instance_method" title="#error= (instance method)">#<strong>error=</strong>(err) ⇒ Object </a>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
</span>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<span class="summary_desc"><div class='inline'>
|
|
496
|
+
<p>Set status code, where <em>err</em> is one of the stream status codes listed above.</p>
|
|
497
|
+
</div></span>
|
|
498
|
+
|
|
499
|
+
</li>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<li class="public ">
|
|
503
|
+
<span class="summary_signature">
|
|
504
|
+
|
|
505
|
+
<a href="#flush-instance_method" title="#flush (instance method)">#<strong>flush</strong> ⇒ Object </a>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</span>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<span class="summary_desc"><div class='inline'>
|
|
520
|
+
<p>Flush buffer.</p>
|
|
521
|
+
</div></span>
|
|
522
|
+
|
|
523
|
+
</li>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<li class="public ">
|
|
527
|
+
<span class="summary_signature">
|
|
528
|
+
|
|
529
|
+
<a href="#getSpace-instance_method" title="#getSpace (instance method)">#<strong>getSpace</strong> ⇒ Object </a>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
</span>
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<span class="summary_desc"><div class='inline'>
|
|
544
|
+
<p>Get available buffer space.</p>
|
|
545
|
+
</div></span>
|
|
546
|
+
|
|
547
|
+
</li>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<li class="public ">
|
|
551
|
+
<span class="summary_signature">
|
|
552
|
+
|
|
553
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(cont = nil) ⇒ FXStream </a>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
</span>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<span class="note title constructor">constructor</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<span class="summary_desc"><div class='inline'>
|
|
570
|
+
<p>Construct stream with given container object.</p>
|
|
571
|
+
</div></span>
|
|
572
|
+
|
|
573
|
+
</li>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
<li class="public ">
|
|
577
|
+
<span class="summary_signature">
|
|
578
|
+
|
|
579
|
+
<a href="#open-instance_method" title="#open (instance method)">#<strong>open</strong>(save_or_load, size = 8192, data = nil) ⇒ Object </a>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</span>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<span class="summary_desc"><div class='inline'>
|
|
594
|
+
<p>Open stream for reading or for writing.</p>
|
|
595
|
+
</div></span>
|
|
596
|
+
|
|
597
|
+
</li>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
<li class="public ">
|
|
601
|
+
<span class="summary_signature">
|
|
602
|
+
|
|
603
|
+
<a href="#setSpace-instance_method" title="#setSpace (instance method)">#<strong>setSpace</strong>(sp) ⇒ Object </a>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
</span>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<span class="summary_desc"><div class='inline'>
|
|
618
|
+
<p>Set available buffer space.</p>
|
|
619
|
+
</div></span>
|
|
620
|
+
|
|
621
|
+
</li>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</ul>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<div id="constructor_details" class="method_details_list">
|
|
628
|
+
<h2>Constructor Details</h2>
|
|
629
|
+
|
|
630
|
+
<div class="method_details first">
|
|
631
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
632
|
+
|
|
633
|
+
#<strong>initialize</strong>(cont = nil) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXStream (class)">FXStream</a></span></tt>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
</h3><div class="docstring">
|
|
640
|
+
<div class="discussion">
|
|
641
|
+
|
|
642
|
+
<p>Construct stream with given container object. The container object is an object that will itself not be saved to or loaded from the stream, but which may be referenced by other objects. These references will be properly saved and restored.</p>
|
|
643
|
+
|
|
644
|
+
<h4 id="label-Parameters-3A">Parameters:</h4>
|
|
645
|
+
<dl class="rdoc-list note-list"><dt><code>cont</code>
|
|
646
|
+
<dd>
|
|
647
|
+
<p>the container object, or <code>nil</code> if there is none <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">Fox::FXObject</a></span>.</p>
|
|
648
|
+
</dd></dl>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
</div>
|
|
652
|
+
</div>
|
|
653
|
+
<div class="tags">
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
</div><table class="source_code">
|
|
657
|
+
<tr>
|
|
658
|
+
<td>
|
|
659
|
+
<pre class="lines">
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
74
|
|
663
|
+
75</pre>
|
|
664
|
+
</td>
|
|
665
|
+
<td>
|
|
666
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 74</span>
|
|
667
|
+
|
|
668
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_cont'>cont</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span> <span class='comment'># :yields: theStream
|
|
669
|
+
</span><span class='kw'>end</span></pre>
|
|
670
|
+
</td>
|
|
671
|
+
</tr>
|
|
672
|
+
</table>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
<div id="instance_attr_details" class="attr_details">
|
|
678
|
+
<h2>Instance Attribute Details</h2>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<span id=""></span>
|
|
682
|
+
<div class="method_details first">
|
|
683
|
+
<h3 class="signature first" id="container-instance_method">
|
|
684
|
+
|
|
685
|
+
#<strong>container</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</h3><div class="docstring">
|
|
692
|
+
<div class="discussion">
|
|
693
|
+
|
|
694
|
+
<p>Parent object <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">Fox::FXObject</a></span></p>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
</div>
|
|
698
|
+
</div>
|
|
699
|
+
<div class="tags">
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
</div><table class="source_code">
|
|
703
|
+
<tr>
|
|
704
|
+
<td>
|
|
705
|
+
<pre class="lines">
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
56
|
|
709
|
+
57
|
|
710
|
+
58</pre>
|
|
711
|
+
</td>
|
|
712
|
+
<td>
|
|
713
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 56</span>
|
|
714
|
+
|
|
715
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_container'>container</span>
|
|
716
|
+
<span class='ivar'>@container</span>
|
|
717
|
+
<span class='kw'>end</span></pre>
|
|
718
|
+
</td>
|
|
719
|
+
</tr>
|
|
720
|
+
</table>
|
|
721
|
+
</div>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<span id=""></span>
|
|
725
|
+
<div class="method_details ">
|
|
726
|
+
<h3 class="signature " id="direction-instance_method">
|
|
727
|
+
|
|
728
|
+
#<strong>direction</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
</h3><div class="docstring">
|
|
735
|
+
<div class="discussion">
|
|
736
|
+
|
|
737
|
+
<p>Stream direction, one of <code>FXStreamSave</code>, <code>FXStreamLoad</code> or <code>FXStreamDead</code>.</p>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
</div>
|
|
741
|
+
</div>
|
|
742
|
+
<div class="tags">
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
</div><table class="source_code">
|
|
746
|
+
<tr>
|
|
747
|
+
<td>
|
|
748
|
+
<pre class="lines">
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
53
|
|
752
|
+
54
|
|
753
|
+
55</pre>
|
|
754
|
+
</td>
|
|
755
|
+
<td>
|
|
756
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 53</span>
|
|
757
|
+
|
|
758
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_direction'>direction</span>
|
|
759
|
+
<span class='ivar'>@direction</span>
|
|
760
|
+
<span class='kw'>end</span></pre>
|
|
761
|
+
</td>
|
|
762
|
+
</tr>
|
|
763
|
+
</table>
|
|
764
|
+
</div>
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
<span id="position=-instance_method"></span>
|
|
768
|
+
<div class="method_details ">
|
|
769
|
+
<h3 class="signature " id="position-instance_method">
|
|
770
|
+
|
|
771
|
+
#<strong>position</strong> ⇒ <tt>Object</tt>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
</h3><div class="docstring">
|
|
778
|
+
<div class="discussion">
|
|
779
|
+
|
|
780
|
+
<p>Stream position (an offset from the beginning of the stream) [Integer]</p>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</div>
|
|
784
|
+
</div>
|
|
785
|
+
<div class="tags">
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
</div><table class="source_code">
|
|
789
|
+
<tr>
|
|
790
|
+
<td>
|
|
791
|
+
<pre class="lines">
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
62
|
|
795
|
+
63
|
|
796
|
+
64</pre>
|
|
797
|
+
</td>
|
|
798
|
+
<td>
|
|
799
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 62</span>
|
|
800
|
+
|
|
801
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
|
|
802
|
+
<span class='ivar'>@position</span>
|
|
803
|
+
<span class='kw'>end</span></pre>
|
|
804
|
+
</td>
|
|
805
|
+
</tr>
|
|
806
|
+
</table>
|
|
807
|
+
</div>
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
<span id="space=-instance_method"></span>
|
|
811
|
+
<div class="method_details ">
|
|
812
|
+
<h3 class="signature " id="space-instance_method">
|
|
813
|
+
|
|
814
|
+
#<strong>space</strong> ⇒ <tt>Object</tt>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
</h3><div class="docstring">
|
|
821
|
+
<div class="discussion">
|
|
822
|
+
|
|
823
|
+
<p>Available buffer space</p>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
</div>
|
|
827
|
+
</div>
|
|
828
|
+
<div class="tags">
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
</div><table class="source_code">
|
|
832
|
+
<tr>
|
|
833
|
+
<td>
|
|
834
|
+
<pre class="lines">
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
59
|
|
838
|
+
60
|
|
839
|
+
61</pre>
|
|
840
|
+
</td>
|
|
841
|
+
<td>
|
|
842
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 59</span>
|
|
843
|
+
|
|
844
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_space'>space</span>
|
|
845
|
+
<span class='ivar'>@space</span>
|
|
846
|
+
<span class='kw'>end</span></pre>
|
|
847
|
+
</td>
|
|
848
|
+
</tr>
|
|
849
|
+
</table>
|
|
850
|
+
</div>
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
<span id=""></span>
|
|
854
|
+
<div class="method_details ">
|
|
855
|
+
<h3 class="signature " id="status-instance_method">
|
|
856
|
+
|
|
857
|
+
#<strong>status</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
</h3><div class="docstring">
|
|
864
|
+
<div class="discussion">
|
|
865
|
+
|
|
866
|
+
<p>Stream status [Integer]</p>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
</div>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="tags">
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
</div><table class="source_code">
|
|
875
|
+
<tr>
|
|
876
|
+
<td>
|
|
877
|
+
<pre class="lines">
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
50
|
|
881
|
+
51
|
|
882
|
+
52</pre>
|
|
883
|
+
</td>
|
|
884
|
+
<td>
|
|
885
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 50</span>
|
|
886
|
+
|
|
887
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
|
888
|
+
<span class='ivar'>@status</span>
|
|
889
|
+
<span class='kw'>end</span></pre>
|
|
890
|
+
</td>
|
|
891
|
+
</tr>
|
|
892
|
+
</table>
|
|
893
|
+
</div>
|
|
894
|
+
|
|
895
|
+
</div>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
<div id="instance_method_details" class="method_details_list">
|
|
899
|
+
<h2>Instance Method Details</h2>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
<div class="method_details first">
|
|
903
|
+
<h3 class="signature first" id="bigEndian=-instance_method">
|
|
904
|
+
|
|
905
|
+
#<strong>bigEndian=</strong>(big) ⇒ <tt>Object</tt>
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
</h3><div class="docstring">
|
|
912
|
+
<div class="discussion">
|
|
913
|
+
|
|
914
|
+
<p>Set stream to big endian mode if <code>true</code>. Byte swapping will be enabled if the machine native byte order is not equal to the desired byte order.</p>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
</div>
|
|
918
|
+
</div>
|
|
919
|
+
<div class="tags">
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
</div><table class="source_code">
|
|
923
|
+
<tr>
|
|
924
|
+
<td>
|
|
925
|
+
<pre class="lines">
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
134</pre>
|
|
929
|
+
</td>
|
|
930
|
+
<td>
|
|
931
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 134</span>
|
|
932
|
+
|
|
933
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bigEndian='>bigEndian=</span><span class='lparen'>(</span><span class='id identifier rubyid_big'>big</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
934
|
+
</td>
|
|
935
|
+
</tr>
|
|
936
|
+
</table>
|
|
937
|
+
</div>
|
|
938
|
+
|
|
939
|
+
<div class="method_details ">
|
|
940
|
+
<h3 class="signature " id="bigEndian?-instance_method">
|
|
941
|
+
|
|
942
|
+
#<strong>bigEndian?</strong> ⇒ <tt>Boolean</tt>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
</h3><div class="docstring">
|
|
949
|
+
<div class="discussion">
|
|
950
|
+
|
|
951
|
+
<p>Return <code>true</code> if big endian mode.</p>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
</div>
|
|
955
|
+
</div>
|
|
956
|
+
<div class="tags">
|
|
957
|
+
|
|
958
|
+
<p class="tag_title">Returns:</p>
|
|
959
|
+
<ul class="return">
|
|
960
|
+
|
|
961
|
+
<li>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
</li>
|
|
969
|
+
|
|
970
|
+
</ul>
|
|
971
|
+
|
|
972
|
+
</div><table class="source_code">
|
|
973
|
+
<tr>
|
|
974
|
+
<td>
|
|
975
|
+
<pre class="lines">
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
139</pre>
|
|
979
|
+
</td>
|
|
980
|
+
<td>
|
|
981
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 139</span>
|
|
982
|
+
|
|
983
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bigEndian?'>bigEndian?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
984
|
+
</td>
|
|
985
|
+
</tr>
|
|
986
|
+
</table>
|
|
987
|
+
</div>
|
|
988
|
+
|
|
989
|
+
<div class="method_details ">
|
|
990
|
+
<h3 class="signature " id="bytesSwapped=-instance_method">
|
|
991
|
+
|
|
992
|
+
#<strong>bytesSwapped=</strong>(swapBytes) ⇒ <tt>Object</tt>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
</h3><div class="docstring">
|
|
999
|
+
<div class="discussion">
|
|
1000
|
+
|
|
1001
|
+
<p>Set the byte-swapped flag to <code>true</code> or <code>false</code>.</p>
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
</div>
|
|
1005
|
+
</div>
|
|
1006
|
+
<div class="tags">
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
</div><table class="source_code">
|
|
1010
|
+
<tr>
|
|
1011
|
+
<td>
|
|
1012
|
+
<pre class="lines">
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
124</pre>
|
|
1016
|
+
</td>
|
|
1017
|
+
<td>
|
|
1018
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 124</span>
|
|
1019
|
+
|
|
1020
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bytesSwapped='>bytesSwapped=</span><span class='lparen'>(</span><span class='id identifier rubyid_swapBytes'>swapBytes</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1021
|
+
</td>
|
|
1022
|
+
</tr>
|
|
1023
|
+
</table>
|
|
1024
|
+
</div>
|
|
1025
|
+
|
|
1026
|
+
<div class="method_details ">
|
|
1027
|
+
<h3 class="signature " id="bytesSwapped?-instance_method">
|
|
1028
|
+
|
|
1029
|
+
#<strong>bytesSwapped?</strong> ⇒ <tt>Boolean</tt>
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
</h3><div class="docstring">
|
|
1036
|
+
<div class="discussion">
|
|
1037
|
+
|
|
1038
|
+
<p>Returns <code>true</code> if bytes are swapped for this stream</p>
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
</div>
|
|
1042
|
+
</div>
|
|
1043
|
+
<div class="tags">
|
|
1044
|
+
|
|
1045
|
+
<p class="tag_title">Returns:</p>
|
|
1046
|
+
<ul class="return">
|
|
1047
|
+
|
|
1048
|
+
<li>
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
</li>
|
|
1056
|
+
|
|
1057
|
+
</ul>
|
|
1058
|
+
|
|
1059
|
+
</div><table class="source_code">
|
|
1060
|
+
<tr>
|
|
1061
|
+
<td>
|
|
1062
|
+
<pre class="lines">
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
127</pre>
|
|
1066
|
+
</td>
|
|
1067
|
+
<td>
|
|
1068
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 127</span>
|
|
1069
|
+
|
|
1070
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bytesSwapped?'>bytesSwapped?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1071
|
+
</td>
|
|
1072
|
+
</tr>
|
|
1073
|
+
</table>
|
|
1074
|
+
</div>
|
|
1075
|
+
|
|
1076
|
+
<div class="method_details ">
|
|
1077
|
+
<h3 class="signature " id="close-instance_method">
|
|
1078
|
+
|
|
1079
|
+
#<strong>close</strong> ⇒ <tt>Object</tt>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</h3><div class="docstring">
|
|
1086
|
+
<div class="discussion">
|
|
1087
|
+
|
|
1088
|
+
<p>Close stream; returns <code>true</code> if OK.</p>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
</div>
|
|
1092
|
+
</div>
|
|
1093
|
+
<div class="tags">
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</div><table class="source_code">
|
|
1097
|
+
<tr>
|
|
1098
|
+
<td>
|
|
1099
|
+
<pre class="lines">
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
95</pre>
|
|
1103
|
+
</td>
|
|
1104
|
+
<td>
|
|
1105
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 95</span>
|
|
1106
|
+
|
|
1107
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_close'>close</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1108
|
+
</td>
|
|
1109
|
+
</tr>
|
|
1110
|
+
</table>
|
|
1111
|
+
</div>
|
|
1112
|
+
|
|
1113
|
+
<div class="method_details ">
|
|
1114
|
+
<h3 class="signature " id="eof?-instance_method">
|
|
1115
|
+
|
|
1116
|
+
#<strong>eof?</strong> ⇒ <tt>Boolean</tt>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
</h3><div class="docstring">
|
|
1123
|
+
<div class="discussion">
|
|
1124
|
+
|
|
1125
|
+
<p>Return <code>true</code> if at end of file or error.</p>
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
</div>
|
|
1129
|
+
</div>
|
|
1130
|
+
<div class="tags">
|
|
1131
|
+
|
|
1132
|
+
<p class="tag_title">Returns:</p>
|
|
1133
|
+
<ul class="return">
|
|
1134
|
+
|
|
1135
|
+
<li>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</li>
|
|
1143
|
+
|
|
1144
|
+
</ul>
|
|
1145
|
+
|
|
1146
|
+
</div><table class="source_code">
|
|
1147
|
+
<tr>
|
|
1148
|
+
<td>
|
|
1149
|
+
<pre class="lines">
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
115</pre>
|
|
1153
|
+
</td>
|
|
1154
|
+
<td>
|
|
1155
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 115</span>
|
|
1156
|
+
|
|
1157
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_eof?'>eof?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1158
|
+
</td>
|
|
1159
|
+
</tr>
|
|
1160
|
+
</table>
|
|
1161
|
+
</div>
|
|
1162
|
+
|
|
1163
|
+
<div class="method_details ">
|
|
1164
|
+
<h3 class="signature " id="error=-instance_method">
|
|
1165
|
+
|
|
1166
|
+
#<strong>error=</strong>(err) ⇒ <tt>Object</tt>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
</h3><div class="docstring">
|
|
1173
|
+
<div class="discussion">
|
|
1174
|
+
|
|
1175
|
+
<p>Set status code, where <em>err</em> is one of the stream status codes listed above.</p>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
</div>
|
|
1179
|
+
</div>
|
|
1180
|
+
<div class="tags">
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
</div><table class="source_code">
|
|
1184
|
+
<tr>
|
|
1185
|
+
<td>
|
|
1186
|
+
<pre class="lines">
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
121</pre>
|
|
1190
|
+
</td>
|
|
1191
|
+
<td>
|
|
1192
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 121</span>
|
|
1193
|
+
|
|
1194
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_error='>error=</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1195
|
+
</td>
|
|
1196
|
+
</tr>
|
|
1197
|
+
</table>
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
<div class="method_details ">
|
|
1201
|
+
<h3 class="signature " id="flush-instance_method">
|
|
1202
|
+
|
|
1203
|
+
#<strong>flush</strong> ⇒ <tt>Object</tt>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
</h3><div class="docstring">
|
|
1210
|
+
<div class="discussion">
|
|
1211
|
+
|
|
1212
|
+
<p>Flush buffer</p>
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
</div>
|
|
1216
|
+
</div>
|
|
1217
|
+
<div class="tags">
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
</div><table class="source_code">
|
|
1221
|
+
<tr>
|
|
1222
|
+
<td>
|
|
1223
|
+
<pre class="lines">
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
100</pre>
|
|
1227
|
+
</td>
|
|
1228
|
+
<td>
|
|
1229
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 100</span>
|
|
1230
|
+
|
|
1231
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_flush'>flush</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1232
|
+
</td>
|
|
1233
|
+
</tr>
|
|
1234
|
+
</table>
|
|
1235
|
+
</div>
|
|
1236
|
+
|
|
1237
|
+
<div class="method_details ">
|
|
1238
|
+
<h3 class="signature " id="getSpace-instance_method">
|
|
1239
|
+
|
|
1240
|
+
#<strong>getSpace</strong> ⇒ <tt>Object</tt>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
</h3><div class="docstring">
|
|
1247
|
+
<div class="discussion">
|
|
1248
|
+
|
|
1249
|
+
<p>Get available buffer space</p>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
</div>
|
|
1253
|
+
</div>
|
|
1254
|
+
<div class="tags">
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
</div><table class="source_code">
|
|
1258
|
+
<tr>
|
|
1259
|
+
<td>
|
|
1260
|
+
<pre class="lines">
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
105</pre>
|
|
1264
|
+
</td>
|
|
1265
|
+
<td>
|
|
1266
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 105</span>
|
|
1267
|
+
|
|
1268
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_getSpace'>getSpace</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1269
|
+
</td>
|
|
1270
|
+
</tr>
|
|
1271
|
+
</table>
|
|
1272
|
+
</div>
|
|
1273
|
+
|
|
1274
|
+
<div class="method_details ">
|
|
1275
|
+
<h3 class="signature " id="open-instance_method">
|
|
1276
|
+
|
|
1277
|
+
#<strong>open</strong>(save_or_load, size = 8192, data = nil) ⇒ <tt>Object</tt>
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
</h3><div class="docstring">
|
|
1284
|
+
<div class="discussion">
|
|
1285
|
+
|
|
1286
|
+
<p>Open stream for reading or for writing. An initial buffer size may be given, which must be at least 16 bytes. If <em>data</em> is not <code>nil</code>, it is expected to point to an external data buffer of length <em>size</em>; otherwise the stream will use an internally managed buffer. Returns <code>true</code> on success, <code>false</code> otherwise.</p>
|
|
1287
|
+
|
|
1288
|
+
<h4 id="label-Parameters-3A">Parameters:</h4>
|
|
1289
|
+
<dl class="rdoc-list note-list"><dt><code>save_or_load</code>
|
|
1290
|
+
<dd>
|
|
1291
|
+
<p>access mode, either <code>FXStreamSave</code> or <code>FXStreamLoad</code> [Integer]</p>
|
|
1292
|
+
</dd><dt><code>size</code>
|
|
1293
|
+
<dd>
|
|
1294
|
+
<p>initial buffer size [Integer]</p>
|
|
1295
|
+
</dd><dt><code>data</code>
|
|
1296
|
+
<dd>
|
|
1297
|
+
<p>external data buffer (if any) [String]</p>
|
|
1298
|
+
</dd></dl>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
</div>
|
|
1302
|
+
</div>
|
|
1303
|
+
<div class="tags">
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
</div><table class="source_code">
|
|
1307
|
+
<tr>
|
|
1308
|
+
<td>
|
|
1309
|
+
<pre class="lines">
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
90</pre>
|
|
1313
|
+
</td>
|
|
1314
|
+
<td>
|
|
1315
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 90</span>
|
|
1316
|
+
|
|
1317
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_save_or_load'>save_or_load</span><span class='comma'>,</span> <span class='id identifier rubyid_size'>size</span><span class='op'>=</span><span class='int'>8192</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1318
|
+
</td>
|
|
1319
|
+
</tr>
|
|
1320
|
+
</table>
|
|
1321
|
+
</div>
|
|
1322
|
+
|
|
1323
|
+
<div class="method_details ">
|
|
1324
|
+
<h3 class="signature " id="setSpace-instance_method">
|
|
1325
|
+
|
|
1326
|
+
#<strong>setSpace</strong>(sp) ⇒ <tt>Object</tt>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
</h3><div class="docstring">
|
|
1333
|
+
<div class="discussion">
|
|
1334
|
+
|
|
1335
|
+
<p>Set available buffer space</p>
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
</div>
|
|
1339
|
+
</div>
|
|
1340
|
+
<div class="tags">
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
</div><table class="source_code">
|
|
1344
|
+
<tr>
|
|
1345
|
+
<td>
|
|
1346
|
+
<pre class="lines">
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
110</pre>
|
|
1350
|
+
</td>
|
|
1351
|
+
<td>
|
|
1352
|
+
<pre class="code"><span class="info file"># File 'rdoc-sources/FXStream.rb', line 110</span>
|
|
1353
|
+
|
|
1354
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_setSpace'>setSpace</span><span class='lparen'>(</span><span class='id identifier rubyid_sp'>sp</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
|
1355
|
+
</td>
|
|
1356
|
+
</tr>
|
|
1357
|
+
</table>
|
|
1358
|
+
</div>
|
|
1359
|
+
|
|
1360
|
+
</div>
|
|
1361
|
+
|
|
1362
|
+
</div>
|
|
1363
|
+
|
|
1364
|
+
<div id="footer">
|
|
1365
|
+
Generated on Fri Nov 27 21:10:44 2020 by
|
|
1366
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1367
|
+
0.9.24 (ruby-2.7.2).
|
|
1368
|
+
</div>
|
|
1369
|
+
|
|
1370
|
+
</div>
|
|
1371
|
+
</body>
|
|
1372
|
+
</html>
|