excel.py
68.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
#NVDAObjects/excel.py
#A part of NonVisual Desktop Access (NVDA)
#Copyright (C) 2006-2016 NV Access Limited, Dinesh Kaushal, Siddhartha Gupta
#This file is covered by the GNU General Public License.
#See the file COPYING for more details.
from comtypes import COMError
import comtypes.automation
import wx
import time
import re
import uuid
import collections
import oleacc
import ui
import speech
from tableUtils import HeaderCellInfo, HeaderCellTracker
import config
import textInfos
import colors
import eventHandler
import api
from logHandler import log
import gui
import winUser
from displayModel import DisplayModelTextInfo
import controlTypes
from . import Window
from .. import NVDAObjectTextInfo
import scriptHandler
import browseMode
import inputCore
import ctypes
xlNone=-4142
xlSimple=-4154
xlExtended=3
xlCenter=-4108
xlJustify=-4130
xlLeft=-4131
xlRight=-4152
xlDistributed=-4117
xlBottom=-4107
xlTop=-4160
xlDown=-4121
xlToLeft=-4159
xlToRight=-4161
xlUp=-4162
xlCellWidthUnitToPixels = 7.5919335705812574139976275207592
xlSheetVisible=-1
alignmentLabels={
xlCenter:"center",
xlJustify:"justify",
xlLeft:"left",
xlRight:"right",
xlDistributed:"distributed",
xlBottom:"botom",
xlTop:"top",
1:"default",
}
xlA1 = 1
xlRC = 2
xlUnderlineStyleNone=-4142
#Excel cell types
xlCellTypeAllFormatConditions =-4172 # from enum XlCellType
xlCellTypeAllValidation =-4174 # from enum XlCellType
xlCellTypeBlanks =4 # from enum XlCellType
xlCellTypeComments =-4144 # from enum XlCellType
xlCellTypeConstants =2 # from enum XlCellType
xlCellTypeFormulas =-4123 # from enum XlCellType
xlCellTypeLastCell =11 # from enum XlCellType
xlCellTypeSameFormatConditions=-4173 # from enum XlCellType
xlCellTypeSameValidation =-4175 # from enum XlCellType
xlCellTypeVisible =12 # from enum XlCellType
#MsoShapeType Enumeration
msoFormControl=8
msoTextBox=17
#XlFormControl Enumeration
xlButtonControl=0
xlCheckBox=1
xlDropDown=2
xlEditBox=3
xlGroupBox=4
xlLabel=5
xlListBox=6
xlOptionButton=7
xlScrollBar=8
xlSpinner=9
#MsoTriState Enumeration
msoTrue=-1 #True
msoFalse=0 #False
#CheckBox and RadioButton States
checked=1
unchecked=-4146
mixed=2
#LogPixels
LOGPIXELSX=88
LOGPIXELSY=90
#Excel Cell Patterns (from enum XlPattern)
xlPatternAutomatic = -4105
xlPatternChecker = 9
xlPatternCrissCross = 16
xlPatternDown = -4121
xlPatternGray16 = 17
xlPatternGray25 = -4124
xlPatternGray50 = -4125
xlPatternGray75 = -4126
xlPatternGray8 = 18
xlPatternGrid = 15
xlPatternHorizontal = -4128
xlPatternLightDown = 13
xlPatternLightHorizontal = 11
xlPatternLightUp = 14
xlPatternLightVertical = 12
xlPatternNone = -4142
xlPatternSemiGray75 = 10
xlPatternSolid = 1
xlPatternUp = -4162
xlPatternVertical = -4166
xlPatternLinearGradient = 4000
xlPatternRectangularGradient = 4001
backgroundPatternLabels={
# See https://msdn.microsoft.com/en-us/library/microsoft.office.interop.excel.xlpattern.aspx
# Translators: A type of background pattern in Microsoft Excel.
# Excel controls the pattern.
xlPatternAutomatic:_("automatic"),
# Translators: A type of background pattern in Microsoft Excel.
# Checkerboard
xlPatternChecker:_("diagonal crosshatch"),
# Translators: A type of background pattern in Microsoft Excel.
# Criss-cross lines
xlPatternCrissCross:_("thin diagonal crosshatch"),
# Translators: A type of background pattern in Microsoft Excel.
# Dark diagonal lines running from the upper left to the lower right
xlPatternDown:_("reverse diagonal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# 12.5% gray
# xgettext:no-python-format
xlPatternGray16:_("12.5% gray"),
# Translators: A type of background pattern in Microsoft Excel.
# 25% gray
# xgettext:no-python-format
xlPatternGray25:_("25% gray"),
# Translators: A type of background pattern in Microsoft Excel.
# xgettext:no-python-format
# 50% gray
xlPatternGray50:_("50% gray"),
# Translators: A type of background pattern in Microsoft Excel.
# 75% gray
# xgettext:no-python-format
xlPatternGray75:_("75% gray"),
# Translators: A type of background pattern in Microsoft Excel.
# 6.25% gray
# xgettext:no-python-format
xlPatternGray8:_("6.25% gray"),
# Translators: A type of background pattern in Microsoft Excel.
# Grid
xlPatternGrid:_("thin horizontal crosshatch"),
# Translators: A type of background pattern in Microsoft Excel.
# Dark horizontal lines
xlPatternHorizontal:_("horizontal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# Light diagonal lines running from the upper left to the lower right
xlPatternLightDown:_("thin reverse diagonal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# Light horizontal lines
xlPatternLightHorizontal:_("thin horizontal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# Light diagonal lines running from the lower left to the upper right
xlPatternLightUp:_("thin diagonal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# Light vertical bars
xlPatternLightVertical:_("thin vertical stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# No pattern
xlPatternNone:_("none"),
# Translators: A type of background pattern in Microsoft Excel.
# 75% dark moire
xlPatternSemiGray75:_("thick diagonal crosshatch"),
# Translators: A type of background pattern in Microsoft Excel.
# Solid color
xlPatternSolid:_("solid"),
# Translators: A type of background pattern in Microsoft Excel.
# Dark diagonal lines running from the lower left to the upper right
xlPatternUp:_("diagonal stripe"),
# Translators: A type of background pattern in Microsoft Excel.
# Dark vertical bars
xlPatternVertical:_("vertical stripe"),
# Translators: A type of background pattern in Microsoft Excel.
xlPatternLinearGradient:_("linear gradient"),
# Translators: A type of background pattern in Microsoft Excel.
xlPatternRectangularGradient:_("rectangular gradient"),
}
re_RC=re.compile(r'R(?:\[(\d+)\])?C(?:\[(\d+)\])?')
re_absRC=re.compile(r'^R(\d+)C(\d+)(?::R(\d+)C(\d+))?$')
class ExcelQuickNavItem(browseMode.QuickNavItem):
def __init__( self , nodeType , document , itemObject , itemCollection ):
self.excelItemObject = itemObject
self.excelItemCollection = itemCollection
super( ExcelQuickNavItem ,self).__init__( nodeType , document )
def activate(self):
pass
def isChild(self,parent):
return False
def report(self,readUnit=None):
pass
class ExcelChartQuickNavItem(ExcelQuickNavItem):
def __init__( self , nodeType , document , chartObject , chartCollection ):
self.chartIndex = chartObject.Index
if chartObject.Chart.HasTitle:
self.label = chartObject.Chart.ChartTitle.Text + " " + chartObject.TopLeftCell.address(False,False,1,False) + "-" + chartObject.BottomRightCell.address(False,False,1,False)
else:
self.label = chartObject.Name + " " + chartObject.TopLeftCell.address(False,False,1,False) + "-" + chartObject.BottomRightCell.address(False,False,1,False)
super( ExcelChartQuickNavItem ,self).__init__( nodeType , document , chartObject , chartCollection )
def __lt__(self,other):
return self.chartIndex < other.chartIndex
def moveTo(self):
try:
self.excelItemObject.Activate()
# After activate(), though the chart object is selected,
# pressing arrow keys moves the object, rather than
# let use go inside for sub-objects. Somehow
# calling an COM function on a different object fixes that !
log.debugWarning( self.excelItemCollection.Count )
except(COMError):
pass
focus=api.getDesktopObject().objectWithFocus()
if not focus or not isinstance(focus,ExcelBase):
return
# Charts are not yet automatically detected with objectFromFocus, so therefore use selection
sel=focus._getSelection()
if not sel:
return
eventHandler.queueEvent("gainFocus",sel)
@property
def isAfterSelection(self):
activeCell = self.document.Application.ActiveCell
#log.debugWarning("active row: {} active column: {} current row: {} current column: {}".format ( activeCell.row , activeCell.column , self.excelCommentObject.row , self.excelCommentObject.column ) )
if self.excelItemObject.TopLeftCell.row == activeCell.row:
if self.excelItemObject.TopLeftCell.column > activeCell.column:
return False
elif self.excelItemObject.TopLeftCell.row > activeCell.row:
return False
return True
class ExcelRangeBasedQuickNavItem(ExcelQuickNavItem):
def __lt__(self,other):
if self.excelItemObject.row == other.excelItemObject.row:
return self.excelItemObject.column < other.excelItemObject.column
else:
return self.excelItemObject.row < other.excelItemObject.row
def moveTo(self):
self.excelItemObject.Activate()
eventHandler.queueEvent("gainFocus",api.getDesktopObject().objectWithFocus())
@property
def isAfterSelection(self):
activeCell = self.document.Application.ActiveCell
log.debugWarning("active row: {} active column: {} current row: {} current column: {}".format ( activeCell.row , activeCell.column , self.excelItemObject.row , self.excelItemObject.column ) )
if self.excelItemObject.row == activeCell.row:
if self.excelItemObject.column > activeCell.column:
return False
elif self.excelItemObject.row > activeCell.row:
return False
return True
class ExcelCommentQuickNavItem(ExcelRangeBasedQuickNavItem):
def __init__( self , nodeType , document , commentObject , commentCollection ):
self.comment=commentObject.comment
self.label = commentObject.address(False,False,1,False) + " " + (self.comment.Text() if self.comment else "")
super( ExcelCommentQuickNavItem , self).__init__( nodeType , document , commentObject , commentCollection )
class ExcelFormulaQuickNavItem(ExcelRangeBasedQuickNavItem):
def __init__( self , nodeType , document , formulaObject , formulaCollection ):
self.label = formulaObject.address(False,False,1,False) + " " + formulaObject.Formula
super( ExcelFormulaQuickNavItem , self).__init__( nodeType , document , formulaObject , formulaCollection )
class ExcelQuicknavIterator(object):
"""
Allows iterating over an MS excel collection (e.g. Comments, Formulas or charts) emitting L{QuickNavItem} objects.
"""
def __init__(self, itemType , document , direction , includeCurrent):
"""
See L{QuickNavItemIterator} for itemType, document and direction definitions.
@ param includeCurrent: if true then any item at the initial position will be also emitted rather than just further ones.
"""
self.document=document
self.itemType=itemType
self.direction=direction if direction else "next"
self.includeCurrent=includeCurrent
def collectionFromWorksheet(self,worksheetObject):
"""
Fetches a Microsoft Excel collection object from a Microsoft excel worksheet object. E.g. charts, comments, or formula.
@param worksheetObject: a Microsoft excel worksheet object.
@return: a Microsoft excel collection object.
"""
raise NotImplementedError
def filter(self,item):
"""
Only allows certain items fom a collection to be emitted. E.g. a chart .
@param item: an item from a Microsoft excel collection (e.g. chart object).
@return True if this item should be allowd, false otherwise.
@rtype: bool
"""
return True
def iterate(self):
"""
returns a generator that emits L{QuickNavItem} objects for this collection.
"""
items=self.collectionFromWorksheet(self.document)
if not items:
return
if self.direction=="previous":
items=reversed(items)
for collectionItem in items:
item=self.quickNavItemClass(self.itemType,self.document,collectionItem , items )
if not self.filter(collectionItem):
continue
yield item
class ChartExcelCollectionQuicknavIterator(ExcelQuicknavIterator):
quickNavItemClass=ExcelChartQuickNavItem#: the QuickNavItem class that should be instanciated and emitted.
def collectionFromWorksheet( self , worksheetObject ):
return worksheetObject.ChartObjects()
class CommentExcelCollectionQuicknavIterator(ExcelQuicknavIterator):
quickNavItemClass=ExcelCommentQuickNavItem#: the QuickNavItem class that should be instanciated and emitted.
def collectionFromWorksheet( self , worksheetObject ):
try:
return worksheetObject.cells.SpecialCells( xlCellTypeComments )
except(COMError):
return None
def filter(self,item):
return item is not None and item.comment is not None
class FormulaExcelCollectionQuicknavIterator(ExcelQuicknavIterator):
quickNavItemClass=ExcelFormulaQuickNavItem#: the QuickNavItem class that should be instanciated and emitted.
def collectionFromWorksheet( self , worksheetObject ):
try:
return worksheetObject.cells.SpecialCells( xlCellTypeFormulas )
except(COMError):
return None
class ExcelSheetQuickNavItem(ExcelQuickNavItem):
def __init__( self , nodeType , document , sheetObject , sheetCollection ):
self.label = sheetObject.Name
self.sheetIndex = sheetObject.Index
self.sheetObject = sheetObject
super( ExcelSheetQuickNavItem , self).__init__( nodeType , document , sheetObject , sheetCollection )
def __lt__(self,other):
return self.sheetIndex < other.sheetIndex
def moveTo(self):
self.sheetObject.Activate()
eventHandler.queueEvent("gainFocus",api.getDesktopObject().objectWithFocus())
def rename(self,newName):
if newName and newName!=self.label:
self.sheetObject.Name=newName
self.label=newName
@property
def isRenameAllowed(self):
return True
@property
def isAfterSelection(self):
activeSheet = self.document.Application.ActiveSheet
if self.sheetObject.Index <= activeSheet.Index:
return False
else:
return True
class SheetsExcelCollectionQuicknavIterator(ExcelQuicknavIterator):
"""
Allows iterating over an MS excel Sheets collection emitting L{QuickNavItem} object.
"""
quickNavItemClass=ExcelSheetQuickNavItem#: the QuickNavItem class that should be instantiated and emitted.
def collectionFromWorksheet( self , worksheetObject ):
try:
return worksheetObject.Application.ActiveWorkbook.sheets
except(COMError):
return None
def filter(self,sheet):
if sheet.Visible==xlSheetVisible:
return True
class ExcelBrowseModeTreeInterceptor(browseMode.BrowseModeTreeInterceptor):
def __init__(self,rootNVDAObject):
super(ExcelBrowseModeTreeInterceptor,self).__init__(rootNVDAObject)
self.passThrough=True
browseMode.reportPassThrough.last=True
def _get_currentNVDAObject(self):
obj=api.getFocusObject()
return obj if obj.treeInterceptor is self else None
def _get_isAlive(self):
if not winUser.isWindow(self.rootNVDAObject.windowHandle):
return False
try:
return self.rootNVDAObject.excelWorksheetObject.name==self.rootNVDAObject.excelApplicationObject.activeSheet.name
except (COMError,AttributeError,NameError):
log.debugWarning("could not compare sheet names",exc_info=True)
return False
def navigationHelper(self,direction):
excelWindowObject=self.rootNVDAObject.excelWindowObject
cellPosition = excelWindowObject.activeCell
try:
if direction == "left":
cellPosition = cellPosition.Offset(0,-1)
elif direction == "right":
cellPosition = cellPosition.Offset(0,1)
elif direction == "up":
cellPosition = cellPosition.Offset(-1,0)
elif direction == "down":
cellPosition = cellPosition.Offset(1,0)
#Start-of-Column
elif direction == "startcol":
cellPosition = cellPosition.end(xlUp)
#Start-of-Row
elif direction == "startrow":
cellPosition = cellPosition.end(xlToLeft)
#End-of-Row
elif direction == "endrow":
cellPosition = cellPosition.end(xlToRight)
#End-of-Column
elif direction == "endcol":
cellPosition = cellPosition.end(xlDown)
else:
return
except COMError:
pass
try:
isMerged=cellPosition.mergeCells
except (COMError,NameError):
isMerged=False
if isMerged:
cellPosition=cellPosition.MergeArea(1)
obj=ExcelMergedCell(windowHandle=self.rootNVDAObject.windowHandle,excelWindowObject=excelWindowObject,excelCellObject=cellPosition)
else:
obj=ExcelCell(windowHandle=self.rootNVDAObject.windowHandle,excelWindowObject=excelWindowObject,excelCellObject=cellPosition)
cellPosition.Select()
cellPosition.Activate()
eventHandler.executeEvent('gainFocus',obj)
def script_moveLeft(self,gesture):
self.navigationHelper("left")
def script_moveRight(self,gesture):
self.navigationHelper("right")
def script_moveUp(self,gesture):
self.navigationHelper("up")
def script_moveDown(self,gesture):
self.navigationHelper("down")
def script_startOfColumn(self,gesture):
self.navigationHelper("startcol")
def script_startOfRow(self,gesture):
self.navigationHelper("startrow")
def script_endOfRow(self,gesture):
self.navigationHelper("endrow")
def script_endOfColumn(self,gesture):
self.navigationHelper("endcol")
def __contains__(self,obj):
return winUser.isDescendantWindow(self.rootNVDAObject.windowHandle,obj.windowHandle)
def _get_selection(self):
return self.rootNVDAObject._getSelection()
def _set_selection(self,info):
super(ExcelBrowseModeTreeInterceptor,self)._set_selection(info)
#review.handleCaretMove(info)
def _get_ElementsListDialog(self):
return ElementsListDialog
def _iterNodesByType(self,nodeType,direction="next",pos=None):
if nodeType=="chart":
return ChartExcelCollectionQuicknavIterator( nodeType , self.rootNVDAObject.excelWorksheetObject , direction , None ).iterate()
elif nodeType=="comment":
return CommentExcelCollectionQuicknavIterator( nodeType , self.rootNVDAObject.excelWorksheetObject , direction , None ).iterate()
elif nodeType=="formula":
return FormulaExcelCollectionQuicknavIterator( nodeType , self.rootNVDAObject.excelWorksheetObject , direction , None ).iterate()
elif nodeType=="sheet":
return SheetsExcelCollectionQuicknavIterator( nodeType , self.rootNVDAObject.excelWorksheetObject , direction , None ).iterate()
elif nodeType=="formField":
return ExcelFormControlQuicknavIterator( nodeType , self.rootNVDAObject.excelWorksheetObject , direction , None,self ).iterate(pos)
else:
raise NotImplementedError
def script_elementsList(self,gesture):
super(ExcelBrowseModeTreeInterceptor,self).script_elementsList(gesture)
# Translators: the description for the elements list command in Microsoft Excel.
script_elementsList.__doc__ = _("Lists various types of elements in this spreadsheet")
script_elementsList.ignoreTreeInterceptorPassThrough=True
__gestures = {
"kb:upArrow": "moveUp",
"kb:downArrow":"moveDown",
"kb:leftArrow":"moveLeft",
"kb:rightArrow":"moveRight",
"kb:control+upArrow":"startOfColumn",
"kb:control+downArrow":"endOfColumn",
"kb:control+leftArrow":"startOfRow",
"kb:control+rightArrow":"endOfRow",
}
class ElementsListDialog(browseMode.ElementsListDialog):
ELEMENT_TYPES=(
# Translators: The label of a radio button to select the type of element
# in the browse mode Elements List dialog.
("chart", _("&Charts")),
# Translators: The label of a radio button to select the type of element
# in the browse mode Elements List dialog.
("comment", _("C&omments")),
# Translators: The label of a radio button to select the type of element
# in the browse mode Elements List dialog.
("formula", _("Fo&rmulas")),
# Translators: The label of a radio button to select the type of element
# in the browse mode Elements List dialog.
("formField", _("&Form fields")),
# Translators: The label of a radio button to select the type of element
# in the browse mode Elements List dialog.
("sheet", _("&Sheets")),
)
class ExcelBase(Window):
"""A base that all Excel NVDAObjects inherit from, which contains some useful methods."""
@staticmethod
def excelWindowObjectFromWindow(windowHandle):
try:
pDispatch=oleacc.AccessibleObjectFromWindow(windowHandle,winUser.OBJID_NATIVEOM,interface=comtypes.automation.IDispatch)
except (COMError,WindowsError):
return None
return comtypes.client.dynamic.Dispatch(pDispatch)
@staticmethod
def getCellAddress(cell, external=False,format=xlA1):
text=cell.Address(False, False, format, external)
textList=text.split(':')
if len(textList)==2:
# Translators: Used to express an address range in excel.
text=_("{start} through {end}").format(start=textList[0], end=textList[1])
return text
def _getDropdown(self):
w=winUser.getAncestor(self.windowHandle,winUser.GA_ROOT)
if not w:
log.debugWarning("Could not get ancestor window (GA_ROOT)")
return
obj=Window(windowHandle=w,chooseBestAPI=False)
if not obj:
log.debugWarning("Could not instnaciate NVDAObject for ancestor window")
return
threadID=obj.windowThreadID
while not eventHandler.isPendingEvents("gainFocus"):
obj=obj.previous
if not obj or not isinstance(obj,Window) or obj.windowThreadID!=threadID:
log.debugWarning("Could not locate dropdown list in previous objects")
return
if obj.windowClassName=='EXCEL:':
break
return obj
def _getSelection(self):
selection=self.excelWindowObject.Selection
try:
isMerged=selection.mergeCells
except (COMError,NameError):
isMerged=False
try:
numCells=selection.count
except (COMError,NameError):
numCells=0
isChartActive = True if self.excelWindowObject.ActiveChart else False
obj=None
if isMerged:
obj=ExcelMergedCell(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelCellObject=selection.item(1))
elif numCells>1:
obj=ExcelSelection(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelRangeObject=selection)
elif numCells==1:
obj=ExcelCell(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelCellObject=selection)
elif isChartActive:
selection = self.excelWindowObject.ActiveChart
import excelChart
obj=excelChart.ExcelChart(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelChartObject=selection)
return obj
class Excel7Window(ExcelBase):
"""An overlay class for Window for the EXCEL7 window class, which simply bounces focus to the active excel cell."""
def _get_excelWindowObject(self):
return self.excelWindowObjectFromWindow(self.windowHandle)
def event_gainFocus(self):
selection=self._getSelection()
dropdown=self._getDropdown()
if dropdown:
if selection:
dropdown.parent=selection
eventHandler.executeEvent('gainFocus',dropdown)
return
if selection:
eventHandler.executeEvent('gainFocus',selection)
class ExcelWorksheet(ExcelBase):
treeInterceptorClass=ExcelBrowseModeTreeInterceptor
role=controlTypes.ROLE_TABLE
def _get_excelApplicationObject(self):
self.excelApplicationObject=self.excelWorksheetObject.application
return self.excelApplicationObject
re_definedName=re.compile(ur'^((?P<sheet>\w+)!)?(?P<name>\w+)(\.(?P<minAddress>[a-zA-Z]+[0-9]+)?(\.(?P<maxAddress>[a-zA-Z]+[0-9]+)?(\..*)*)?)?$')
def populateHeaderCellTrackerFromNames(self,headerCellTracker):
sheetName=self.excelWorksheetObject.name
for x in self.excelWorksheetObject.parent.names:
fullName=x.name
nameMatch=self.re_definedName.match(fullName)
if not nameMatch:
continue
sheet=nameMatch.group('sheet')
if sheet and sheet!=sheetName:
continue
name=nameMatch.group('name').lower()
isColumnHeader=isRowHeader=False
if name.startswith('title'):
isColumnHeader=isRowHeader=True
elif name.startswith('columntitle'):
isColumnHeader=True
elif name.startswith('rowtitle'):
isRowHeader=True
else:
continue
try:
headerCell=x.refersToRange
except COMError:
continue
if headerCell.parent.name!=sheetName:
continue
minColumnNumber=maxColumnNumber=minRowNumber=maxRowNumber=None
minAddress=nameMatch.group('minAddress')
if minAddress:
try:
minCell=self.excelWorksheetObject.range(minAddress)
except COMError:
minCell=None
if minCell:
minRowNumber=minCell.row
minColumnNumber=minCell.column
maxAddress=nameMatch.group('maxAddress')
if maxAddress:
try:
maxCell=self.excelWorksheetObject.range(maxAddress)
except COMError:
maxCell=None
if maxCell:
maxRowNumber=maxCell.row
maxColumnNumber=maxCell.column
if maxColumnNumber is None:
maxColumnNumber=self._getMaxColumnNumberForHeaderCell(headerCell)
headerCellTracker.addHeaderCellInfo(rowNumber=headerCell.row,columnNumber=headerCell.column,rowSpan=headerCell.rows.count,colSpan=headerCell.columns.count,minRowNumber=minRowNumber,maxRowNumber=maxRowNumber,minColumnNumber=minColumnNumber,maxColumnNumber=maxColumnNumber,name=fullName,isColumnHeader=isColumnHeader,isRowHeader=isRowHeader)
def _get_headerCellTracker(self):
self.headerCellTracker=HeaderCellTracker()
self.populateHeaderCellTrackerFromNames(self.headerCellTracker)
return self.headerCellTracker
def setAsHeaderCell(self,cell,isColumnHeader=False,isRowHeader=False):
oldInfo=self.headerCellTracker.getHeaderCellInfoAt(cell.rowNumber,cell.columnNumber)
if oldInfo:
if isColumnHeader and not oldInfo.isColumnHeader:
oldInfo.isColumnHeader=True
oldInfo.rowSpan=cell.rowSpan
elif isRowHeader and not oldInfo.isRowHeader:
oldInfo.isRowHeader=True
oldInfo.colSpan=cell.colSpan
else:
return False
isColumnHeader=oldInfo.isColumnHeader
isRowHeader=oldInfo.isRowHeader
if isColumnHeader and isRowHeader:
name="Title_"
elif isRowHeader:
name="RowTitle_"
elif isColumnHeader:
name="ColumnTitle_"
else:
raise ValueError("One or both of isColumnHeader or isRowHeader must be True")
name+=uuid.uuid4().hex
if oldInfo:
self.excelWorksheetObject.parent.names(oldInfo.name).delete()
oldInfo.name=name
else:
maxColumnNumber=self._getMaxColumnNumberForHeaderCell(cell.excelCellObject)
self.headerCellTracker.addHeaderCellInfo(rowNumber=cell.rowNumber,columnNumber=cell.columnNumber,rowSpan=cell.rowSpan,colSpan=cell.colSpan,maxColumnNumber=maxColumnNumber,name=name,isColumnHeader=isColumnHeader,isRowHeader=isRowHeader)
self.excelWorksheetObject.parent.names.add(name,cell.excelRangeObject)
return True
def _getMaxColumnNumberForHeaderCell(self,excelCell):
try:
r=excelCell.currentRegion
except COMError:
return excelCell.column
columns=r.columns
return columns[columns.count].column+1
def forgetHeaderCell(self,cell,isColumnHeader=False,isRowHeader=False):
if not isColumnHeader and not isRowHeader:
return False
info=self.headerCellTracker.getHeaderCellInfoAt(cell.rowNumber,cell.columnNumber)
if not info:
return False
if isColumnHeader and info.isColumnHeader:
info.isColumnHeader=False
elif isRowHeader and info.isRowHeader:
info.isRowHeader=False
else:
return False
self.headerCellTracker.removeHeaderCellInfo(info)
self.excelWorksheetObject.parent.names(info.name).delete()
if info.isColumnHeader or info.isRowHeader:
self.setAsHeaderCell(cell,isColumnHeader=info.isColumnHeader,isRowHeader=info.isRowHeader)
return True
def fetchAssociatedHeaderCellText(self,cell,columnHeader=False):
# #4409: cell.currentRegion fails if the worksheet is protected.
try:
cellRegion=cell.excelCellObject.currentRegion
except COMError:
log.debugWarning("Possibly protected sheet")
return None
for info in self.headerCellTracker.iterPossibleHeaderCellInfosFor(cell.rowNumber,cell.columnNumber,columnHeader=columnHeader):
textList=[]
if columnHeader:
for headerRowNumber in xrange(info.rowNumber,info.rowNumber+info.rowSpan):
headerCell=self.excelWorksheetObject.cells(headerRowNumber,cell.columnNumber)
# The header could be merged cells.
# if so, fetch text from the first in the merge as that always contains the content
try:
headerCell=headerCell.mergeArea.item(1)
except (COMError,NameError,AttributeError):
pass
textList.append(headerCell.text)
else:
for headerColumnNumber in xrange(info.columnNumber,info.columnNumber+info.colSpan):
headerCell=self.excelWorksheetObject.cells(cell.rowNumber,headerColumnNumber)
# The header could be merged cells.
# if so, fetch text from the first in the merge as that always contains the content
try:
headerCell=headerCell.mergeArea.item(1)
except (COMError,NameError,AttributeError):
pass
textList.append(headerCell.text)
text=" ".join(textList)
if text:
return text
def __init__(self,windowHandle=None,excelWindowObject=None,excelWorksheetObject=None):
self.excelWindowObject=excelWindowObject
self.excelWorksheetObject=excelWorksheetObject
super(ExcelWorksheet,self).__init__(windowHandle=windowHandle)
for gesture in self.__changeSelectionGestures:
self.bindGesture(gesture, "changeSelection")
def _get_name(self):
return self.excelWorksheetObject.name
def _isEqual(self, other):
if not super(ExcelWorksheet, self)._isEqual(other):
return False
return self.excelWorksheetObject.index == other.excelWorksheetObject.index
def _get_firstChild(self):
cell=self.excelWorksheetObject.cells(1,1)
return ExcelCell(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelCellObject=cell)
def _get_states(self):
states=super(ExcelWorksheet,self).states
if self.excelWorksheetObject.ProtectContents:
states.add(controlTypes.STATE_PROTECTED)
return states
def script_changeSelection(self,gesture):
oldSelection=api.getFocusObject()
gesture.send()
import eventHandler
import time
newSelection=None
curTime=startTime=time.time()
while (curTime-startTime)<=0.15:
if scriptHandler.isScriptWaiting():
# Prevent lag if keys are pressed rapidly
return
if eventHandler.isPendingEvents('gainFocus'):
return
newSelection=self._getSelection()
if newSelection and newSelection!=oldSelection:
break
api.processPendingEvents(processEventQueue=False)
time.sleep(0.015)
curTime=time.time()
if newSelection:
if oldSelection.parent==newSelection.parent:
newSelection.parent=oldSelection.parent
eventHandler.executeEvent('gainFocus',newSelection)
script_changeSelection.canPropagate=True
__changeSelectionGestures = (
"kb:tab",
"kb:shift+tab",
"kb:upArrow",
"kb:downArrow",
"kb:leftArrow",
"kb:rightArrow",
"kb:control+upArrow",
"kb:control+downArrow",
"kb:control+leftArrow",
"kb:control+rightArrow",
"kb:home",
"kb:end",
"kb:control+home",
"kb:control+end",
"kb:shift+upArrow",
"kb:shift+downArrow",
"kb:shift+leftArrow",
"kb:shift+rightArrow",
"kb:shift+control+upArrow",
"kb:shift+control+downArrow",
"kb:shift+control+leftArrow",
"kb:shift+control+rightArrow",
"kb:shift+home",
"kb:shift+end",
"kb:shift+control+home",
"kb:shift+control+end",
"kb:shift+space",
"kb:control+space",
"kb:pageUp",
"kb:pageDown",
"kb:shift+pageUp",
"kb:shift+pageDown",
"kb:alt+pageUp",
"kb:alt+pageDown",
"kb:alt+shift+pageUp",
"kb:alt+shift+pageDown",
"kb:control+shift+8",
"kb:control+pageUp",
"kb:control+pageDown",
"kb:control+a",
"kb:control+v",
"kb:shift+f11",
)
class ExcelCellTextInfo(NVDAObjectTextInfo):
def _getFormatFieldAndOffsets(self,offset,formatConfig,calculateOffsets=True):
formatField=textInfos.FormatField()
if (self.obj.excelCellObject.Application.Version > "12.0"):
cellObj=self.obj.excelCellObject.DisplayFormat
else:
cellObj=self.obj.excelCellObject
fontObj=cellObj.font
if formatConfig['reportAlignment']:
value=alignmentLabels.get(self.obj.excelCellObject.horizontalAlignment)
if value:
formatField['text-align']=value
value=alignmentLabels.get(self.obj.excelCellObject.verticalAlignment)
if value:
formatField['vertical-align']=value
if formatConfig['reportFontName']:
formatField['font-name']=fontObj.name
if formatConfig['reportFontSize']:
formatField['font-size']=str(fontObj.size)
if formatConfig['reportFontAttributes']:
formatField['bold']=fontObj.bold
formatField['italic']=fontObj.italic
underline=fontObj.underline
formatField['underline']=False if underline is None or underline==xlUnderlineStyleNone else True
if formatConfig['reportStyle']:
try:
styleName=self.obj.excelCellObject.style.nameLocal
except COMError:
styleName=None
if styleName:
formatField['style']=styleName
if formatConfig['reportColor']:
try:
formatField['color']=colors.RGB.fromCOLORREF(int(fontObj.color))
except COMError:
pass
try:
pattern = cellObj.Interior.Pattern
formatField['background-pattern'] = backgroundPatternLabels.get(pattern)
if pattern in (xlPatternLinearGradient, xlPatternRectangularGradient):
formatField['background-color']=(colors.RGB.fromCOLORREF(int(cellObj.Interior.Gradient.ColorStops(1).Color)))
formatField['background-color2']=(colors.RGB.fromCOLORREF(int(cellObj.Interior.Gradient.ColorStops(2).Color)))
else:
formatField['background-color']=colors.RGB.fromCOLORREF(int(cellObj.interior.color))
except COMError:
pass
return formatField,(self._startOffset,self._endOffset)
class ExcelCell(ExcelBase):
def doAction(self):
pass
def _get_columnHeaderText(self):
return self.parent.fetchAssociatedHeaderCellText(self,columnHeader=True)
def _get_rowHeaderText(self):
return self.parent.fetchAssociatedHeaderCellText(self,columnHeader=False)
def script_openDropdown(self,gesture):
gesture.send()
d=None
curTime=startTime=time.time()
while (curTime-startTime)<=0.25:
if scriptHandler.isScriptWaiting():
# Prevent lag if keys are pressed rapidly
return
if eventHandler.isPendingEvents('gainFocus'):
return
d=self._getDropdown()
if d:
break
api.processPendingEvents(processEventQueue=False)
time.sleep(0.025)
curTime=time.time()
if not d:
log.debugWarning("Failed to get dropDown, giving up")
return
d.parent=self
eventHandler.queueEvent("gainFocus",d)
def script_setColumnHeader(self,gesture):
scriptCount=scriptHandler.getLastScriptRepeatCount()
if not config.conf['documentFormatting']['reportTableHeaders']:
# Translators: a message reported in the SetColumnHeader script for Excel.
ui.message(_("Cannot set headers. Please enable reporting of table headers in Document Formatting Settings"))
return
if scriptCount==0:
if self.parent.setAsHeaderCell(self,isColumnHeader=True,isRowHeader=False):
# Translators: a message reported in the SetColumnHeader script for Excel.
ui.message(_("Set {address} as start of column headers").format(address=self.cellCoordsText))
else:
# Translators: a message reported in the SetColumnHeader script for Excel.
ui.message(_("Already set {address} as start of column headers").format(address=self.cellCoordsText))
elif scriptCount==1:
if self.parent.forgetHeaderCell(self,isColumnHeader=True,isRowHeader=False):
# Translators: a message reported in the SetColumnHeader script for Excel.
ui.message(_("Removed {address} from column headers").format(address=self.cellCoordsText))
else:
# Translators: a message reported in the SetColumnHeader script for Excel.
ui.message(_("Cannot find {address} in column headers").format(address=self.cellCoordsText))
script_setColumnHeader.__doc__=_("Pressing once will set this cell as the first column header for any cells lower and to the right of it within this region. Pressing twice will forget the current column header for this cell.")
def script_setRowHeader(self,gesture):
scriptCount=scriptHandler.getLastScriptRepeatCount()
if not config.conf['documentFormatting']['reportTableHeaders']:
# Translators: a message reported in the SetRowHeader script for Excel.
ui.message(_("Cannot set headers. Please enable reporting of table headers in Document Formatting Settings"))
return
if scriptCount==0:
if self.parent.setAsHeaderCell(self,isColumnHeader=False,isRowHeader=True):
# Translators: a message reported in the SetRowHeader script for Excel.
ui.message(_("Set {address} as start of row headers").format(address=self.cellCoordsText))
else:
# Translators: a message reported in the SetRowHeader script for Excel.
ui.message(_("Already set {address} as start of row headers").format(address=self.cellCoordsText))
elif scriptCount==1:
if self.parent.forgetHeaderCell(self,isColumnHeader=False,isRowHeader=True):
# Translators: a message reported in the SetRowHeader script for Excel.
ui.message(_("Removed {address} from row headers").format(address=self.cellCoordsText))
else:
# Translators: a message reported in the SetRowHeader script for Excel.
ui.message(_("Cannot find {address} in row headers").format(address=self.cellCoordsText))
script_setRowHeader.__doc__=_("Pressing once will set this cell as the first row header for any cells lower and to the right of it within this region. Pressing twice will forget the current row header for this cell.")
@classmethod
def kwargsFromSuper(cls,kwargs,relation=None):
windowHandle=kwargs['windowHandle']
excelWindowObject=cls.excelWindowObjectFromWindow(windowHandle)
if not excelWindowObject:
return False
if isinstance(relation,tuple):
excelCellObject=excelWindowObject.rangeFromPoint(relation[0],relation[1])
else:
excelCellObject=excelWindowObject.ActiveCell
if not excelCellObject:
return False
kwargs['excelWindowObject']=excelWindowObject
kwargs['excelCellObject']=excelCellObject
return True
def __init__(self,windowHandle=None,excelWindowObject=None,excelCellObject=None):
self.excelWindowObject=excelWindowObject
self.excelCellObject=excelCellObject
super(ExcelCell,self).__init__(windowHandle=windowHandle)
def _get_excelRangeObject(self):
return self.excelCellObject
def _get_role(self):
try:
linkCount=self.excelCellObject.hyperlinks.count
except (COMError,NameError,AttributeError):
linkCount=None
if linkCount:
return controlTypes.ROLE_LINK
return controlTypes.ROLE_TABLECELL
TextInfo=ExcelCellTextInfo
def _isEqual(self,other):
if not super(ExcelCell,self)._isEqual(other):
return False
thisAddr=self.getCellAddress(self.excelCellObject,True)
try:
otherAddr=self.getCellAddress(other.excelCellObject,True)
except COMError:
#When cutting and pasting the old selection can become broken
return False
return thisAddr==otherAddr
def _get_cellCoordsText(self):
return self.getCellAddress(self.excelCellObject)
def _get__rowAndColumnNumber(self):
rc=self.excelCellObject.address(True,True,xlRC,False)
return [int(x) if x else 1 for x in re_absRC.match(rc).groups()]
def _get_rowNumber(self):
return self._rowAndColumnNumber[0]
rowSpan=1
def _get_columnNumber(self):
return self._rowAndColumnNumber[1]
colSpan=1
def _get_tableID(self):
address=self.excelCellObject.address(1,1,0,1)
ID="".join(address.split('!')[:-1])
ID="%s %s"%(ID,self.windowHandle)
return ID
def _get_name(self):
return self.excelCellObject.Text
def _getCurSummaryRowState(self):
try:
row=self.excelCellObject.rows[1]
if row.summary:
return controlTypes.STATE_EXPANDED if row.showDetail else controlTypes.STATE_COLLAPSED
except COMError:
pass
def _getCurSummaryColumnState(self):
try:
col=self.excelCellObject.columns[1]
if col.summary:
return controlTypes.STATE_EXPANDED if col.showDetail else controlTypes.STATE_COLLAPSED
except COMError:
pass
def _get_states(self):
states=super(ExcelCell,self).states
summaryCellState=self._getCurSummaryRowState() or self._getCurSummaryColumnState()
if summaryCellState:
states.add(summaryCellState)
if self.excelCellObject.HasFormula:
states.add(controlTypes.STATE_HASFORMULA)
try:
validationType=self.excelCellObject.validation.type
except (COMError,NameError,AttributeError):
validationType=None
if validationType==3:
states.add(controlTypes.STATE_HASPOPUP)
try:
comment=self.excelCellObject.comment
except (COMError,NameError,AttributeError):
comment=None
if comment:
states.add(controlTypes.STATE_HASCOMMENT)
if self._overlapInfo is not None:
if self._overlapInfo['obscuredFromRightBy'] > 0:
states.add(controlTypes.STATE_CROPPED)
if self._overlapInfo['obscuringRightBy'] > 0:
states.add(controlTypes.STATE_OVERFLOWING)
if self.excelWindowObject.ActiveSheet.ProtectContents and (not self.excelCellObject.Locked):
states.add(controlTypes.STATE_UNLOCKED)
return states
def getCellWidthAndTextWidth(self):
#handle to Device Context
hDC = ctypes.windll.user32.GetDC(self.windowHandle)
tempDC = ctypes.windll.gdi32.CreateCompatibleDC(hDC)
ctypes.windll.user32.ReleaseDC(self.windowHandle, hDC)
#Compatible Bitmap for current Device Context
hBMP = ctypes.windll.gdi32.CreateCompatibleBitmap(tempDC, 1, 1)
#handle to the bitmap object
hOldBMP = ctypes.windll.gdi32.SelectObject(tempDC, hBMP)
#Pass Device Context and LOGPIXELSX, the horizontal resolution in pixels per unit inch
deviceCaps = ctypes.windll.gdi32.GetDeviceCaps(tempDC, 88)
#Fetching Font Size and Weight information
iFontSize = self.excelCellObject.Font.Size
iFontSize = 11 if iFontSize is None else int(iFontSize)
iFontSize = ctypes.c_int(iFontSize)
iFontSize = ctypes.windll.kernel32.MulDiv(iFontSize, deviceCaps, 72)
#Font Weight for Bold FOnt is 700 and for normal font it's 400
iFontWeight = 700 if self.excelCellObject.Font.Bold else 400
#Fetching Font Name and style information
sFontName = self.excelCellObject.Font.Name
sFontItalic = self.excelCellObject.Font.Italic
sFontUnderline = True if self.excelCellObject.Font.Underline else False
sFontStrikeThrough = self.excelCellObject.Font.Strikethrough
#If FontSize is <0: The font mapper transforms this value into device units
#and matches its absolute value against the character height of the available fonts.
iFontHeight = iFontSize * -1
#If Font Width is 0, the font mapper chooses a closest match value.
iFontWidth = 0
iEscapement = 0
iOrientation = 0
#Default CharSet based on System Locale is chosen
iCharSet = 0
#Default font mapper behavior
iOutputPrecision = 0
#Default clipping behavior
iClipPrecision = 0
#Default Quality
iOutputQuality = 0
#Default Pitch and default font family
iPitchAndFamily = 0
#Create a font object with the correct size, weight and style
hFont = ctypes.windll.gdi32.CreateFontW(iFontHeight, iFontWidth, iEscapement, iOrientation, iFontWeight, sFontItalic, sFontUnderline, sFontStrikeThrough, iCharSet, iOutputPrecision, iClipPrecision, iOutputQuality, iPitchAndFamily, sFontName)
#Load the font into the device context, storing the original font object
hOldFont = ctypes.windll.gdi32.SelectObject(tempDC, hFont)
sText = self.excelCellObject.Text
textLength = len(sText)
class structText(ctypes.Structure):
_fields_ = [("width", ctypes.c_int), ("height",ctypes.c_int)]
StructText = structText()
getTextExtentPoint = ctypes.windll.gdi32.GetTextExtentPoint32W
getTextExtentPoint.argtypes = [ctypes.c_void_p, ctypes.c_wchar_p, ctypes.c_int, ctypes.POINTER(structText)]
getTextExtentPoint.restype = ctypes.c_int
sText = unicode(sText)
#Get the text dimensions
ctypes.windll.gdi32.GetTextExtentPoint32W(tempDC, sText, textLength,ctypes.byref(StructText))
#Restore the old Font Object
ctypes.windll.gdi32.SelectObject(tempDC, hOldFont)
#Delete the font object we created
ctypes.windll.gdi32.DeleteObject(hFont)
#Restore the old Bitmap Object
ctypes.windll.gdi32.SelectObject(tempDC, hOldBMP)
#Delete the temporary BitMap Object
ctypes.windll.gdi32.DeleteObject(hBMP)
#Release & Delete the device context
ctypes.windll.gdi32.DeleteDC(tempDC)
#Retrieve the text width
textWidth = StructText.width+5
cellWidth = self.excelCellObject.ColumnWidth * xlCellWidthUnitToPixels #Conversion factor to convert the cellwidth to pixels
return (cellWidth,textWidth)
def _get__overlapInfo(self):
(cellWidth, textWidth) = self.getCellWidthAndTextWidth()
isWrapText = self.excelCellObject.WrapText
isShrinkToFit = self.excelCellObject.ShrinkToFit
isMerged = self.excelWindowObject.Selection.MergeCells
try:
adjacentCell = self.excelCellObject.Offset(0,1)
except COMError:
# #5041: This cell is at the right edge.
# For our purposes, treat this as if there is an empty cell to the right.
isAdjacentCellEmpty = True
else:
isAdjacentCellEmpty = not adjacentCell.Text
info = {}
if isMerged:
columnCountInMergeArea = self.excelCellObject.MergeArea.Columns.Count
curCol = self.excelCellObject.Column
curRow = self.excelCellObject.Row
cellWidth = 0
for x in xrange(columnCountInMergeArea):
cellWidth += self.excelCellObject.Cells(curRow, curCol).ColumnWidth
curCol += 1
cellWidth = cellWidth * xlCellWidthUnitToPixels #Conversion factor to convert the cellwidth to pixels
if isWrapText or isShrinkToFit or textWidth <= cellWidth:
info = None
else:
if isAdjacentCellEmpty:
info['obscuringRightBy']= textWidth - cellWidth
info['obscuredFromRightBy'] = 0
else:
info['obscuredFromRightBy']= textWidth - cellWidth
info['obscuringRightBy'] = 0
self._overlapInfo = info
return self._overlapInfo
def _get_parent(self):
worksheet=self.excelCellObject.Worksheet
self.parent=ExcelWorksheet(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelWorksheetObject=worksheet)
return self.parent
def _get_next(self):
try:
next=self.excelCellObject.next
except COMError:
next=None
if next:
return ExcelCell(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelCellObject=next)
def _get_previous(self):
try:
previous=self.excelCellObject.previous
except COMError:
previous=None
if previous:
return ExcelCell(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelCellObject=previous)
def _get_description(self):
try:
inputMessageTitle=self.excelCellObject.validation.inputTitle
except (COMError,NameError,AttributeError):
inputMessageTitle=None
try:
inputMessage=self.excelCellObject.validation.inputMessage
except (COMError,NameError,AttributeError):
inputMessage=None
if inputMessage and inputMessageTitle:
return _("Input Message is {title}: {message}").format( title = inputMessageTitle , message = inputMessage)
elif inputMessage:
return _("Input Message is {message}").format( message = inputMessage)
else:
return None
def _get_positionInfo(self):
try:
level=int(self.excelCellObject.rows[1].outlineLevel)-1
except COMError:
level=None
if level==0:
try:
level=int(self.excelCellObject.columns[1].outlineLevel)-1
except COMError:
level=None
if level==0:
level=None
return {'level':level}
def script_reportComment(self,gesture):
commentObj=self.excelCellObject.comment
text=commentObj.text() if commentObj else None
if text:
ui.message(text)
else:
# Translators: A message in Excel when there is no comment
ui.message(_("Not on a comment"))
# Translators: the description for a script for Excel
script_reportComment.__doc__=_("Reports the comment on the current cell")
def script_editComment(self,gesture):
commentObj=self.excelCellObject.comment
d = wx.TextEntryDialog(gui.mainFrame,
# Translators: Dialog text for
_("Editing comment for cell {address}").format(address=self.cellCoordsText),
# Translators: Title of a dialog edit an Excel comment
_("Comment"),
defaultValue=commentObj.text() if commentObj else u"",
style=wx.TE_MULTILINE|wx.OK|wx.CANCEL)
def callback(result):
if result == wx.ID_OK:
if commentObj:
commentObj.text(d.Value)
else:
self.excelCellObject.addComment(d.Value)
gui.runScriptModalDialog(d, callback)
def reportFocus(self):
# #4878: Excel specific code for speaking format changes on the focused object.
info=self.makeTextInfo(textInfos.POSITION_FIRST)
info.expand(textInfos.UNIT_CHARACTER)
formatField=textInfos.FormatField()
formatConfig=config.conf['documentFormatting']
for field in info.getTextWithFields(formatConfig):
if isinstance(field,textInfos.FieldCommand) and isinstance(field.field,textInfos.FormatField):
formatField.update(field.field)
if not hasattr(self.parent,'_formatFieldSpeechCache'):
self.parent._formatFieldSpeechCache={}
text=speech.getFormatFieldSpeech(formatField,attrsCache=self.parent._formatFieldSpeechCache,formatConfig=formatConfig) if formatField else None
if text:
speech.speakText(text)
super(ExcelCell,self).reportFocus()
__gestures = {
"kb:NVDA+shift+c": "setColumnHeader",
"kb:NVDA+shift+r": "setRowHeader",
"kb:shift+f2":"editComment",
"kb:alt+downArrow":"openDropdown",
"kb:NVDA+alt+c":"reportComment",
}
class ExcelSelection(ExcelBase):
role=controlTypes.ROLE_TABLECELL
def __init__(self,windowHandle=None,excelWindowObject=None,excelRangeObject=None):
self.excelWindowObject=excelWindowObject
self.excelRangeObject=excelRangeObject
super(ExcelSelection,self).__init__(windowHandle=windowHandle)
def _get_states(self):
states=super(ExcelSelection,self).states
states.add(controlTypes.STATE_SELECTED)
return states
def _get_name(self):
firstCell=self.excelRangeObject.Item(1)
lastCell=self.excelRangeObject.Item(self.excelRangeObject.Count)
# Translators: This is presented in Excel to show the current selection, for example 'a1 c3 through a10 c10'
return _("{firstAddress} {firstContent} through {lastAddress} {lastContent}").format(firstAddress=self.getCellAddress(firstCell),firstContent=firstCell.Text,lastAddress=self.getCellAddress(lastCell),lastContent=lastCell.Text)
def _get_parent(self):
worksheet=self.excelRangeObject.Worksheet
return ExcelWorksheet(windowHandle=self.windowHandle,excelWindowObject=self.excelWindowObject,excelWorksheetObject=worksheet)
def _get_rowNumber(self):
return self.excelRangeObject.row
def _get_rowSpan(self):
return self.excelRangeObject.rows.count
def _get_columnNumber(self):
return self.excelRangeObject.column
def _get_colSpan(self):
return self.excelRangeObject.columns.count
#Its useful for an excel selection to be announced with reportSelection script
def makeTextInfo(self,position):
if position==textInfos.POSITION_SELECTION:
position=textInfos.POSITION_ALL
return super(ExcelSelection,self).makeTextInfo(position)
class ExcelDropdownItem(Window):
firstChild=None
lastChild=None
children=[]
role=controlTypes.ROLE_LISTITEM
def __init__(self,parent=None,name=None,states=None,index=None):
self.name=name
self.states=states
self.parent=parent
self.index=index
super(ExcelDropdownItem,self).__init__(windowHandle=parent.windowHandle)
def _get_previous(self):
newIndex=self.index-1
if newIndex>=0:
return self.parent.getChildAtIndex(newIndex)
def _get_next(self):
newIndex=self.index+1
if newIndex<self.parent.childCount:
return self.parent.getChildAtIndex(newIndex)
def _get_treeInterceptor(self):
return self.parent.treeInterceptor
def _get_positionInfo(self):
return {'indexInGroup':self.index+1,'similarItemsInGroup':self.parent.childCount,}
class ExcelDropdown(Window):
@classmethod
def kwargsFromSuper(cls,kwargs,relation=None):
return kwargs
role=controlTypes.ROLE_LIST
excelCell=None
def _get__highlightColors(self):
background=colors.RGB.fromCOLORREF(winUser.user32.GetSysColor(13))
foreground=colors.RGB.fromCOLORREF(winUser.user32.GetSysColor(14))
self._highlightColors=(background,foreground)
return self._highlightColors
def _get_children(self):
children=[]
index=0
states=set()
for item in DisplayModelTextInfo(self,textInfos.POSITION_ALL).getTextWithFields():
if isinstance(item,textInfos.FieldCommand) and item.command=="formatChange":
states=set([controlTypes.STATE_SELECTABLE])
foreground=item.field.get('color',None)
background=item.field.get('background-color',None)
if (background,foreground)==self._highlightColors:
states.add(controlTypes.STATE_SELECTED)
if isinstance(item,basestring):
obj=ExcelDropdownItem(parent=self,name=item,states=states,index=index)
children.append(obj)
index+=1
return children
def getChildAtIndex(self,index):
return self.children[index]
def _get_childCount(self):
return len(self.children)
def _get_firstChild(self):
return self.children[0]
def _get_selection(self):
for child in self.children:
if controlTypes.STATE_SELECTED in child.states:
return child
def script_selectionChange(self,gesture):
gesture.send()
newFocus=self.selection or self
if eventHandler.lastQueuedFocusObject is newFocus: return
eventHandler.queueEvent("gainFocus",newFocus)
script_selectionChange.canPropagate=True
def script_closeDropdown(self,gesture):
gesture.send()
eventHandler.queueEvent("gainFocus",self.parent)
script_closeDropdown.canPropagate=True
__gestures={
"kb:downArrow":"selectionChange",
"kb:upArrow":"selectionChange",
"kb:leftArrow":"selectionChange",
"kb:rightArrow":"selectionChange",
"kb:home":"selectionChange",
"kb:end":"selectionChange",
"kb:escape":"closeDropdown",
"kb:enter":"closeDropdown",
"kb:space":"closeDropdown",
}
def event_gainFocus(self):
child=self.selection
if not child and self.childCount>0:
child=self.children[0]
if child:
eventHandler.queueEvent("focusEntered",self)
eventHandler.queueEvent("gainFocus",child)
else:
super(ExcelDropdown,self).event_gainFocus()
class ExcelMergedCell(ExcelCell):
def _get_cellCoordsText(self):
return self.getCellAddress(self.excelCellObject.mergeArea)
def _get_rowSpan(self):
return self.excelCellObject.mergeArea.rows.count
def _get_colSpan(self):
return self.excelCellObject.mergeArea.columns.count
class ExcelFormControl(ExcelBase):
isFocusable=True
_roleMap = {
xlButtonControl: controlTypes.ROLE_BUTTON,
xlCheckBox: controlTypes.ROLE_CHECKBOX,
xlDropDown: controlTypes.ROLE_COMBOBOX,
xlEditBox: controlTypes.ROLE_EDITABLETEXT,
xlGroupBox: controlTypes.ROLE_BOX,
xlLabel: controlTypes.ROLE_LABEL,
xlListBox: controlTypes.ROLE_LIST,
xlOptionButton: controlTypes.ROLE_RADIOBUTTON,
xlScrollBar: controlTypes.ROLE_SCROLLBAR,
xlSpinner: controlTypes.ROLE_SPINBUTTON,
}
def _get_excelControlFormatObject(self):
return self.excelFormControlObject.controlFormat
def _get_excelOLEFormatObject(self):
return self.excelFormControlObject.OLEFormat.object
def __init__(self,windowHandle=None,parent=None,excelFormControlObject=None):
self.parent=parent
self.excelFormControlObject=excelFormControlObject
super(ExcelFormControl,self).__init__(windowHandle=windowHandle)
def _get_role(self):
try:
if self.excelFormControlObject.Type==msoFormControl:
formControlType=self.excelFormControlObject.FormControlType
else:
formControlType=None
except:
return None
return self._roleMap[formControlType]
def _get_states(self):
states=super(ExcelFormControl,self).states
if self is api.getFocusObject():
states.add(controlTypes.STATE_FOCUSED)
newState=None
if self.role==controlTypes.ROLE_RADIOBUTTON:
newState=controlTypes.STATE_CHECKED if self.excelOLEFormatObject.Value==checked else None
elif self.role==controlTypes.ROLE_CHECKBOX:
if self.excelOLEFormatObject.Value==checked:
newState=controlTypes.STATE_CHECKED
elif self.excelOLEFormatObject.Value==mixed:
newState=controlTypes.STATE_HALFCHECKED
if newState:
states.add(newState)
return states
def _get_name(self):
if self.excelFormControlObject.AlternativeText:
return self.excelFormControlObject.AlternativeText+" "+self.excelFormControlObject.TopLeftCell.address(False,False,1,False) + "-" + self.excelFormControlObject.BottomRightCell.address(False,False,1,False)
else:
return self.excelFormControlObject.Name+" "+self.excelFormControlObject.TopLeftCell.address(False,False,1,False) + "-" + self.excelFormControlObject.BottomRightCell.address(False,False,1,False)
def _get_index(self):
return self.excelFormControlObject.ZOrderPosition
def _get_topLeftCell(self):
return self.excelFormControlObject.TopLeftCell
def _get_bottomRightCell(self):
return self.excelFormControlObject.BottomRightCell
def _getFormControlScreenCoordinates(self):
topLeftAddress=self.topLeftCell
bottomRightAddress=self.bottomRightCell
#top left cell's width in points
topLeftCellWidth=topLeftAddress.Width
#top left cell's height in points
topLeftCellHeight=topLeftAddress.Height
#bottom right cell's width in points
bottomRightCellWidth=bottomRightAddress.Width
#bottom right cell's height in points
bottomRightCellHeight=bottomRightAddress.Height
self.excelApplicationObject=self.parent.excelWorksheetObject.Application
hDC = ctypes.windll.user32.GetDC(None)
#pixels per inch along screen width
px = ctypes.windll.gdi32.GetDeviceCaps(hDC, LOGPIXELSX)
#pixels per inch along screen height
py = ctypes.windll.gdi32.GetDeviceCaps(hDC, LOGPIXELSY)
ctypes.windll.user32.ReleaseDC(None, hDC)
zoom=self.excelApplicationObject.ActiveWindow.Zoom
zoomRatio=zoom/100
#Conversion from inches to Points, 1 inch=72points
pointsPerInch = self.excelApplicationObject.InchesToPoints(1)
#number of pixels from the left edge of the spreadsheet's window to the left edge the first column in the spreadsheet.
X=self.excelApplicationObject.ActiveWindow.PointsToScreenPixelsX(0)
#number of pixels from the top edge of the spreadsheet's window to the top edge the first row in the spreadsheet,
Y=self.excelApplicationObject.ActiveWindow.PointsToScreenPixelsY(0)
if topLeftAddress==bottomRightAddress:
#Range.Left: The distance, in points, from the left edge of column A to the left edge of the range.
X=int(X + (topLeftAddress.Left+topLeftCellWidth/2) * zoomRatio * px / pointsPerInch)
#Range.Top: The distance, in points, from the top edge of Row 1 to the top edge of the range.
Y=int(Y + (topLeftAddress.Top+topLeftCellHeight/2) * zoomRatio * py / pointsPerInch)
return (X,Y)
else:
screenTopLeftX=int(X + (topLeftCellWidth/2 + topLeftAddress.Left) * zoomRatio * px / pointsPerInch)
screenBottomRightX=int(X + (bottomRightCellWidth/2+bottomRightAddress.Left) * zoomRatio * px / pointsPerInch)
screenTopLeftY = int(Y + (topLeftCellHeight/2+ topLeftAddress.Top) * zoomRatio * py / pointsPerInch)
screenBottomRightY=int(Y + (bottomRightCellHeight/2+ bottomRightAddress.Top) * zoomRatio * py / pointsPerInch)
return (int(0.5*(screenTopLeftX+screenBottomRightX)), int(0.5*(screenTopLeftY+screenBottomRightY)))
def script_doAction(self,gesture):
self.doAction()
script_doAction.canPropagate=True
def doAction(self):
(x,y)=self._getFormControlScreenCoordinates()
winUser.setCursorPos(x,y)
#perform Mouse Left-Click
winUser.mouse_event(winUser.MOUSEEVENTF_LEFTDOWN,0,0,None,None)
winUser.mouse_event(winUser.MOUSEEVENTF_LEFTUP,0,0,None,None)
self.invalidateCache()
wx.CallLater(100,eventHandler.executeEvent,"stateChange",self)
__gestures= {
"kb:enter":"doAction",
"kb:space":"doAction",
"kb(desktop):numpadEnter":"doAction",
}
class ExcelFormControlQuickNavItem(ExcelQuickNavItem):
def __init__( self , nodeType , document , formControlObject , formControlCollection, treeInterceptorObj ):
super( ExcelFormControlQuickNavItem ,self).__init__( nodeType , document , formControlObject , formControlCollection )
self.formControlObjectIndex = formControlObject.ZOrderPosition
self.treeInterceptorObj=treeInterceptorObj
_label=None
@property
def label(self):
if self._label: return self._label
alternativeText=self.excelItemObject.AlternativeText
if alternativeText:
self._label=alternativeText+" "+self.excelItemObject.Name+" " + self.excelItemObject.TopLeftCell.address(False,False,1,False) + "-" + self.excelItemObject.BottomRightCell.address(False,False,1,False)
else:
self._label=self.excelItemObject.Name + " " + self.excelItemObject.TopLeftCell.address(False,False,1,False) + "-" + self.excelItemObject.BottomRightCell.address(False,False,1,False)
return self._label
_nvdaObj=None
@property
def nvdaObj(self):
if self._nvdaObj: return self._nvdaObj
formControlType=self.excelItemObject.formControlType
if formControlType ==xlListBox:
self._nvdaObj=ExcelFormControlListBox(windowHandle=self.treeInterceptorObj.rootNVDAObject.windowHandle,parent=self.treeInterceptorObj.rootNVDAObject,excelFormControlObject=self.excelItemObject)
elif formControlType ==xlDropDown:
self._nvdaObj=ExcelFormControlDropDown(windowHandle=self.treeInterceptorObj.rootNVDAObject.windowHandle,parent=self.treeInterceptorObj.rootNVDAObject,excelFormControlObject=self.excelItemObject)
elif formControlType in (xlScrollBar,xlSpinner):
self._nvdaObj=ExcelFormControlScrollBar(windowHandle=self.treeInterceptorObj.rootNVDAObject.windowHandle,parent=self.treeInterceptorObj.rootNVDAObject,excelFormControlObject=self.excelItemObject)
else:
self._nvdaObj=ExcelFormControl(windowHandle=self.treeInterceptorObj.rootNVDAObject.windowHandle,parent=self.treeInterceptorObj.rootNVDAObject,excelFormControlObject=self.excelItemObject)
self._nvdaObj.treeInterceptor=self.treeInterceptorObj
return self._nvdaObj
def __lt__(self,other):
return self.formControlObjectIndex < other.formControlObjectIndex
def moveTo(self):
self.excelItemObject.TopLeftCell.Select
self.excelItemObject.TopLeftCell.Activate()
if self.treeInterceptorObj.passThrough:
self.treeInterceptorObj.passThrough=False
browseMode.reportPassThrough(self.treeInterceptorObj)
eventHandler.queueEvent("gainFocus",self.nvdaObj)
@property
def isAfterSelection(self):
activeCell = self.document.Application.ActiveCell
if self.excelItemObject.TopLeftCell.row == activeCell.row:
if self.excelItemObject.TopLeftCell.column > activeCell.column:
return False
elif self.excelItemObject.TopLeftCell.row > activeCell.row:
return False
return True
class ExcelFormControlQuicknavIterator(ExcelQuicknavIterator):
quickNavItemClass=ExcelFormControlQuickNavItem
def __init__(self, itemType , document , direction , includeCurrent,treeInterceptorObj):
super(ExcelFormControlQuicknavIterator,self).__init__(itemType , document , direction , includeCurrent)
self.treeInterceptorObj=treeInterceptorObj
def collectionFromWorksheet( self , worksheetObject ):
try:
return worksheetObject.Shapes
except(COMError):
return None
def iterate(self, position):
"""
returns a generator that emits L{QuickNavItem} objects for this collection.
@param position: an excelRangeObject representing either the TopLeftCell of the currently selected form control
or ActiveCell in a worksheet
"""
# Returns the Row containing TopLeftCell of an item
def topLeftCellRow(item):
row=item.TopLeftCell.Row
# Cache row on the COM object as we need it later
item._comobj.excelRow=row
return row
items=self.collectionFromWorksheet(self.document)
if not items:
return
items=sorted(items,key=topLeftCellRow)
if position:
rangeObj=position.excelRangeObject
row = rangeObj.Row
col = rangeObj.Column
if self.direction=="next":
for collectionItem in items:
itemRow=collectionItem._comobj.excelRow
if (itemRow>row or (itemRow==row and collectionItem.TopLeftCell.Column>col)) and self.filter(collectionItem):
item=self.quickNavItemClass(self.itemType,self.document,collectionItem,items,self.treeInterceptorObj)
yield item
elif self.direction=="previous":
for collectionItem in reversed(items):
itemRow=collectionItem._comobj.excelRow
if (itemRow<row or (itemRow==row and collectionItem.TopLeftCell.Column<col)) and self.filter(collectionItem):
item=self.quickNavItemClass(self.itemType,self.document,collectionItem,items,self.treeInterceptorObj )
yield item
else:
for collectionItem in items:
if self.filter(collectionItem):
item=self.quickNavItemClass(self.itemType,self.document,collectionItem , items,self.treeInterceptorObj )
yield item
def filter(self,shape):
if shape.Type == msoFormControl:
if shape.FormControlType == xlGroupBox or shape.Visible != msoTrue:
return False
else:
return True
else:
return False
class ExcelFormControlListBox(ExcelFormControl):
def __init__(self,windowHandle=None,parent=None,excelFormControlObject=None):
super(ExcelFormControlListBox,self).__init__(windowHandle=windowHandle, parent=parent, excelFormControlObject=excelFormControlObject)
try:
self.listSize=int(self.excelControlFormatObject.ListCount)
except:
self.listSize=0
try:
self.selectedItemIndex= int(self.excelControlFormatObject.ListIndex)
except:
self.selectedItemIndex=0
try:
self.isMultiSelectable= self.excelControlFormatObject.multiSelect!=xlNone
except:
self.isMultiSelectable=False
def getChildAtIndex(self,index):
name=str(self.excelOLEFormatObject.List(index+1))
states=set([controlTypes.STATE_SELECTABLE])
if self.excelOLEFormatObject.Selected[index+1]==True:
states.add(controlTypes.STATE_SELECTED)
return ExcelDropdownItem(parent=self,name=name,states=states,index=index)
def _get_childCount(self):
return self.listSize
def _get_firstChild(self):
if self.listSize>0:
return self.getChildAtIndex(0)
def _get_lastChild(self):
if self.listSize>0:
return self.getChildAtIndex(self.listSize-1)
def script_moveUp(self, gesture):
if self.selectedItemIndex > 1:
self.selectedItemIndex= self.selectedItemIndex - 1
if not self.isMultiSelectable:
try:
self.excelOLEFormatObject.Selected[self.selectedItemIndex] = True
except:
pass
child=self.getChildAtIndex(self.selectedItemIndex-1)
if child:
eventHandler.queueEvent("gainFocus",child)
script_moveUp.canPropagate=True
def script_moveDown(self, gesture):
if self.selectedItemIndex < self.listSize:
self.selectedItemIndex= self.selectedItemIndex + 1
if not self.isMultiSelectable:
try:
self.excelOLEFormatObject.Selected[self.selectedItemIndex] = True
except:
pass
child=self.getChildAtIndex(self.selectedItemIndex-1)
if child:
eventHandler.queueEvent("gainFocus",child)
script_moveDown.canPropagate=True
def doAction(self):
if self.isMultiSelectable:
try:
lb=self.excelOLEFormatObject
lb.Selected[self.selectedItemIndex] =not lb.Selected[self.selectedItemIndex]
except:
return
child=self.getChildAtIndex(self.selectedItemIndex-1)
eventHandler.queueEvent("gainFocus",child)
__gestures= {
"kb:upArrow": "moveUp",
"kb:downArrow":"moveDown",
}
class ExcelFormControlDropDown(ExcelFormControl):
def __init__(self,windowHandle=None,parent=None,excelFormControlObject=None):
super(ExcelFormControlDropDown,self).__init__(windowHandle=windowHandle, parent=parent, excelFormControlObject=excelFormControlObject)
try:
self.listSize=self.excelControlFormatObject.ListCount
except:
self.listSize=0
try:
self.selectedItemIndex=self.excelControlFormatObject.ListIndex
except:
self.selectedItemIndex=0
def script_moveUp(self, gesture):
if self.selectedItemIndex > 1:
self.selectedItemIndex= self.selectedItemIndex - 1
self.excelOLEFormatObject.Selected[self.selectedItemIndex] = True
eventHandler.queueEvent("valueChange",self)
script_moveUp.canPropagate=True
def script_moveDown(self, gesture):
if self.selectedItemIndex < self.listSize:
self.selectedItemIndex= self.selectedItemIndex + 1
self.excelOLEFormatObject.Selected[self.selectedItemIndex] = True
eventHandler.queueEvent("valueChange",self)
script_moveDown.canPropagate=True
def _get_value(self):
if self.selectedItemIndex < self.listSize:
return str(self.excelOLEFormatObject.List(self.selectedItemIndex))
__gestures= {
"kb:upArrow": "moveUp",
"kb:downArrow":"moveDown",
}
class ExcelFormControlScrollBar(ExcelFormControl):
def __init__(self,windowHandle=None,parent=None,excelFormControlObject=None):
super(ExcelFormControlScrollBar,self).__init__(windowHandle=windowHandle, parent=parent, excelFormControlObject=excelFormControlObject)
try:
self.minValue=self.excelControlFormatObject.min
except:
self.minValue=0
try:
self.maxValue=self.excelControlFormatObject.max
except:
self.maxValue=0
try:
self.smallChange=self.excelControlFormatObject.smallChange
except:
self.smallChange=0
try:
self.largeChange=self.excelControlFormatObject.largeChange
except:
self.largeChange=0
def _get_value(self):
try:
return str(self.excelControlFormatObject.value)
except COMError:
return 0
def moveValue(self,up=False,large=False):
try:
curValue=self.excelControlFormatObject.value
except COMError:
return
if up:
newValue=min(curValue+(self.largeChange if large else self.smallChange),self.maxValue)
else:
newValue=max(curValue-(self.largeChange if large else self.smallChange),self.minValue)
self.excelControlFormatObject.value=newValue
eventHandler.queueEvent("valueChange",self)
def script_moveUpSmall(self,gesture):
self.moveValue(True,False)
def script_moveDownSmall(self,gesture):
self.moveValue(False,False)
def script_moveUpLarge(self,gesture):
self.moveValue(True,True)
def script_moveDownLarge(self,gesture):
self.moveValue(False,True)
__gestures={
"kb:upArrow":"moveUpSmall",
"kb:downArrow":"moveDownSmall",
"kb:pageUp":"moveUpLarge",
"kb:pageDown":"moveDownLarge",
}