Method: Spreadsheet::Excel::Writer::Format#write_xf

Defined in:
lib/spreadsheet/excel/writer/format.rb

#write_xf(writer, type = ) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/spreadsheet/excel/writer/format.rb', line 87

def write_xf writer, type = @opts[:type]
  xf_type = xf_type_prot type
  data = [
    font_index,   # Index to FONT record (➜ 6.43)
    num_format,   # Index to FORMAT record (➜ 6.45)
    xf_type,      #  Bit  Mask    Contents
    #  2-0  0x0007  XF_TYPE_PROT – XF type, cell protection
    #               Bit  Mask  Contents
    #                 0  0x01  1 = Cell is locked
    #                 1  0x02  1 = Formula is hidden
    #                 2  0x04  0 = Cell XF; 1 = Style XF
    # 15-4  0xfff0  Index to parent style XF
    #               (always 0xfff in style XFs)
    xf_align,     #  Bit  Mask    Contents
    #  2-0  0x07    XF_HOR_ALIGN – Horizontal alignment
    #               Value  Horizontal alignment
    #               0x00   General
    #               0x01   Left
    #               0x02   Centred
    #               0x03   Right
    #               0x04   Filled
    #               0x05   Justified (BIFF4-BIFF8X)
    #               0x06   Centred across selection
    #                      (BIFF4-BIFF8X)
    #               0x07   Distributed (BIFF8X)
    #    3  0x08    1 = Text is wrapped at right border
    #  6-4  0x70    XF_VERT_ALIGN – Vertical alignment
    #               Value  Vertical alignment
    #               0x00   Top
    #               0x01   Centred
    #               0x02   Bottom
    #               0x03   Justified (BIFF5-BIFF8X)
    #               0x04   Distributed (BIFF8X)
    xf_rotation,  # XF_ROTATION:  Text rotation angle
    #  Value  Text rotation
    #      0  Not rotated
    #   1-90  1 to 90 degrees counterclockwise
    # 91-180  1 to 90 degrees clockwise
    #    255  Letters are stacked top-to-bottom,
    #         but not rotated
    xf_indent,    #  Bit  Mask  Contents
    #  3-0  0x0f  Indent level
    #    4  0x10  1 = Shrink content to fit into cell
    #    5  0x40  1 = Merge Range (djberger)
    #  7-6  0xc0  Text direction (BIFF8X only)
    #             0 = According to context
    #             1 = Left-to-right
    #             2 = Right-to-left
    xf_used_attr, #  Bit  Mask  Contents
    #  7-2  0xfc  XF_USED_ATTRIB – Used attributes
    #             Each bit describes the validity of a
    #             specific group of attributes. In cell XFs
    #             a cleared bit means the attributes of the
    #             parent style XF are used (but only if the
    #             attributes are valid there), a set bit
    #             means the attributes of this XF are used.
    #             In style XFs a cleared bit means the
    #             attribute setting is valid, a set bit
    #             means the attribute should be ignored.
    #             Bit  Mask  Contents
    #               0  0x01  Flag for number format
    #               1  0x02  Flag for font
    #               2  0x04  Flag for horizontal and
    #                        vertical alignment, text wrap,
    #                        indentation, orientation,
    #                        rotation, and text direction
    #               3  0x08  Flag for border lines
    #               4  0x10  Flag for background area style
    #               5  0x20  Flag for cell protection (cell
    #                        locked and formula hidden)
    xf_borders,   # Cell border lines and background area:
    #   Bit  Mask        Contents
    #  3- 0  0x0000000f  Left line style (➜ 3.10)
    #  7- 4  0x000000f0  Right line style (➜ 3.10)
    # 11- 8  0x00000f00  Top line style (➜ 3.10)
    # 15-12  0x0000f000  Bottom line style (➜ 3.10)
    # 22-16  0x007f0000  Colour index (➜ 6.70)
    #                    for left line colour
    # 29-23  0x3f800000  Colour index (➜ 6.70)
    #                    for right line colour
    #    30  0x40000000  1 = Diagonal line
    #                    from top left to right bottom
    #    31  0x80000000  1 = Diagonal line
    #                    from bottom left to right top
    xf_brdcolors, #   Bit  Mask        Contents
    #  6- 0  0x0000007f  Colour index (➜ 6.70)
    #                    for top line colour
    # 13- 7  0x00003f80  Colour index (➜ 6.70)
    #                    for bottom line colour
    # 20-14  0x001fc000  Colour index (➜ 6.70)
    #                    for diagonal line colour
    # 24-21  0x01e00000  Diagonal line style (➜ 3.10)
    # 31-26  0xfc000000  Fill pattern (➜ 3.11)
    xf_pattern    #   Bit  Mask        Contents
    #   6-0  0x007f      Colour index (➜ 6.70)
    #                    for pattern colour
    #  13-7  0x3f80      Colour index (➜ 6.70)
    #                    for pattern background
  ]
  write_op writer, 0x00e0, data.pack(binfmt(:xf))
end