3 WY=@s6ddlmZddlTddlTdgZGdddeZdS))Atspi)*Tablec@s@eZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,Zeeed-Zd.d/Zd0Zeeed-Zd1d2Zd3Z eee d-Z!d4d5Z"d6Z#ee"e#d-Z$d7d8Z%d9Z&ee%e&d-Z'd:d;Z(drah An interface used by containers whose contained data is arranged in a "tabular" (i.e. row-column) fashion. Tables may resemble a two-dimensional grid, as in a spreadsheet, or may feature objects which span multiple rows and/or columns, but whose bounds are aligned on a row/column matrix. Thus, the Table interface may be used to represent "spreadsheets" as well as "frames". Objects within tables are children of the Table instance, and they may be referenced either via a child index or via a row/column pair. Their role may be ROLE_TABLE_CELL, but table 'cells' may have other roles as well. These 'cells' may implement other interfaces, such as Text, Action, Image, and Component, and should do so as appropriate to their onscreen representation and/or behavior. cCstjj|j|S)a2 Select the specified column, adding it to the current column selection, if the table's selection model permits it. @param : column @return True if the specified column was successfully selected, False if not. )rrZadd_column_selectionobj)selfcolumnr//usr/lib/python3/dist-packages/pyatspi/table.pyaddColumnSelection*szTable.addColumnSelectioncCstjj|j|S)a& Select the specified row, adding it to the current row selection, if the table's selection model permits it. @param : row @return True if the specified row was successfully selected, False if not. )rrZadd_row_selectionr)rrowrrr addRowSelection4szTable.addRowSelectioncCstjj|j||S)aq Get the table cell at the specified row and column indices. @param : row the specified table row, zero-indexed. @param : column the specified table column, zero-indexed. @return an Accessible object representing the specified table cell. )rrZget_accessible_atr)rr rrrr getAccessibleAt>s zTable.getAccessibleAtcCstjj|j|S)ay Get the table column index occupied by the child at a particular 1-D child index. @param : index the specified child index, zero-indexed. @return a long integer indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) index. )rrZget_column_at_indexr)rindexrrr getColumnAtIndexJs zTable.getColumnAtIndexcCstjj|j|S)a| Get a text description of a particular table column. This differs from AccessibleTable_getColumnHeader, which returns an Accessible. @param : column the specified table column, zero-indexed. @return a UTF-8 string describing the specified table column, if available. )rrZget_column_descriptionr)rrrrr getColumnDescriptionUs zTable.getColumnDescriptioncCstjj|j||S)a Get the number of columns spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). @param : row the specified table row, zero-indexed. @param : column the specified table column, zero-indexed. @return a long integer indicating the number of columns spanned by the specified cell. )rrZget_column_extent_atr)rr rrrr getColumnExtentAt`s zTable.getColumnExtentAtcCstjj|j|S)a Get the header associated with a table column, if available, as an instance of Accessible. This differs from getColumnDescription, which returns a string. @param : column the specified table column, zero-indexed. @return an Accessible representatin of the specified table column, if available. )rrZget_column_headerr)rrrrr getColumnHeaderns zTable.getColumnHeadercCstjj|j||S)a Get the 1-D child index corresponding to the specified 2-D row and column indices. @param : row the specified table row, zero-indexed. @param : column the specified table column, zero-indexed. @return a long integer which serves as the index of a specified cell in the table, in a form usable by Accessible::getChildAtIndex. )rrZ get_index_atr)rr rrrr getIndexAtzs zTable.getIndexAtcCstjj|j|S)as Get the table row index occupied by the child at a particular 1-D child index. @param : index the specified child index, zero-indexed. @return a long integer indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) index. )rrZget_row_at_indexr)rrrrr getRowAtIndexs zTable.getRowAtIndexcCstjj|j|S)a Given a child index, determine the row and column indices and extents, and whether the cell is currently selected. If the child at index is not a cell (for instance, if it is a summary, caption, etc.), False is returned. @param : index the index of the Table child whose row/column extents are requested. @param : row back-filled with the first table row associated with the cell with child index index. @param : col back-filled with the first table column associated with the cell with child index index. @param : row_extents back-filled with the number of table rows across which child i extends. @param : col_extents back-filled with the number of table columns across which child i extends. @param : is_selected a boolean which is back-filled with True if the child at index i corresponds to a selected table cell, False otherwise. Example: If the Table child at index '6' extends across columns 5 and 6 of row 2 of a Table instance, and is currently selected, then retval=table::getRowColumnExtentsAtIndex(6,row,col, row_extents, col_extents, is_selected); will return True, and after the call row, col, row_extents, col_extents, and is_selected will contain 2, 5, 1, 2, and True, respectively. @return True if the index is associated with a valid table cell, False if the index does not correspond to a cell. If False is returned, the values of the out parameters are undefined. )rrZget_row_column_extents_at_indexr)rrrrr getRowColumnExtentsAtIndexs$z Table.getRowColumnExtentsAtIndexcCstjj|j|S)am Get a text description of a particular table row. This differs from AccessibleTable_getRowHeader, which returns an Accessible. @param : row the specified table row, zero-indexed. @return a UTF-8 string describing the specified table row, if available. )rrZget_row_descriptionr)rrrrr getRowDescriptions zTable.getRowDescriptioncCstjj|j||S)a Get the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). @param : row the specified table row, zero-indexed. @param : column the specified table column, zero-indexed. @return a long integer indicating the number of rows spanned by the specified cell. )rrZget_row_extent_atr)rr rrrr getRowExtentAts zTable.getRowExtentAtcCstjj|j|S)aj Get the header associated with a table row, if available. This differs from getRowDescription, which returns a string. @param : row the specified table row, zero-indexed. @return an Accessible representatin of the specified table row, if available. )rrZget_row_headerr)rr rrr getRowHeaders zTable.getRowHeadercCstjj|jS)z Obtain the indices of all columns which are currently selected. @return a sequence of integers comprising the indices of columns currently selected. )rrZget_selected_columnsr)rrrr getSelectedColumnsszTable.getSelectedColumnscCstjj|jS)z Obtain the indices of all rows which are currently selected. @return a sequence of integers comprising the indices of rows currently selected. )rrZget_selected_rowsr)rrrr getSelectedRowsszTable.getSelectedRowscCstjj|j|S)a Determine whether a table column is selected. @param : column the column being queried. @return True if the specified column is currently selected, False if not. )rrZis_column_selectedr)rrrrr isColumnSelectedszTable.isColumnSelectedcCstjj|j|S)z Determine whether a table row is selected. @param : row the row being queried. @return True if the specified row is currently selected, False if not. )rrZis_row_selectedr)rr rrr isRowSelectedszTable.isRowSelectedcCstjj|j||S)a Determine whether the cell at a specific row and column is selected. @param : row a row occupied by the cell whose state is being queried. @param : column a column occupied by the cell whose state is being queried. @return True if the specified cell is currently selected, False if not. )rrZ is_selectedr)rr rrrr isSelecteds zTable.isSelectedcCstjj|j|S)a( Remove the specified column from current column selection, if the table's selection model permits it. @param : column @return True if the specified column was successfully de-selected, False if not. )rrZremove_column_selectionr)rrrrr removeColumnSelection szTable.removeColumnSelectioncCstjj|j|S)a Remove the specified row from current row selection, if the table's selection model permits it. @param : row @return True if the specified row was successfully de-selected, False if not. )rrZremove_row_selectionr)rr rrr removeRowSelectionszTable.removeRowSelectioncCstjj|jS)N)rr get_captionr)rrrr r szTable.get_captionzZ An Accessible which represents of a caption for a Table. )fgetdoccCstjj|jS)N)rrZ get_n_columnsr)rrrr get_nColumns(szTable.get_nColumnsa& The total number of columns in this table (including empty columns), exclusive of columns which are programmatically hidden. Columns which are scrolled out of view or clipped by the current viewport are included. cCstjj|jS)N)rrZ get_n_rowsr)rrrr get_nRows3szTable.get_nRowsz The total number of rows in this table (including empty rows), exclusive of any rows which are programmatically hidden. Rows which are merely scrolled out of view are included. cCstjj|jS)N)rrZget_n_selected_columnsr)rrrr get_nSelectedColumns=szTable.get_nSelectedColumnsz The number of columns currently selected. A selected column is one in which all included cells are selected. cCstjj|jS)N)rrZget_n_selected_rowsr)rrrr get_nSelectedRowsFszTable.get_nSelectedRowsz The number of rows currently selected. A selected row is one in which all included cells are selected. cCstjj|jS)N)rr get_summaryr)rrrr r'OszTable.get_summaryz An accessible object which summarizes the contents of a Table. This object is frequently itself a Table instance, albeit a simplified one. N)+__name__ __module__ __qualname____doc__r r r rrrrrrrrrrrrrrrrrr Z _captionDocpropertyZcaptionr#Z _nColumnsDocZnColumnsr$Z _nRowsDocZnRowsr%Z_nSelectedColumnsDocZnSelectedColumnsr&Z_nSelectedRowsDocZ nSelectedRowsr'Z _summaryDocZsummaryrrrr rsN        &            N)Z gi.repositoryrZ pyatspi.utilsZpyatspi.interface__all__Z interfacerrrrr s