rubyXL 3.4.33 → 3.4.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (410) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +9 -9
  3. data/Gemfile +1 -1
  4. data/README.rdoc +4 -2
  5. data/VERSION +1 -1
  6. data/lib/rubyXL/convenience_methods/cell.rb +5 -4
  7. data/lib/rubyXL/convenience_methods/workbook.rb +4 -0
  8. data/lib/rubyXL/objects/cell_style.rb +1 -0
  9. data/lib/rubyXL/objects/ooxml_object.rb +5 -3
  10. data/lib/rubyXL/objects/root.rb +1 -1
  11. data/rdoc/README_rdoc.html +363 -63
  12. data/rdoc/RubyXL/AExtension.html +157 -50
  13. data/rdoc/RubyXL/AExtensionStorageArea.html +69 -22
  14. data/rdoc/RubyXL/ActiveX.html +119 -38
  15. data/rdoc/RubyXL/ActiveXBinary.html +78 -23
  16. data/rdoc/RubyXL/AdjustHandleList.html +69 -22
  17. data/rdoc/RubyXL/Alignment.html +69 -22
  18. data/rdoc/RubyXL/AlternateContent.html +69 -22
  19. data/rdoc/RubyXL/AlternateUrls.html +69 -22
  20. data/rdoc/RubyXL/Authors.html +69 -22
  21. data/rdoc/RubyXL/AutoFilter.html +69 -22
  22. data/rdoc/RubyXL/AutoFilterColumn.html +69 -22
  23. data/rdoc/RubyXL/BinaryImageFile.html +85 -24
  24. data/rdoc/RubyXL/BodyProperties.html +69 -22
  25. data/rdoc/RubyXL/BooleanNode.html +69 -22
  26. data/rdoc/RubyXL/BooleanValue.html +69 -22
  27. data/rdoc/RubyXL/Border.html +196 -61
  28. data/rdoc/RubyXL/BorderEdge.html +136 -45
  29. data/rdoc/RubyXL/Borders.html +105 -36
  30. data/rdoc/RubyXL/Break.html +69 -22
  31. data/rdoc/RubyXL/BreakList.html +69 -22
  32. data/rdoc/RubyXL/CT_AdjPoint2D.html +69 -22
  33. data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +69 -22
  34. data/rdoc/RubyXL/CT_AlphaModulateEffect.html +69 -22
  35. data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +69 -22
  36. data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +69 -22
  37. data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +69 -22
  38. data/rdoc/RubyXL/CT_Backdrop.html +69 -22
  39. data/rdoc/RubyXL/CT_Bevel.html +69 -22
  40. data/rdoc/RubyXL/CT_BiLevelEffect.html +69 -22
  41. data/rdoc/RubyXL/CT_BlendEffect.html +69 -22
  42. data/rdoc/RubyXL/CT_Blip.html +69 -22
  43. data/rdoc/RubyXL/CT_BlipFillProperties.html +69 -22
  44. data/rdoc/RubyXL/CT_BlurEffect.html +69 -22
  45. data/rdoc/RubyXL/CT_Camera.html +69 -22
  46. data/rdoc/RubyXL/CT_Color.html +69 -22
  47. data/rdoc/RubyXL/CT_ColorChangeEffect.html +69 -22
  48. data/rdoc/RubyXL/CT_ColorMapping.html +69 -22
  49. data/rdoc/RubyXL/CT_ColorScheme.html +69 -22
  50. data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +69 -22
  51. data/rdoc/RubyXL/CT_ConnectionSite.html +69 -22
  52. data/rdoc/RubyXL/CT_ConnectionSiteList.html +69 -22
  53. data/rdoc/RubyXL/CT_DashStop.html +69 -22
  54. data/rdoc/RubyXL/CT_DashStopList.html +69 -22
  55. data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +69 -22
  56. data/rdoc/RubyXL/CT_DuotoneEffect.html +69 -22
  57. data/rdoc/RubyXL/CT_EffectContainer.html +69 -22
  58. data/rdoc/RubyXL/CT_EffectList.html +69 -22
  59. data/rdoc/RubyXL/CT_EffectReference.html +69 -22
  60. data/rdoc/RubyXL/CT_EffectStyleItem.html +69 -22
  61. data/rdoc/RubyXL/CT_EffectStyleList.html +69 -22
  62. data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +69 -22
  63. data/rdoc/RubyXL/CT_FillEffect.html +69 -22
  64. data/rdoc/RubyXL/CT_FillOverlayEffect.html +69 -22
  65. data/rdoc/RubyXL/CT_FillStyleList.html +69 -22
  66. data/rdoc/RubyXL/CT_FlatText.html +69 -22
  67. data/rdoc/RubyXL/CT_FontCollection.html +69 -22
  68. data/rdoc/RubyXL/CT_FontReference.html +69 -22
  69. data/rdoc/RubyXL/CT_GeomGuideList.html +69 -22
  70. data/rdoc/RubyXL/CT_GlowEffect.html +69 -22
  71. data/rdoc/RubyXL/CT_GradientFillProperties.html +69 -22
  72. data/rdoc/RubyXL/CT_GradientStop.html +69 -22
  73. data/rdoc/RubyXL/CT_GradientStopList.html +69 -22
  74. data/rdoc/RubyXL/CT_HSLEffect.html +69 -22
  75. data/rdoc/RubyXL/CT_HslColor.html +69 -22
  76. data/rdoc/RubyXL/CT_Hyperlink.html +69 -22
  77. data/rdoc/RubyXL/CT_InnerShadowEffect.html +69 -22
  78. data/rdoc/RubyXL/CT_LightRig.html +69 -22
  79. data/rdoc/RubyXL/CT_LineEndProperties.html +69 -22
  80. data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +69 -22
  81. data/rdoc/RubyXL/CT_LineProperties.html +69 -22
  82. data/rdoc/RubyXL/CT_LineStyleList.html +69 -22
  83. data/rdoc/RubyXL/CT_LinearShadeProperties.html +69 -22
  84. data/rdoc/RubyXL/CT_LuminanceEffect.html +69 -22
  85. data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +69 -22
  86. data/rdoc/RubyXL/CT_OuterShadowEffect.html +69 -22
  87. data/rdoc/RubyXL/CT_Path2D.html +69 -22
  88. data/rdoc/RubyXL/CT_Path2DArcTo.html +69 -22
  89. data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +69 -22
  90. data/rdoc/RubyXL/CT_Path2DList.html +69 -22
  91. data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +69 -22
  92. data/rdoc/RubyXL/CT_Path2DTo.html +69 -22
  93. data/rdoc/RubyXL/CT_PathShadeProperties.html +69 -22
  94. data/rdoc/RubyXL/CT_PatternFillProperties.html +69 -22
  95. data/rdoc/RubyXL/CT_Point3D.html +69 -22
  96. data/rdoc/RubyXL/CT_PolarAdjustHandle.html +69 -22
  97. data/rdoc/RubyXL/CT_PresetColor.html +69 -22
  98. data/rdoc/RubyXL/CT_PresetLineDashProperties.html +69 -22
  99. data/rdoc/RubyXL/CT_PresetShadowEffect.html +69 -22
  100. data/rdoc/RubyXL/CT_PresetTextShape.html +69 -22
  101. data/rdoc/RubyXL/CT_ReflectionEffect.html +69 -22
  102. data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +69 -22
  103. data/rdoc/RubyXL/CT_RelativeRect.html +69 -22
  104. data/rdoc/RubyXL/CT_SRgbColor.html +69 -22
  105. data/rdoc/RubyXL/CT_ScRgbColor.html +69 -22
  106. data/rdoc/RubyXL/CT_Scene3D.html +69 -22
  107. data/rdoc/RubyXL/CT_SchemeColor.html +69 -22
  108. data/rdoc/RubyXL/CT_Shape3D.html +69 -22
  109. data/rdoc/RubyXL/CT_ShapeStyle.html +69 -22
  110. data/rdoc/RubyXL/CT_SoftEdgesEffect.html +69 -22
  111. data/rdoc/RubyXL/CT_SphereCoords.html +69 -22
  112. data/rdoc/RubyXL/CT_StretchInfoProperties.html +69 -22
  113. data/rdoc/RubyXL/CT_StyleMatrix.html +69 -22
  114. data/rdoc/RubyXL/CT_StyleMatrixReference.html +69 -22
  115. data/rdoc/RubyXL/CT_SupplementalFont.html +69 -22
  116. data/rdoc/RubyXL/CT_SystemColor.html +69 -22
  117. data/rdoc/RubyXL/CT_TextAutonumberBullet.html +69 -22
  118. data/rdoc/RubyXL/CT_TextBlipBullet.html +69 -22
  119. data/rdoc/RubyXL/CT_TextCharBullet.html +69 -22
  120. data/rdoc/RubyXL/CT_TextCharacterProperties.html +69 -22
  121. data/rdoc/RubyXL/CT_TextFont.html +69 -22
  122. data/rdoc/RubyXL/CT_TextListStyle.html +69 -22
  123. data/rdoc/RubyXL/CT_TextNormalAutofit.html +69 -22
  124. data/rdoc/RubyXL/CT_TextParagraphProperties.html +69 -22
  125. data/rdoc/RubyXL/CT_TextSpacing.html +69 -22
  126. data/rdoc/RubyXL/CT_TextTabStop.html +69 -22
  127. data/rdoc/RubyXL/CT_TextTabStopList.html +69 -22
  128. data/rdoc/RubyXL/CT_TileInfoProperties.html +69 -22
  129. data/rdoc/RubyXL/CT_TintEffect.html +69 -22
  130. data/rdoc/RubyXL/CT_Transform2D.html +69 -22
  131. data/rdoc/RubyXL/CT_TransformEffect.html +69 -22
  132. data/rdoc/RubyXL/CT_Vector3D.html +69 -22
  133. data/rdoc/RubyXL/CT_XYAdjustHandle.html +69 -22
  134. data/rdoc/RubyXL/CalculationChain.html +121 -38
  135. data/rdoc/RubyXL/CalculationChainCell.html +69 -22
  136. data/rdoc/RubyXL/CalculationProperties.html +69 -22
  137. data/rdoc/RubyXL/Cell.html +522 -147
  138. data/rdoc/RubyXL/CellConvenienceMethods.html +1201 -313
  139. data/rdoc/RubyXL/CellExt.html +69 -22
  140. data/rdoc/RubyXL/CellSmartTag.html +69 -22
  141. data/rdoc/RubyXL/CellSmartTagProperty.html +69 -22
  142. data/rdoc/RubyXL/CellSmartTags.html +69 -22
  143. data/rdoc/RubyXL/CellStyle.html +69 -22
  144. data/rdoc/RubyXL/CellStyleXFs.html +105 -36
  145. data/rdoc/RubyXL/CellStyles.html +105 -36
  146. data/rdoc/RubyXL/CellValue.html +105 -36
  147. data/rdoc/RubyXL/CellWatch.html +69 -22
  148. data/rdoc/RubyXL/CellWatches.html +69 -22
  149. data/rdoc/RubyXL/CellXFs.html +105 -36
  150. data/rdoc/RubyXL/ChartColorsFile.html +85 -24
  151. data/rdoc/RubyXL/ChartFile.html +126 -39
  152. data/rdoc/RubyXL/ChartStyleFile.html +85 -24
  153. data/rdoc/RubyXL/ChartUserShapesFile.html +85 -24
  154. data/rdoc/RubyXL/Chartsheet.html +174 -55
  155. data/rdoc/RubyXL/ChartsheetPageSetup.html +69 -22
  156. data/rdoc/RubyXL/ChartsheetProperties.html +69 -22
  157. data/rdoc/RubyXL/ChartsheetProtection.html +69 -22
  158. data/rdoc/RubyXL/ChartsheetView.html +69 -22
  159. data/rdoc/RubyXL/ChartsheetViews.html +69 -22
  160. data/rdoc/RubyXL/Color.html +114 -37
  161. data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +181 -58
  162. data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +220 -67
  163. data/rdoc/RubyXL/ColorConvenienceClasses.html +67 -19
  164. data/rdoc/RubyXL/ColorConvenienceMethods.html +103 -33
  165. data/rdoc/RubyXL/ColorFilter.html +69 -22
  166. data/rdoc/RubyXL/ColorScale.html +69 -22
  167. data/rdoc/RubyXL/ColorSet.html +69 -22
  168. data/rdoc/RubyXL/Colors.html +69 -22
  169. data/rdoc/RubyXL/ColumnRange.html +214 -63
  170. data/rdoc/RubyXL/ColumnRanges.html +196 -61
  171. data/rdoc/RubyXL/Comment.html +69 -22
  172. data/rdoc/RubyXL/CommentList.html +69 -22
  173. data/rdoc/RubyXL/CommentsFile.html +133 -42
  174. data/rdoc/RubyXL/ConditionalFormatValue.html +69 -22
  175. data/rdoc/RubyXL/ConditionalFormatting.html +69 -22
  176. data/rdoc/RubyXL/ConditionalFormattingRule.html +69 -22
  177. data/rdoc/RubyXL/Connection.html +69 -22
  178. data/rdoc/RubyXL/ConnectionTable.html +69 -22
  179. data/rdoc/RubyXL/ConnectionTables.html +69 -22
  180. data/rdoc/RubyXL/ConnectionTextField.html +69 -22
  181. data/rdoc/RubyXL/ConnectionTextFields.html +69 -22
  182. data/rdoc/RubyXL/Connections.html +121 -38
  183. data/rdoc/RubyXL/ContentTypeDefault.html +69 -22
  184. data/rdoc/RubyXL/ContentTypeOverride.html +69 -22
  185. data/rdoc/RubyXL/ContentTypes.html +152 -47
  186. data/rdoc/RubyXL/ControlPropertiesFile.html +85 -24
  187. data/rdoc/RubyXL/CorePropertiesFile.html +374 -107
  188. data/rdoc/RubyXL/CustomColor.html +69 -22
  189. data/rdoc/RubyXL/CustomColorList.html +69 -22
  190. data/rdoc/RubyXL/CustomFilter.html +69 -22
  191. data/rdoc/RubyXL/CustomFilters.html +69 -22
  192. data/rdoc/RubyXL/CustomGeometry.html +69 -22
  193. data/rdoc/RubyXL/CustomProperties.html +69 -22
  194. data/rdoc/RubyXL/CustomPropertiesFile.html +85 -24
  195. data/rdoc/RubyXL/CustomProperty.html +69 -22
  196. data/rdoc/RubyXL/CustomPropertyFile.html +85 -24
  197. data/rdoc/RubyXL/CustomSheetView.html +69 -22
  198. data/rdoc/RubyXL/CustomSheetViews.html +69 -22
  199. data/rdoc/RubyXL/CustomWorkbookView.html +69 -22
  200. data/rdoc/RubyXL/CustomWorkbookViews.html +69 -22
  201. data/rdoc/RubyXL/CustomXMLFile.html +78 -23
  202. data/rdoc/RubyXL/DXF.html +69 -22
  203. data/rdoc/RubyXL/DXFs.html +69 -22
  204. data/rdoc/RubyXL/DataBar.html +69 -22
  205. data/rdoc/RubyXL/DataConsolidate.html +69 -22
  206. data/rdoc/RubyXL/DataConsolidationReference.html +69 -22
  207. data/rdoc/RubyXL/DataConsolidationReferences.html +69 -22
  208. data/rdoc/RubyXL/DataType.html +118 -26
  209. data/rdoc/RubyXL/DataValidation.html +69 -22
  210. data/rdoc/RubyXL/DataValidations.html +69 -22
  211. data/rdoc/RubyXL/DateGroupItem.html +69 -22
  212. data/rdoc/RubyXL/DefinedName.html +69 -22
  213. data/rdoc/RubyXL/DefinedNameExt.html +69 -22
  214. data/rdoc/RubyXL/DefinedNames.html +69 -22
  215. data/rdoc/RubyXL/DefinedNamesExt.html +69 -22
  216. data/rdoc/RubyXL/DocumentPropertiesFile.html +164 -51
  217. data/rdoc/RubyXL/DrawingFile.html +126 -39
  218. data/rdoc/RubyXL/DynamicFilter.html +69 -22
  219. data/rdoc/RubyXL/EmbeddedControl.html +69 -22
  220. data/rdoc/RubyXL/EmbeddedControls.html +69 -22
  221. data/rdoc/RubyXL/Extension.html +69 -22
  222. data/rdoc/RubyXL/ExtensionStorageArea.html +69 -22
  223. data/rdoc/RubyXL/Extents.html +69 -22
  224. data/rdoc/RubyXL/ExternalBook.html +69 -22
  225. data/rdoc/RubyXL/ExternalLinksFile.html +126 -39
  226. data/rdoc/RubyXL/ExternalReference.html +69 -22
  227. data/rdoc/RubyXL/ExternalReferences.html +69 -22
  228. data/rdoc/RubyXL/ExtraColorSchemeList.html +69 -22
  229. data/rdoc/RubyXL/FieldItem.html +69 -22
  230. data/rdoc/RubyXL/FileRecoveryProperties.html +69 -22
  231. data/rdoc/RubyXL/FileSharing.html +69 -22
  232. data/rdoc/RubyXL/FileVersion.html +69 -22
  233. data/rdoc/RubyXL/Fill.html +105 -36
  234. data/rdoc/RubyXL/Fills.html +105 -36
  235. data/rdoc/RubyXL/FilterContainer.html +69 -22
  236. data/rdoc/RubyXL/FloatNode.html +69 -22
  237. data/rdoc/RubyXL/FloatValue.html +69 -22
  238. data/rdoc/RubyXL/Font.html +115 -38
  239. data/rdoc/RubyXL/FontConvenienceMethods.html +494 -138
  240. data/rdoc/RubyXL/FontScheme.html +69 -22
  241. data/rdoc/RubyXL/Fonts.html +105 -36
  242. data/rdoc/RubyXL/Formula.html +69 -22
  243. data/rdoc/RubyXL/FunctionGroup.html +69 -22
  244. data/rdoc/RubyXL/FunctionGroups.html +69 -22
  245. data/rdoc/RubyXL/GenericStorageObject.html +214 -65
  246. data/rdoc/RubyXL/GradientFill.html +69 -22
  247. data/rdoc/RubyXL/HeaderFooterSettings.html +69 -22
  248. data/rdoc/RubyXL/Hyperlink.html +69 -22
  249. data/rdoc/RubyXL/HyperlinkRelFile.html +78 -23
  250. data/rdoc/RubyXL/Hyperlinks.html +69 -22
  251. data/rdoc/RubyXL/IconFilter.html +69 -22
  252. data/rdoc/RubyXL/IconSet.html +69 -22
  253. data/rdoc/RubyXL/IgnoredError.html +69 -22
  254. data/rdoc/RubyXL/IgnoredErrors.html +69 -22
  255. data/rdoc/RubyXL/IndexedColors.html +69 -22
  256. data/rdoc/RubyXL/InputCells.html +69 -22
  257. data/rdoc/RubyXL/IntegerNode.html +69 -22
  258. data/rdoc/RubyXL/IntegerValue.html +69 -22
  259. data/rdoc/RubyXL/LegacyCell.html +103 -33
  260. data/rdoc/RubyXL/LegacyWorksheet.html +252 -73
  261. data/rdoc/RubyXL/MRUColors.html +69 -22
  262. data/rdoc/RubyXL/MacrosFile.html +85 -24
  263. data/rdoc/RubyXL/MergedCell.html +69 -22
  264. data/rdoc/RubyXL/MergedCells.html +69 -22
  265. data/rdoc/RubyXL/NumFmt.html +69 -22
  266. data/rdoc/RubyXL/NumberFormat.html +105 -36
  267. data/rdoc/RubyXL/NumberFormats.html +115 -38
  268. data/rdoc/RubyXL/OLEObject.html +69 -22
  269. data/rdoc/RubyXL/OLEObjectFile.html +85 -24
  270. data/rdoc/RubyXL/OLEObjects.html +69 -22
  271. data/rdoc/RubyXL/OLESize.html +69 -22
  272. data/rdoc/RubyXL/OOXMLContainerObject.html +295 -99
  273. data/rdoc/RubyXL/OOXMLIgnored.html +145 -46
  274. data/rdoc/RubyXL/OOXMLObject.html +74 -23
  275. data/rdoc/RubyXL/OOXMLObjectClassMethods.html +294 -112
  276. data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +370 -125
  277. data/rdoc/RubyXL/OOXMLRelationshipsFile.html +429 -124
  278. data/rdoc/RubyXL/OOXMLTopLevelObject.html +283 -96
  279. data/rdoc/RubyXL/OdbcOleDbProperties.html +69 -22
  280. data/rdoc/RubyXL/Offset.html +69 -22
  281. data/rdoc/RubyXL/OlapProperties.html +69 -22
  282. data/rdoc/RubyXL/OleItem.html +69 -22
  283. data/rdoc/RubyXL/OleItems.html +69 -22
  284. data/rdoc/RubyXL/OleLink.html +69 -22
  285. data/rdoc/RubyXL/OutlineProperties.html +69 -22
  286. data/rdoc/RubyXL/PageMargins.html +69 -22
  287. data/rdoc/RubyXL/PageSetup.html +69 -22
  288. data/rdoc/RubyXL/PageSetupProperties.html +69 -22
  289. data/rdoc/RubyXL/Pane.html +69 -22
  290. data/rdoc/RubyXL/Parser.html +136 -45
  291. data/rdoc/RubyXL/PatternFill.html +69 -22
  292. data/rdoc/RubyXL/PersonMetadata.html +85 -24
  293. data/rdoc/RubyXL/PhoneticProperties.html +69 -22
  294. data/rdoc/RubyXL/PhoneticRun.html +69 -22
  295. data/rdoc/RubyXL/PivotArea.html +69 -22
  296. data/rdoc/RubyXL/PivotCache.html +69 -22
  297. data/rdoc/RubyXL/PivotCacheDefinitionFile.html +90 -25
  298. data/rdoc/RubyXL/PivotCacheRecordsFile.html +85 -24
  299. data/rdoc/RubyXL/PivotCaches.html +69 -22
  300. data/rdoc/RubyXL/PivotReference.html +69 -22
  301. data/rdoc/RubyXL/PivotReferences.html +69 -22
  302. data/rdoc/RubyXL/PivotTableFile.html +90 -25
  303. data/rdoc/RubyXL/PivotTableSelection.html +69 -22
  304. data/rdoc/RubyXL/PresetGeometry.html +69 -22
  305. data/rdoc/RubyXL/PrintOptions.html +69 -22
  306. data/rdoc/RubyXL/PrinterSettingsFile.html +85 -24
  307. data/rdoc/RubyXL/ProtectedRange.html +69 -22
  308. data/rdoc/RubyXL/ProtectedRanges.html +69 -22
  309. data/rdoc/RubyXL/Protection.html +69 -22
  310. data/rdoc/RubyXL/QueryParameter.html +69 -22
  311. data/rdoc/RubyXL/QueryParameters.html +69 -22
  312. data/rdoc/RubyXL/QueryTable.html +126 -39
  313. data/rdoc/RubyXL/QueryTableDeletedField.html +69 -22
  314. data/rdoc/RubyXL/QueryTableDeletedFields.html +69 -22
  315. data/rdoc/RubyXL/QueryTableField.html +69 -22
  316. data/rdoc/RubyXL/QueryTableFields.html +69 -22
  317. data/rdoc/RubyXL/QueryTableRefresh.html +69 -22
  318. data/rdoc/RubyXL/RID.html +69 -22
  319. data/rdoc/RubyXL/RawOOXML.html +157 -50
  320. data/rdoc/RubyXL/Reference.html +512 -143
  321. data/rdoc/RubyXL/Relationship.html +69 -22
  322. data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +109 -33
  323. data/rdoc/RubyXL/RelationshipSupport.html +290 -84
  324. data/rdoc/RubyXL/RevisionPointer.html +69 -22
  325. data/rdoc/RubyXL/RichText.html +105 -36
  326. data/rdoc/RubyXL/RichTextRun.html +105 -36
  327. data/rdoc/RubyXL/Row.html +367 -106
  328. data/rdoc/RubyXL/RowExt.html +69 -22
  329. data/rdoc/RubyXL/RunProperties.html +69 -22
  330. data/rdoc/RubyXL/Scenario.html +69 -22
  331. data/rdoc/RubyXL/Scenarios.html +69 -22
  332. data/rdoc/RubyXL/Selection.html +105 -36
  333. data/rdoc/RubyXL/ShapeGuide.html +69 -22
  334. data/rdoc/RubyXL/ShapeTextRectangle.html +69 -22
  335. data/rdoc/RubyXL/SharedStringsTable.html +321 -96
  336. data/rdoc/RubyXL/Sheet.html +69 -22
  337. data/rdoc/RubyXL/SheetCalculationProperties.html +69 -22
  338. data/rdoc/RubyXL/SheetData.html +136 -45
  339. data/rdoc/RubyXL/SheetDataExt.html +69 -22
  340. data/rdoc/RubyXL/SheetDataSet.html +69 -22
  341. data/rdoc/RubyXL/SheetMetadata.html +85 -24
  342. data/rdoc/RubyXL/SheetName.html +69 -22
  343. data/rdoc/RubyXL/SheetNames.html +69 -22
  344. data/rdoc/RubyXL/Sheets.html +69 -22
  345. data/rdoc/RubyXL/SlicerCacheFile.html +85 -24
  346. data/rdoc/RubyXL/SlicerFile.html +85 -24
  347. data/rdoc/RubyXL/SmartTagProperties.html +69 -22
  348. data/rdoc/RubyXL/SmartTagType.html +69 -22
  349. data/rdoc/RubyXL/SmartTagTypes.html +69 -22
  350. data/rdoc/RubyXL/SmartTags.html +69 -22
  351. data/rdoc/RubyXL/SortCondition.html +69 -22
  352. data/rdoc/RubyXL/SortState.html +69 -22
  353. data/rdoc/RubyXL/Sqref.html +145 -46
  354. data/rdoc/RubyXL/Stop.html +69 -22
  355. data/rdoc/RubyXL/StringNode.html +69 -22
  356. data/rdoc/RubyXL/StringNodeW3C.html +145 -46
  357. data/rdoc/RubyXL/StringValue.html +69 -22
  358. data/rdoc/RubyXL/Stylesheet.html +256 -76
  359. data/rdoc/RubyXL/TableFile.html +85 -24
  360. data/rdoc/RubyXL/TableParts.html +69 -22
  361. data/rdoc/RubyXL/TableStyle.html +69 -22
  362. data/rdoc/RubyXL/TableStyles.html +69 -22
  363. data/rdoc/RubyXL/Text.html +153 -48
  364. data/rdoc/RubyXL/TextImportSettings.html +69 -22
  365. data/rdoc/RubyXL/Theme.html +191 -56
  366. data/rdoc/RubyXL/ThemeElements.html +69 -22
  367. data/rdoc/RubyXL/ThumbnailFile.html +85 -24
  368. data/rdoc/RubyXL/Top10.html +69 -22
  369. data/rdoc/RubyXL/VMLDrawingFile.html +91 -26
  370. data/rdoc/RubyXL/Variant.html +69 -22
  371. data/rdoc/RubyXL/Vector.html +105 -36
  372. data/rdoc/RubyXL/VectorValue.html +69 -22
  373. data/rdoc/RubyXL/VisualProperties.html +69 -22
  374. data/rdoc/RubyXL/WebPublishObject.html +69 -22
  375. data/rdoc/RubyXL/WebPublishObjects.html +69 -22
  376. data/rdoc/RubyXL/WebPublishingItem.html +69 -22
  377. data/rdoc/RubyXL/WebPublishingItems.html +69 -22
  378. data/rdoc/RubyXL/WebPublishingProperties.html +69 -22
  379. data/rdoc/RubyXL/WebQueryProperties.html +69 -22
  380. data/rdoc/RubyXL/Workbook.html +1053 -284
  381. data/rdoc/RubyXL/WorkbookConvenienceMethods.html +623 -175
  382. data/rdoc/RubyXL/WorkbookProperties.html +69 -22
  383. data/rdoc/RubyXL/WorkbookProtection.html +69 -22
  384. data/rdoc/RubyXL/WorkbookRoot.html +271 -82
  385. data/rdoc/RubyXL/WorkbookView.html +69 -22
  386. data/rdoc/RubyXL/WorkbookViews.html +69 -22
  387. data/rdoc/RubyXL/Worksheet.html +373 -110
  388. data/rdoc/RubyXL/WorksheetConvenienceMethods.html +2195 -585
  389. data/rdoc/RubyXL/WorksheetDimensions.html +69 -22
  390. data/rdoc/RubyXL/WorksheetFormatProperties.html +69 -22
  391. data/rdoc/RubyXL/WorksheetProperties.html +69 -22
  392. data/rdoc/RubyXL/WorksheetProtection.html +69 -22
  393. data/rdoc/RubyXL/WorksheetView.html +69 -22
  394. data/rdoc/RubyXL/WorksheetViews.html +69 -22
  395. data/rdoc/RubyXL/XF.html +69 -22
  396. data/rdoc/RubyXL.html +778 -134
  397. data/rdoc/created.rid +7 -7
  398. data/rdoc/css/rdoc.css +393 -397
  399. data/rdoc/index.html +42 -408
  400. data/rdoc/js/darkfish.js +45 -2
  401. data/rdoc/js/navigation.js.gz +0 -0
  402. data/rdoc/js/search.js +11 -1
  403. data/rdoc/js/search_index.js +1 -1
  404. data/rdoc/js/search_index.js.gz +0 -0
  405. data/rdoc/js/searcher.js +44 -6
  406. data/rdoc/js/searcher.js.gz +0 -0
  407. data/rdoc/table_of_contents.html +1285 -53
  408. data/rubyXL.gemspec +15 -30
  409. data/spec/lib/cell_spec.rb +26 -0
  410. metadata +5 -5
@@ -1,10 +1,21 @@
1
1
  <!DOCTYPE html>
2
2
 
3
- <html>
3
+ <html lang="en">
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
+ <meta name="viewport" content="width=device-width, initial-scale=1">
7
+
8
+ <title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.4.35</title>
9
+
10
+
11
+ <meta name="keywords" content="ruby,module,RubyXL::OOXMLObjectClassMethods">
12
+
13
+
14
+ <meta name="description" content="Documentation for the RubyXL::OOXMLObjectClassMethods module">
15
+
16
+
17
+
6
18
 
7
- <title>module RubyXL::OOXMLObjectClassMethods - rubyXL 3.4.33</title>
8
19
 
9
20
  <script type="text/javascript">
10
21
  var rdoc_rel_prefix = "../";
@@ -21,8 +32,14 @@
21
32
  <link href="../css/rdoc.css" rel="stylesheet">
22
33
 
23
34
 
35
+
24
36
  <body id="top" role="document" class="module">
25
- <nav role="navigation">
37
+ <div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
38
+ <span aria-hidden="true">&#9776;</span>
39
+ </div>
40
+
41
+
42
+ <nav id="navigation" role="navigation">
26
43
  <div id="project-navigation">
27
44
  <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
45
  <h2>
@@ -55,31 +72,67 @@
55
72
 
56
73
 
57
74
 
58
- <div id="class-metadata">
59
-
60
-
61
-
62
-
63
-
64
- <!-- Method Quickref -->
65
- <div id="method-list-section" class="nav-section">
66
- <h3>Methods</h3>
67
-
68
- <ul class="link-list" role="directory">
69
- <li ><a href="#method-i-define_attribute">#define_attribute</a>
70
- <li ><a href="#method-i-define_child_node">#define_child_node</a>
71
- <li ><a href="#method-i-define_element_name">#define_element_name</a>
72
- <li ><a href="#method-i-define_relationship">#define_relationship</a>
73
- <li ><a href="#method-i-obtain_class_variable">#obtain_class_variable</a>
74
- <li ><a href="#method-i-parse">#parse</a>
75
- </ul>
76
- </div>
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <div class="nav-section">
87
+ <h3>Instance Methods</h3>
88
+ <ul class="link-list" role="directory">
77
89
 
90
+ <li ><a href="#method-i-define_attribute">define_attribute</a></li>
91
+
92
+ <li ><a href="#method-i-define_child_node">define_child_node</a></li>
93
+
94
+ <li ><a href="#method-i-define_element_name">define_element_name</a></li>
95
+
96
+ <li ><a href="#method-i-define_relationship">define_relationship</a></li>
97
+
98
+ <li ><a href="#method-i-obtain_class_variable">obtain_class_variable</a></li>
99
+
100
+ <li ><a href="#method-i-parse">parse</a></li>
101
+
102
+ </ul>
78
103
  </div>
104
+
105
+
106
+
107
+ <footer id="validator-badges" role="contentinfo">
108
+ <p><a href="https://validator.w3.org/check/referer">Validate</a></p>
109
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.15.1.</p>
110
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
111
+ </footer>
112
+
79
113
  </nav>
80
114
 
81
115
  <main role="main" aria-labelledby="module-RubyXL::OOXMLObjectClassMethods">
82
- <h1 id="module-RubyXL::OOXMLObjectClassMethods" class="module">
116
+
117
+
118
+ <ol role="navigation" aria-label="Breadcrumb navigation" class="breadcrumb">
119
+
120
+ <li>
121
+
122
+ <a href="../RubyXL.html">RubyXL</a><span>::</span>
123
+
124
+ </li>
125
+
126
+ <li>
127
+
128
+ <span>OOXMLObjectClassMethods</span>
129
+
130
+ </li>
131
+
132
+ </ol>
133
+
134
+
135
+ <h1 id="module-RubyXL::OOXMLObjectClassMethods" class="anchor-link module">
83
136
  module RubyXL::OOXMLObjectClassMethods
84
137
  </h1>
85
138
 
@@ -87,27 +140,60 @@
87
140
 
88
141
  </section>
89
142
 
90
- <section id="5Buntitled-5D" class="documentation-section">
143
+
144
+ <section id="5Buntitled-5D" class="documentation-section anchor-link">
145
+
146
+
91
147
 
92
148
 
93
149
 
94
150
 
95
151
 
96
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
152
+
153
+
154
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section anchor-link">
97
155
  <header>
98
156
  <h3>Public Instance Methods</h3>
99
157
  </header>
100
158
 
101
- <div id="method-i-define_attribute" class="method-detail ">
159
+
160
+ <div id="method-i-define_attribute" class="method-detail anchor-link ">
102
161
  <div class="method-header">
103
- <div class="method-heading">
104
- <span class="method-name">define_attribute</span><span
105
- class="method-args">(attr_name, attr_type, extra_params = nil)</span>
106
- <span class="method-click-advice">click to toggle source</span>
107
- </div>
162
+
163
+ <div class="method-heading">
164
+ <a href="#method-i-define_attribute" title="Link to this method">
165
+ <span class="method-name">define_attribute</span>
166
+ <span class="method-args">(attr_name, attr_type, extra_params = nil)</span>
167
+ </a>
168
+ </div>
169
+
108
170
  </div>
109
171
 
172
+
173
+ <div class="method-controls">
174
+ <details class="method-source-toggle">
175
+ <summary>Source</summary>
176
+ </details>
177
+ </div>
178
+
179
+
180
+
110
181
  <div class="method-description">
182
+
183
+ <div class="method-source-code" id="define_attribute-source">
184
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 50</span>
185
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> = <span class="ruby-keyword">nil</span>)
186
+ <span class="ruby-identifier">attrs</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>)
187
+ <span class="ruby-identifier">attr_hash</span> = { <span class="ruby-value">:attr_type</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">attr_type</span> }
188
+ <span class="ruby-identifier">attr_hash</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">extra_params</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>
189
+ <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">attr_name</span>)
190
+ <span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">attr_hash</span>
191
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:computed</span>]
192
+ <span class="ruby-keyword">end</span></pre>
193
+ </div>
194
+
195
+
196
+
111
197
  <p>Defines an attribute of OOXML object.</p>
112
198
 
113
199
  <h3 id="method-i-define_attribute-label-Parameters">Parameters<span><a href="#method-i-define_attribute-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
@@ -133,7 +219,7 @@
133
219
  </li><li>
134
220
  <p><code>:bool</code> - <code>Boolean</code> (“1” and “true” convert to <code>true</code>, others to <code>false</code>)</p>
135
221
  </li><li>
136
- <p>one of <code>simple_types</code> - <code>String</code>, plus the list of acceptable values is saved for future validation (not used yet).</p>
222
+ <p>one of <a href="../lib/rubyXL/objects/simple_types_rb.html">simple_types</a> - <code>String</code>, plus the list of acceptable values is saved for future validation (not used yet).</p>
137
223
  </li></ul>
138
224
  </li><li>
139
225
  <p><code>extra_parameters</code> - Hash of optional parameters as follows:</p>
@@ -170,32 +256,60 @@
170
256
 
171
257
  <p>A <code>String</code> attribute named ‘errorStyle’ will be accessible as <code>obj.error_style</code>, valid values are <code>&quot;stop&quot;</code>, <code>&quot;warning&quot;</code>, <code>&quot;information&quot;</code></p>
172
258
 
173
- <div class="method-source-code" id="define_attribute-source">
174
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 48</span>
175
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_attribute</span>(<span class="ruby-identifier">attr_name</span>, <span class="ruby-identifier">attr_type</span>, <span class="ruby-identifier">extra_params</span> = <span class="ruby-keyword">nil</span>)
176
- <span class="ruby-identifier">attrs</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>)
177
- <span class="ruby-identifier">attr_hash</span> = { <span class="ruby-value">:attr_type</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">attr_type</span> }
178
- <span class="ruby-identifier">attr_hash</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">extra_params</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>
179
- <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">attr_name</span>)
180
- <span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">attr_hash</span>
181
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">attr_hash</span>[<span class="ruby-value">:computed</span>]
182
- <span class="ruby-keyword">end</span></pre>
183
- </div>
259
+
184
260
  </div>
185
261
 
186
262
 
263
+
264
+
265
+
187
266
  </div>
188
267
 
189
- <div id="method-i-define_child_node" class="method-detail ">
268
+
269
+ <div id="method-i-define_child_node" class="method-detail anchor-link ">
190
270
  <div class="method-header">
191
- <div class="method-heading">
192
- <span class="method-name">define_child_node</span><span
193
- class="method-args">(klass, extra_params = {})</span>
194
- <span class="method-click-advice">click to toggle source</span>
195
- </div>
271
+
272
+ <div class="method-heading">
273
+ <a href="#method-i-define_child_node" title="Link to this method">
274
+ <span class="method-name">define_child_node</span>
275
+ <span class="method-args">(klass, extra_params = {})</span>
276
+ </a>
277
+ </div>
278
+
196
279
  </div>
197
280
 
281
+
282
+ <div class="method-controls">
283
+ <details class="method-source-toggle">
284
+ <summary>Source</summary>
285
+ </details>
286
+ </div>
287
+
288
+
289
+
198
290
  <div class="method-description">
291
+
292
+ <div class="method-source-code" id="define_child_node-source">
293
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 84</span>
294
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
295
+ <span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
296
+ <span class="ruby-identifier">child_node_name</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:node_name</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@ooxml_tag_name</span>)).<span class="ruby-identifier">to_s</span>
297
+ <span class="ruby-identifier">accessor</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">child_node_name</span>)).<span class="ruby-identifier">to_sym</span>
298
+
299
+ <span class="ruby-identifier">child_nodes</span>[<span class="ruby-identifier">child_node_name</span>] = {
300
+ <span class="ruby-value">:class</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">klass</span>,
301
+ <span class="ruby-value">:is_array</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>],
302
+ <span class="ruby-value">:accessor</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">accessor</span>
303
+ }
304
+
305
+ <span class="ruby-identifier">define_count_attribute</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:with_count</span>
306
+
307
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">accessor</span>)
308
+ <span class="ruby-keyword">end</span></pre>
309
+ </div>
310
+
311
+
312
+
199
313
  <p>Defines a child node of OOXML object.</p>
200
314
 
201
315
  <h3 id="method-i-define_child_node-label-Parameters">Parameters<span><a href="#method-i-define_child_node-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
@@ -242,39 +356,48 @@
242
356
 
243
357
  <p>Upon writing of the object this was defined on, its <code>count</code> attribute will be set to the count of nodes in <code>fonts</code> array</p>
244
358
 
245
- <div class="method-source-code" id="define_child_node-source">
246
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 82</span>
247
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_child_node</span>(<span class="ruby-identifier">klass</span>, <span class="ruby-identifier">extra_params</span> = {})
248
- <span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
249
- <span class="ruby-identifier">child_node_name</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:node_name</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-value">:@@ooxml_tag_name</span>)).<span class="ruby-identifier">to_s</span>
250
- <span class="ruby-identifier">accessor</span> = (<span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:accessor</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">accessorize</span>(<span class="ruby-identifier">child_node_name</span>)).<span class="ruby-identifier">to_sym</span>
251
359
 
252
- <span class="ruby-identifier">child_nodes</span>[<span class="ruby-identifier">child_node_name</span>] = {
253
- <span class="ruby-value">:class</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">klass</span>,
254
- <span class="ruby-value">:is_array</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>],
255
- <span class="ruby-value">:accessor</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">accessor</span>
256
- }
360
+ </div>
361
+
257
362
 
258
- <span class="ruby-identifier">define_count_attribute</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra_params</span>[<span class="ruby-value">:collection</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:with_count</span>
259
363
 
260
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-value">:attr_accessor</span>, <span class="ruby-identifier">accessor</span>)
261
- <span class="ruby-keyword">end</span></pre>
262
- </div>
263
- </div>
264
364
 
265
365
 
266
366
  </div>
267
367
 
268
- <div id="method-i-define_element_name" class="method-detail ">
368
+
369
+ <div id="method-i-define_element_name" class="method-detail anchor-link ">
269
370
  <div class="method-header">
270
- <div class="method-heading">
271
- <span class="method-name">define_element_name</span><span
272
- class="method-args">(element_name)</span>
273
- <span class="method-click-advice">click to toggle source</span>
274
- </div>
371
+
372
+ <div class="method-heading">
373
+ <a href="#method-i-define_element_name" title="Link to this method">
374
+ <span class="method-name">define_element_name</span>
375
+ <span class="method-args">(element_name)</span>
376
+ </a>
377
+ </div>
378
+
275
379
  </div>
276
380
 
381
+
382
+ <div class="method-controls">
383
+ <details class="method-source-toggle">
384
+ <summary>Source</summary>
385
+ </details>
386
+ </div>
387
+
388
+
389
+
277
390
  <div class="method-description">
391
+
392
+ <div class="method-source-code" id="define_element_name-source">
393
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 112</span>
394
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
395
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_tag_name</span>, <span class="ruby-identifier">element_name</span>)
396
+ <span class="ruby-keyword">end</span></pre>
397
+ </div>
398
+
399
+
400
+
278
401
  <p>Defines the name of the element that represents the current OOXML object. Should only be used once per object. In case of different objects represented by the same class in different parts of OOXML tree, <code>:node_name</code> extra parameter can be used to override the default element name.</p>
279
402
 
280
403
  <h3 id="method-i-define_element_name-label-Parameters">Parameters<span><a href="#method-i-define_element_name-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
@@ -287,81 +410,135 @@
287
410
  <pre class="ruby"><span class="ruby-identifier">define_element_name</span> <span class="ruby-string">&#39;externalReference&#39;</span>
288
411
  </pre>
289
412
 
290
- <div class="method-source-code" id="define_element_name-source">
291
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 110</span>
292
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_element_name</span>(<span class="ruby-identifier">element_name</span>)
293
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-value">:@@ooxml_tag_name</span>, <span class="ruby-identifier">element_name</span>)
294
- <span class="ruby-keyword">end</span></pre>
295
- </div>
413
+
296
414
  </div>
297
415
 
298
416
 
417
+
418
+
419
+
299
420
  </div>
300
421
 
301
- <div id="method-i-define_relationship" class="method-detail ">
422
+
423
+ <div id="method-i-define_relationship" class="method-detail anchor-link ">
302
424
  <div class="method-header">
303
- <div class="method-heading">
304
- <span class="method-name">define_relationship</span><span
305
- class="method-args">(extra_params = {})</span>
306
- <span class="method-click-advice">click to toggle source</span>
307
- </div>
425
+
426
+ <div class="method-heading">
427
+ <a href="#method-i-define_relationship" title="Link to this method">
428
+ <span class="method-name">define_relationship</span>
429
+ <span class="method-args">(extra_params = {})</span>
430
+ </a>
431
+ </div>
432
+
308
433
  </div>
309
434
 
435
+
436
+ <div class="method-controls">
437
+ <details class="method-source-toggle">
438
+ <summary>Source</summary>
439
+ </details>
440
+ </div>
441
+
442
+
443
+
310
444
  <div class="method-description">
311
- <p>Defines a ‘r:id` attribute</p>
312
445
 
313
446
  <div class="method-source-code" id="define_relationship-source">
314
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 58</span>
447
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 60</span>
315
448
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">define_relationship</span>(<span class="ruby-identifier">extra_params</span> = {})
316
449
  <span class="ruby-identifier">define_attribute</span>(<span class="ruby-value">:&#39;r:id&#39;</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">extra_params</span>)
317
450
  <span class="ruby-keyword">end</span></pre>
318
451
  </div>
452
+
453
+
454
+
455
+ <p>Defines a ‘r:id` attribute</p>
456
+
457
+
319
458
  </div>
320
459
 
321
460
 
461
+
462
+
463
+
322
464
  </div>
323
465
 
324
- <div id="method-i-obtain_class_variable" class="method-detail ">
466
+
467
+ <div id="method-i-obtain_class_variable" class="method-detail anchor-link ">
325
468
  <div class="method-header">
326
- <div class="method-heading">
327
- <span class="method-name">obtain_class_variable</span><span
328
- class="method-args">(var_name, default = nil)</span>
329
- <span class="method-click-advice">click to toggle source</span>
330
- </div>
469
+
470
+ <div class="method-heading">
471
+ <a href="#method-i-obtain_class_variable" title="Link to this method">
472
+ <span class="method-name">obtain_class_variable</span>
473
+ <span class="method-args">(var_name, default = nil)</span>
474
+ </a>
475
+ </div>
476
+
331
477
  </div>
332
478
 
333
- <div class="method-description">
334
- <p>Get the value of a [sub]class variable if it exists, or create the respective variable with the passed-in <code>default</code> (or +{}+, if not specified)</p>
335
479
 
336
- <p>Throughout this class, we are setting class variables through explicit method calls rather than by directly addressing the name of the variable because of context issues: addressing variable by name creates it in the context of defining class, while calling the setter/getter method addresses it in the context of descendant class, which is what we need.</p>
480
+ <div class="method-controls">
481
+ <details class="method-source-toggle">
482
+ <summary>Source</summary>
483
+ </details>
484
+ </div>
485
+
486
+
487
+
488
+ <div class="method-description">
337
489
 
338
490
  <div class="method-source-code" id="obtain_class_variable-source">
339
491
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 15</span>
340
492
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">obtain_class_variable</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> = <span class="ruby-keyword">nil</span>)
341
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-identifier">var_name</span>)
342
- <span class="ruby-keyword">rescue</span> <span class="ruby-constant">NameError</span>
343
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> <span class="ruby-operator">||</span> {})
493
+ <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_defined?</span> <span class="ruby-identifier">var_name</span>
494
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_get</span>(<span class="ruby-identifier">var_name</span>)
495
+ <span class="ruby-keyword">else</span>
496
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class_variable_set</span>(<span class="ruby-identifier">var_name</span>, <span class="ruby-identifier">default</span> <span class="ruby-operator">||</span> {})
497
+ <span class="ruby-keyword">end</span>
344
498
  <span class="ruby-keyword">end</span></pre>
345
499
  </div>
500
+
501
+
502
+
503
+ <p>Get the value of a [sub]class variable if it exists, or create the respective variable with the passed-in <code>default</code> (or +{}+, if not specified)</p>
504
+
505
+ <p>Throughout this class, we are setting class variables through explicit method calls rather than by directly addressing the name of the variable because of context issues: addressing variable by name creates it in the context of defining class, while calling the setter/getter method addresses it in the context of descendant class, which is what we need.</p>
506
+
507
+
346
508
  </div>
347
509
 
348
510
 
511
+
512
+
513
+
349
514
  </div>
350
515
 
351
- <div id="method-i-parse" class="method-detail ">
516
+
517
+ <div id="method-i-parse" class="method-detail anchor-link ">
352
518
  <div class="method-header">
353
- <div class="method-heading">
354
- <span class="method-name">parse</span><span
355
- class="method-args">(node, known_namespaces = nil)</span>
356
- <span class="method-click-advice">click to toggle source</span>
357
- </div>
519
+
520
+ <div class="method-heading">
521
+ <a href="#method-i-parse" title="Link to this method">
522
+ <span class="method-name">parse</span>
523
+ <span class="method-args">(node, known_namespaces = nil)</span>
524
+ </a>
525
+ </div>
526
+
358
527
  </div>
359
528
 
529
+
530
+ <div class="method-controls">
531
+ <details class="method-source-toggle">
532
+ <summary>Source</summary>
533
+ </details>
534
+ </div>
535
+
536
+
537
+
360
538
  <div class="method-description">
361
-
362
539
 
363
540
  <div class="method-source-code" id="parse-source">
364
- <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 114</span>
541
+ <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 116</span>
365
542
  <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-identifier">node</span>, <span class="ruby-identifier">known_namespaces</span> = <span class="ruby-keyword">nil</span>)
366
543
  <span class="ruby-keyword">case</span> <span class="ruby-identifier">node</span>
367
544
  <span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>, <span class="ruby-constant">IO</span>, <span class="ruby-constant">Zip</span><span class="ruby-operator">::</span><span class="ruby-constant">InputStream</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">node</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">node</span>)
@@ -436,20 +613,25 @@
436
613
  <span class="ruby-identifier">obj</span>
437
614
  <span class="ruby-keyword">end</span></pre>
438
615
  </div>
616
+
617
+
618
+
619
+
620
+
621
+
439
622
  </div>
440
623
 
441
624
 
625
+
626
+
627
+
442
628
  </div>
443
629
 
630
+
444
631
  </section>
445
632
 
446
633
  </section>
447
- </main>
448
634
 
449
-
450
- <footer id="validator-badges" role="contentinfo">
451
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
452
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
453
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
454
- </footer>
635
+ </main>
636
+ </body>
455
637