B Xx[17@sdZddlmZmZmZddlmZddlmZddl m Z ddl m Z m Z mZGdd d eZGd d d eZGd d d eZGdddeZGdddeZGdddeZdS)z/ The |Table| object and related proxy classes. )absolute_importprint_functionunicode_literals)BlockItemContainer) WD_STYLE_TYPE)ST_Merge)Inches lazypropertyParentedcseZdZdZfddZddZddZedd Zej d d Zed d Z e j d d Z ddZ ddZ e ddZddZe ddZeddZej ddZeddZeddZej ddZed d!Zed"d#Zed$d%ZZS)&TablezA Proxy class for a WordprocessingML ```` element. cs tt||||_|_dS)N)superr __init___element_tbl)selftblparent) __class__Ysz&Table.column_cells..)r)rangelenr()rZ column_idxZidxsr)r.r column_cellsSszTable.column_cellscCs t|j|S)za |_Columns| instance representing the sequence of columns in this table. )_Columnsr)rrrrcolumns[sz Table.columnscCs$|j}||}||}|j||S)zJ Sequence of cells in the row at *row_idx* in this table. )r(r))rr*Z column_countstartendrrr row_cellscszTable.row_cellscCs t|j|S)zQ |_Rows| instance containing the sequence of rows in this table. )_Rowsr)rrrrrowslsz Table.rowscCs|jj}|j|tjS)a~ Read/write. A |_TableStyle| object representing the style applied to this table. The default table style for the document (often `Normal Table`) is returned if the table has no directly-applied style. Assigning |None| to this property removes any directly-applied table style causing it to inherit the default table style of the document. Note that the style name of a table style differs slightly from that displayed in the user interface; a hyphen, if it appears, must be removed. For example, `Light Shading - Accent 1` becomes `Light Shading Accent 1`. )r tblStyle_valpartZ get_stylerTABLE)rstyle_idrrrstyless z Table.stylecCs|j|tj}||j_dS)N)r;Z get_style_idrr<rr:)rZ style_or_namer=rrrr>s cCs|S)a" Provide child objects with reference to the |Table| object they belong to, without them having to know their direct parent is a |Table| object. This is the terminus of a series of `parent._table` calls from an arbitrary child through its ancestors. r)rrrrtablesz Table.tablecCs|jjS)z A member of :ref:`WdTableDirection` indicating the direction in which the table cells are ordered, e.g. `WD_TABLE_DIRECTION.LTR`. |None| indicates the value is inherited from the style hierarchy. )rbidiVisual_val)rrrrtable_directionszTable.table_directioncCs ||j_dS)N)rr@)rr&rrrrAscCs||j}g}xl|jD]^}xXt|jD]J}|jtjkrH||| q&|dkr`||dq&|t ||q&WqW|S)z A sequence of |_Cell| objects, one for each cell of the layout grid. If the table contains a span, one or more |_Cell| object references are repeated. r) r(rZiter_tcsr0Z grid_spanZvMergerZCONTINUEappend_Cell)r col_countr.rZ grid_span_idxrrrr)s z Table._cellscCs|jjS)z; The number of grid columns in this table. )rrE)rrrrr(szTable._column_countcCs|jjS)N)rZtblPr)rrrrr$sz Table._tblPr)__name__ __module__ __qualname____doc__rr r#propertyr%setterr'r+r2r r4r7r9r>r?rAr)r(r$ __classcell__rr)rrr s*          r cseZdZdZfddZdfdd Zfdd Zd d Zefd d Z efddZ eddZ e j ddZ eddZ e j ddZ eddZej ddZZS)rDz Table cellcs"tt|||||_|_dS)N)r rDr_tcr)rrr)rrrrsz_Cell.__init__Ncstt|||S)a Return a paragraph newly added to the end of the content in this cell. If present, *text* is added to the paragraph in a single run. If specified, the paragraph style *style* is applied. If *style* is not specified or is |None|, the result is as though the 'Normal' style was applied. Note that the formatting of text in a cell can be influenced by the table style. *text* can contain tab (``\t``) characters, which are converted to the appropriate XML form for a tab. *text* can also include newline (``\n``) or carriage return (``\r``) characters, each of which is converted to a line break. )r rD add_paragraph)rtextr>)rrrrOs z_Cell.add_paragraphcs8|jdk r|jntd}tt||||}||S)a Return a table newly added to this cell after any existing cell content, having *rows* rows and *cols* columns. An empty paragraph is added after the table because Word requires a paragraph element as the last element in every cell. Nr)rr r rD add_tablerO)rr9colsrr?)rrrrQsz_Cell.add_tablecCs$|j|j}}||}t||jS)z Return a merged cell created by spanning the rectangular region having this cell and *other_cell* as diagonal corners. Raises |InvalidSpanError| if the cells do not define a rectangular region. )rMmergerD_parent)rZ other_cellrZtc_2Z merged_tcrrrrSs z _Cell.mergecs tt|jS)z List of paragraphs in the cell. A table cell is required to contain at least one block-level element and end with a paragraph. By default, a new cell contains a single paragraph. Read-only )r rD paragraphs)r)rrrrUsz_Cell.paragraphscs tt|jS)zR List of tables in the cell, in the order they appear. Read-only. )r rDtables)r)rrrrVsz _Cell.tablescCsddd|jDS)z The entire contents of this cell as a string of text. Assigning a string to this property replaces all existing content with a single paragraph containing the assigned text in a single run.  css|] }|jVqdS)N)rP)r,prrr sz_Cell.text..)joinrU)rrrrrPsz _Cell.textcCs(|j}||}|}||_dS)z Write-only. Set entire contents of cell to the string *text*. Any existing content or revisions are replaced. N)rM clear_contentZadd_pZadd_rrP)rrPrrXrrrrrPs cCs|jj}|dkrdS|jS)aMember of :ref:`WdCellVerticalAlignment` or None. A value of |None| indicates vertical alignment for this cell is inherited. Assigning |None| causes any explicitly defined vertical alignment to be removed, restoring inheritance. N)rtcPr vAlign_val)rr]rrrvertical_alignmentsz_Cell.vertical_alignmentcCs|j}||_dS)N)rZget_or_add_tcPrr^)rr&r]rrrr_s cCs|jjS)zW The width of this cell in EMU, or |None| if no explicit width is set. )rMr)rrrrr"sz _Cell.widthcCs ||j_dS)N)rMr)rr&rrrr)s)rNN)rFrGrHrIrrOrQrSrJrUrVrPrKr_rrLrr)rrrDs       rDcs^eZdZdZfddZeddZeddZedd Zej d d Zed d Z Z S) rz Table column cstt||||_dS)N)r rr_gridCol)rrr)rrrr2sz_Column.__init__cCst|j|jS)zV Sequence of |_Cell| instances corresponding to cells in this column. )tupler?r2_index)rrrrr.6sz _Column.cellscCs|jjS)zI Reference to the |Table| object this column belongs to. )rTr?)rrrrr?=sz _Column.tablecCs|jjS)za The width of this column in EMU, or |None| if no explicit width is set. )r`r)rrrrrDsz _Column.widthcCs ||j_dS)N)r`r)rr&rrrrLscCs|jjS)zH Index of this column in its table, starting from zero. )r`Z gridCol_idx)rrrrrbPsz_Column._index) rFrGrHrIrrJr.r?rrKrbrLrr)rrr.s    rcsPeZdZdZfddZddZddZdd Zed d Z ed d Z Z S)r3z Sequence of |_Column| instances corresponding to the columns in a table. Supports ``len()``, iteration and indexed access. cstt||||_dS)N)r r3rr)rrr)rrrr]sz_Columns.__init__cCs>y|j|}Wn$tk r2d|}t|YnXt||S)z; Provide indexed access, e.g. 'columns[0]' z!column index [%d] is out of range) _gridCol_lst IndexErrorr)rr-rmsgrrr __getitem__as z_Columns.__getitem__ccs x|jD]}t||VqWdS)N)rcr)rrrrr__iter__ls z_Columns.__iter__cCs t|jS)N)r1rc)rrrr__len__psz_Columns.__len__cCs|jjS)zT Reference to the |Table| object this column collection belongs to. )rTr?)rrrrr?ssz_Columns.tablecCs|jj}|jS)zx Sequence containing ```` elements for this table, each representing a table column. )rrr!)rrrrrrczsz_Columns._gridCol_lst) rFrGrHrIrrfrgrhrJr?rcrLrr)rrr3Xs   r3csxeZdZdZfddZeddZeddZejddZed d Z e jd d Z ed d Z eddZ Z S)r"z Table row cs tt||||_|_dS)N)r r"r_trr)rrr)rrrrsz _Row.__init__cCst|j|jS)zS Sequence of |_Cell| instances corresponding to cells in this row. )rar?r7rb)rrrrr.sz _Row.cellscCs|jjS)z Return a |Length| object representing the height of this cell, or |None| if no explicit height is set. )ri trHeight_val)rrrrheightsz _Row.heightcCs ||j_dS)N)rirj)rr&rrrrkscCs|jjS)z Return the height rule of this cell as a member of the :ref:`WdRowHeightRule` enumeration, or |None| if no explicit height_rule is set. )ritrHeight_hRule)rrrr height_rulesz_Row.height_rulecCs ||j_dS)N)rirl)rr&rrrrmscCs|jjS)zF Reference to the |Table| object this row belongs to. )rTr?)rrrrr?sz _Row.tablecCs|jjS)zE Index of this row in its table, starting from zero. )riZtr_idx)rrrrrbsz _Row._index) rFrGrHrIrrJr.rkrKrmr?rbrLrr)rrr"s     r"csDeZdZdZfddZddZddZdd Zed d Z Z S) r8z Sequence of |_Row| objects corresponding to the rows in a table. Supports ``len()``, iteration, indexed access, and slicing. cstt||||_dS)N)r r8rr)rrr)rrrrsz_Rows.__init__cCs t||S)z: Provide indexed access, (e.g. 'rows[0]') )list)rr-rrrrfsz_Rows.__getitem__csfddjjDS)Nc3s|]}t|VqdS)N)r")r,r)rrrrYsz!_Rows.__iter__..)rr)rr)rrrgsz_Rows.__iter__cCs t|jjS)N)r1rr)rrrrrhsz _Rows.__len__cCs|jjS)zQ Reference to the |Table| object this row collection belongs to. )rTr?)rrrrr?sz _Rows.table) rFrGrHrIrrfrgrhrJr?rLrr)rrr8s  r8N)rI __future__rrrZblkcntnrrZ enum.stylerZoxml.simpletypesrsharedr r r r rDrr3r"r8rrrrs   2n*,7