U cqe7@s dZddlmZddlmZmZmZmZddlm Z ddl m Z ddl m Z ddlmZmZmZerddlmZdd lmZmZdd lmZmZdd lmZdd lmZGd ddeZGddde ZGdddeZ GdddeZ!GdddeZ"GdddeZ#dS)z-The |Table| object and related proxy classes.) annotations) TYPE_CHECKINGListTupleoverload)BlockItemContainer) WD_STYLE_TYPE)ST_Merge)InchesParented lazyproperty)types)WD_TABLE_ALIGNMENTWD_TABLE_DIRECTION)CT_TblCT_TblPr)Length) _TableStylecsbeZdZdZdddfdd Zddd d Zd d Zed dddZej d dddZeddddZ e j ddddZ ddddddZ dddddZ e d d!Zddd"d#d$Ze d%dd&d'Zed(dd)d*Zej d(d+d,d*Zed-d.Zed/dd0d1Zej d/dd2d1Zeddd3d4Zed5d6Zed7dd8d9ZZS):Tablez7Proxy class for a WordprocessingML ```` element.rz t.StoryChild)tblparentcs tt||||_|_dSN)superr__init___element_tblselfrr __class__./tmp/pip-unpacked-wheel-gx5hpqp3/docx/table.pyrszTable.__init__r)widthcCs<|jj}|}||_|jjD]}|}||_qt||S)zIReturn a |_Column| object of `width`, newly added rightmost to the table.)rtblGridZ add_gridColwtr_lstadd_tcr"_Column)rr"r#gridColtrtcr r r! add_columns zTable.add_columncCs6|j}|}|jjD]}|}|j|_qt||S)z?Return a |_Row| instance, newly added bottom-most to the table.)rZadd_trr# gridCol_lstr&r$r"_Row)rrr)r(r*r r r!add_row%s   z Table.add_rowzWD_TABLE_ALIGNMENT | NonereturncCs|jjS)aRead/write. A member of :ref:`WdRowAlignment` or None, specifying the positioning of this table between the page margins. |None| if no setting is specified, causing the effective value to be inherited from the style hierarchy. _tblPr alignmentrr r r!r3.szTable.alignment)valuecCs ||j_dSrr1rr5r r r!r38sboolcCs|jjS)a|True| if column widths can be automatically adjusted to improve the fit of cell contents. |False| if table layout is fixed. Column widths are adjusted in either case if total column width exceeds page width. Read/write boolean. r2autofitr4r r r!r9<sz Table.autofitcCs ||j_dSrr8r6r r r!r9Fsint_Cell)row_idxcol_idxr0cCs|||j}|j|S)zb|_Cell| at `row_idx`, `col_idx` intersection. (0, 0) is the top, left-most cell.  _column_count_cells)rr<r=Zcell_idxr r r!cellJsz Table.cellz List[_Cell]) column_idxr0cs*|jt|t|j}fdd|DS)z>Sequence of cells in the column at `column_idx` in this table.csg|] }|qSr r ).0idxcellsr r! Vsz&Table.column_cells..)r@rangelenr?)rrBZidxsr rEr! column_cellsRszTable.column_cellscCs t|j|S)zG|_Columns| instance representing the sequence of columns in this table.)_Columnsrr4r r r!columnsXsz Table.columns)r<r0cCs$|j}||}||}|j||S)z8Sequence of cells in the row at `row_idx` in this table.r>)rr<Z column_countstartendr r r! row_cells]szTable.row_cells_RowscCs t|j|S)z?|_Rows| instance containing the sequence of rows in this table.)rPrr4r r r!rowsdsz Table.rowsz_TableStyle | NonecCs|jj}|j|tjS)am|_TableStyle| object representing the style applied to this table. Read/write. 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_idr r r!styleis z Table.style) style_or_namecCs|j|tj}||j_dSr)rSZ get_style_idrrTrrR)rrWrUr r r!rVyscCs|S)aProvide 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 r4r r r!table~sz Table.tablezWD_TABLE_DIRECTION | NonecCs|jjS)zMember of :ref:`WdTableDirection` indicating cell-ordering direction. For example: `WD_TABLE_DIRECTION.LTR`. |None| indicates the value is inherited from the style hierarchy. rZbidiVisual_valr4r r r!table_directionszTable.table_directioncCs ||j_dSrrYr6r r r!rZscCst|j}g}|jD]Z}t|jD]J}|jtjkrD||| q"|dkr\||dq"|t ||q"q|S)zA 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_tcsrHZ grid_spanZvMerger CONTINUEappendr;)r col_countrFr*Z grid_span_idxr r r!r@s z Table._cellscCs|jjS)z)The number of grid columns in this table.)rr^r4r r r!r?szTable._column_countrcCs|jjSr)rZtblPrr4r r r!r2sz Table._tblPr)__name__ __module__ __qualname____doc__rr+r.propertyr3setterr9rArJr rLrOrQrVrXrZr@r?r2 __classcell__r r rr!rsF       rcseZdZdZfddZdfdd Zfdd Zd d Zefd d Z efddZ eddddZ e j ddZ eddZ e j ddZ eddZej ddZZS)r;z Table cell.cs"tt|||||_|_dSr)rr;r_tcr)rr*rrr r!rsz_Cell.__init__Ncstt|||S)aReturn 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. )rr; add_paragraph)rtextrVrr r!rhs 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. N)r"r rr; add_tablerh)rrQcolsr"rXrr r!rksz_Cell.add_tablecCs$|j|j}}||}t||jS)zReturn 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. )rfmerger;_parent)rZ other_cellr*Ztc_2Z merged_tcr r r!rms z _Cell.mergecs tt|jS)zList 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 )rr; paragraphsr4rr r!rosz_Cell.paragraphscs tt|jS)zRList of tables in the cell, in the order they appear. Read-only. )rr;tablesr4rr r!rpsz _Cell.tablesstrr/cCsddd|jDS)zThe 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|] }|jVqdSr)ri)rCpr r r! sz_Cell.text..)joinror4r r r!risz _Cell.textcCs(|j}||}|}||_dS)zWrite-only. Set entire contents of cell to the string `text`. Any existing content or revisions are replaced. N)rf clear_contentZadd_pZadd_rri)rrir*rsrr r r!ris 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)rrxr r r!vertical_alignmentsz_Cell.vertical_alignmentcCs|j}||_dSr)rZget_or_add_tcPrry)rr5rxr r r!rzs cCs|jjS)zEThe width of this cell in EMU, or |None| if no explicit width is set.rfr"r4r r r!r"sz _Cell.widthcCs ||j_dSrr{r6r r r!r"s)rgN)r_r`rarbrrhrkrmrcrorprirdrzr"rer r rr!r;s*       r;cs^eZdZdZfddZeddZeddZedd Zej d d Zed d Z Z S) r'z Table column.cstt||||_dSr)rr'r_gridCol)rr(rrr r!r"sz_Column.__init__cCst|j|jS)zDSequence of |_Cell| instances corresponding to cells in this column.)tuplerXrJ_indexr4r r r!rF&sz _Column.cellscCs|jjS)z7Reference to the |Table| object this column belongs to.rnrXr4r r r!rX+sz _Column.tablecCs|jjS)zGThe width of this column in EMU, or |None| if no explicit width is set.r|r$r4r r r!r"0sz _Column.widthcCs ||j_dSrrr6r r r!r"5scCs|jjS)z6Index of this column in its table, starting from zero.)r|Z gridCol_idxr4r r r!r~9sz_Column._index) r_r`rarbrrcrFrXr"rdr~rer r rr!r's     r'csPeZdZdZfddZddZddZdd Zed d Z ed d Z Z S)rKzSequence of |_Column| instances corresponding to the columns in a table. Supports ``len()``, iteration and indexed access. cstt||||_dSr)rrKrrrrr r!rEsz_Columns.__init__cCs>z|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')rrDr(msgr r r! __getitem__Is z_Columns.__getitem__ccs|jD]}t||VqdSr)rr')rr(r r r!__iter__Rs z_Columns.__iter__cCs t|jSr)rIrr4r r r!__len__Vsz_Columns.__len__cCs|jjS)zBReference to the |Table| object this column collection belongs to.rr4r r r!rXYsz_Columns.tablecCs|jj}|jS)zfSequence containing ```` elements for this table, each representing a table column.)rr#r,)rr#r r r!r^sz_Columns._gridCol_lst) r_r`rarbrrrrrcrXrrer r rr!rK?s   rKcs~eZdZdZfddZeddddZedd Zejd d Zed d Z e jd d Z eddZ eddZ Z S)r-z Table row.cs tt||||_|_dSr)rr-r_trr)rr)rrr r!risz _Row.__init__z Tuple[_Cell]r/cCst|j|jS)zASequence of |_Cell| instances corresponding to cells in this row.)r}rXrOr~r4r r r!rFmsz _Row.cellscCs|jjS)znReturn a |Length| object representing the height of this cell, or |None| if no explicit height is set.rZ trHeight_valr4r r r!heightrsz _Row.heightcCs ||j_dSrrr6r r r!rxscCs|jjS)zReturn the height rule of this cell as a member of the :ref:`WdRowHeightRule` enumeration, or |None| if no explicit height_rule is set.rZtrHeight_hRuler4r r r! height_rule|sz_Row.height_rulecCs ||j_dSrrr6r r r!rscCs|jjS)z4Reference to the |Table| object this row belongs to.rr4r r r!rXsz _Row.tablecCs|jjS)z3Index of this row in its table, starting from zero.)rZtr_idxr4r r r!r~sz _Row._index) r_r`rarbrrcrFrrdrrXr~rer r rr!r-fs       r-csteZdZdZfddZedddddZed d dd dZd d dddZddZddZe ddZ Z S)rPzSequence of |_Row| objects corresponding to the rows in a table. Supports ``len()``, iteration, indexed access, and slicing. cstt||||_dSr)rrPrrrrr r!rsz_Rows.__init__r:r-)rDr0cCsdSrr rrDr r r!rsz_Rows.__getitem__slicez List[_Row]cCsdSrr rr r r!rsz int | slicez_Row | List[_Row]cCs t||S)z7Provide indexed access, (e.g. `rows[0]` or `rows[1:3]`))listrr r r!rscsfddjjDS)Nc3s|]}t|VqdSr)r-)rCr)r4r r!rtsz!_Rows.__iter__..)rr%r4r r4r!rsz_Rows.__iter__cCs t|jjSr)rIrr%r4r r r!rsz _Rows.__len__cCs|jjS)z?Reference to the |Table| object this row collection belongs to.rr4r r r!rXsz _Rows.table) r_r`rarbrrrrrrcrXrer r rr!rPs rPN)$rb __future__rtypingrrrrZ docx.blkcntnrrZdocx.enum.stylerZdocx.oxml.simpletypesr Z docx.sharedr r r Zdocxr tZdocx.enum.tablerrZdocx.oxml.tablerrrZdocx.styles.stylerrr;r'rKr-rPr r r r!s&       m '+