The XF Object
=============

.. class:: XF

   eXtended Formatting information for cells, rows, columns and styles.

   - *New in version 0.6.1*

   Each of the 6 flags below describes the validity of
   a specific group of attributes.

   In cell XFs, flag==0 means the attributes of the parent style XF are used,
   (but only if the attributes are valid there); flag==1 means the attributes
   of this XF are used.

   In style XFs, flag==0 means the attribute setting is valid; flag==1 means
   the attribute should be ignored.

   Note that the API
   provides both "raw" XFs and "computed" XFs -- in the latter case, cell XFs
   have had the above inheritance mechanism applied.


.. attribute:: XF._alignment_flag

.. attribute:: XF._background_flag

.. attribute:: XF._border_flag

.. attribute:: XF._font_flag

.. attribute:: XF._format_flag

.. attribute:: XF._protection_flag

.. attribute:: XF.alignment

   An instance of an :class:`XFAlignment` object.

.. attribute:: XF.background

   An instance of an :class:`XFBackground` object.

.. attribute:: XF.border

   An instance of an :class:`XFBorder` object.

.. attribute:: XF.font_index

   Index into Book.font_list

.. attribute:: XF.format_key

   Key into Book.format_map

.. WARNING:: OOo docs on the XF record call this "Index to FORMAT record".
   It is not an index in the Python sense. It is a key to a map.
   It is true *only* for Excel 4.0 and earlier files
   that the key into format_map from an XF instance
   is the same as the index into format_list, and *only*
   if the index is less than 164.

.. attribute:: XF.is_style

   0 = cell XF, 1 = style XF

.. attribute:: XF.parent_style_index

   cell XF: Index into Book.xf_list of this XF's style XF

   style XF: 0xFFF

.. attribute:: XF.protection

   An instance of an XFProtection object.

.. attribute:: XF.xf_index

   Index into Book.xf_list