From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/CellProtection.html | 551 ------------------------------------------ 1 file changed, 551 deletions(-) delete mode 100644 doc/Axlsx/CellProtection.html (limited to 'doc/Axlsx/CellProtection.html') diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html deleted file mode 100644 index ae7793ce..00000000 --- a/doc/Axlsx/CellProtection.html +++ /dev/null @@ -1,551 +0,0 @@ - - - - - - Class: Axlsx::CellProtection - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::CellProtection - - - -

- -
- -
Inherits:
-
- Object - -
    -
  • Object
    • - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/stylesheet/cell_protection.rb
- -
-
- -

Overview

-
- -
- Note: -
-

Using Styles#add_style is the recommended way to manage cell protection.

-
-
- - -

CellProtection stores information about locking or hiding cells in -spreadsheet.

- - -
-
-
- - -

See Also:

- - -
- -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (CellProtection) initialize(options = {}) - - - -

-
- -

Creates a new CellProtection

- - -
-
-
-

Parameters:

-
    - -
  • - - options - - - (Hash) - - - (defaults to: {}) - - - — -
    -

    a customizable set of options

    -
    - -
    • - -
- - - - -

Options Hash (options):

-
    - -
  • - hidden - (Boolean) - - - - —
    -

    value for hidden protection

    -
    -
    • - -
  • - locked - (Boolean) - - - - —
    -

    value for locked protection

    -
    -
    • - -
- - - -
- - - - -
- 
-
-
-18
-19
-20
-21
-22
- 		- 
# File 'lib/axlsx/stylesheet/cell_protection.rb', line 18
-
-def initialize(options={})
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-  end
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (Boolean) hidden - - - -

-
- -

specifies locking for cells that have the style containing this protection

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Boolean) - - - -
    • - -
- -
- - - - -
- 
-
-
-9
-10
-11
- 		- 
# File 'lib/axlsx/stylesheet/cell_protection.rb', line 9
-
-def 
-  @hidden
-end
-
-
-
- - - - -
-

- - - (Boolean) locked - - - -

-
- -

specifies if the cells that have the style containing this protection

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Boolean) - - - -
    • - -
- -
- - - - -
- 
-
-
-13
-14
-15
- 		- 
# File 'lib/axlsx/stylesheet/cell_protection.rb', line 13
-
-def locked
-  @locked
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (String) to_xml(xml) - - - -

-
- -

Serializes the cell protection

- - -
-
-
-

Parameters:

-
    - -
  • - - xml - - - (Nokogiri::XML::Builder) - - - - — -
    -

    The document builder instance this objects xml will be added to.

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-32
-33
-34
- 		- 
# File 'lib/axlsx/stylesheet/cell_protection.rb', line 32
-
-def to_xml(xml)
-  xml.protection(self.instance_values)
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3