Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
\sa propertyManagers(), addPropertyManager()
*/
/**
\fn virtual void QtAbstractEditorFactory::connectPropertyManager(PropertyManager *manager) = 0
Connects this factory to the given \a manager's signals. The
PropertyManager type is a template argument class, and represents
the chosen QtAbstractPropertyManager subclass.
This function is used internally by the addPropertyManager() function, and
makes it possible to update an editing widget when the associated
property's data changes. This is typically done in custom slots
responding to the signals emitted by the property's manager,
e.g. QtIntPropertyManager::valueChanged() and
QtIntPropertyManager::rangeChanged().
\sa propertyManagers(), disconnectPropertyManager()
*/
/**
\fn virtual QWidget *QtAbstractEditorFactory::createEditorForManager(PropertyManager *manager, QtProperty *property,
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
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
QWidget *parent) = 0
Creates an editing widget with the given \a parent for the
specified \a property created by the given \a manager. The
PropertyManager type is a template argument class, and represents
the chosen QtAbstractPropertyManager subclass.
This function must be implemented in derived classes: It is
recommended to store a pointer to the widget and map it to the
given \a property, since the widget must be updated whenever the
associated property's data changes. This is typically done in
custom slots responding to the signals emitted by the property's
manager, e.g. QtIntPropertyManager::valueChanged() and
QtIntPropertyManager::rangeChanged().
\sa connectPropertyManager()
*/
/**
\fn virtual void QtAbstractEditorFactory::disconnectPropertyManager(PropertyManager *manager) = 0
Disconnects this factory from the given \a manager's signals. The
PropertyManager type is a template argument class, and represents
the chosen QtAbstractPropertyManager subclass.
This function is used internally by the removePropertyManager() function.
\sa propertyManagers(), connectPropertyManager()
*/
/**
\fn QSet<PropertyManager *> QtAbstractEditorFactory::propertyManagers() const
Returns the factory's set of associated managers. The
PropertyManager type is a template argument class, and represents
the chosen QtAbstractPropertyManager subclass.
\sa addPropertyManager(), removePropertyManager()
*/
/**
\fn PropertyManager *QtAbstractEditorFactory::propertyManager(QtProperty *property) const
Returns the property manager for the given \a property, or 0 if
the given \a property doesn't belong to any of this factory's
registered managers.
The PropertyManager type is a template argument class, and represents the chosen
QtAbstractPropertyManager subclass.
\sa propertyManagers()
*/
/**
\fn virtual void QtAbstractEditorFactory::managerDestroyed(QObject *manager)
\internal
\reimp
*/
////////////////////////////////////
class QtBrowserItemPrivate
{
public:
QtBrowserItemPrivate(QtAbstractPropertyBrowser *browser, QtProperty *property, QtBrowserItem *parent)
: m_browser(browser), m_property(property), m_parent(parent), q_ptr(0) {}
void addChild(QtBrowserItem *index, QtBrowserItem *after);
void removeChild(QtBrowserItem *index);
QtAbstractPropertyBrowser * const m_browser;
QtProperty *m_property;
QtBrowserItem *m_parent;
QtBrowserItem *q_ptr;
QList<QtBrowserItem *> m_children;
};
void QtBrowserItemPrivate::addChild(QtBrowserItem *index, QtBrowserItem *after)
{
if (m_children.contains(index))
return;
int idx = m_children.indexOf(after) + 1; // we insert after returned idx, if it was -1 then we set idx to 0;
m_children.insert(idx, index);
}
void QtBrowserItemPrivate::removeChild(QtBrowserItem *index)
{
m_children.removeAll(index);
}
/**
\class QtBrowserItem
\brief The QtBrowserItem class represents a property in
a property browser instance.
Browser items are created whenever a QtProperty is inserted to the
property browser. A QtBrowserItem uniquely identifies a
browser's item. Thus, if the same QtProperty is inserted multiple
times, each occurrence gets its own unique QtBrowserItem. The
items are owned by QtAbstractPropertyBrowser and automatically
deleted when they are removed from the browser.
You can traverse a browser's properties by calling parent() and
children(). The property and the browser associated with an item
are available as property() and browser().
\sa QtAbstractPropertyBrowser, QtProperty
*/
/**
Returns the property which is accosiated with this item. Note that
several items can be associated with the same property instance in
the same property browser.
\sa QtAbstractPropertyBrowser::items()
*/
QtProperty *QtBrowserItem::property() const
{
return d_ptr->m_property;
}
/**
Returns the parent item of \e this item. Returns 0 if \e this item
is associated with top-level property in item's property browser.
\sa children()
*/
QtBrowserItem *QtBrowserItem::parent() const
{
return d_ptr->m_parent;
}
/**
Returns the children items of \e this item. The properties
reproduced from children items are always the same as
reproduced from associated property' children, for example:
\code
QtBrowserItem *item;
QList<QtBrowserItem *> childrenItems = item->children();
QList<QtProperty *> childrenProperties = item->property()->subProperties();
\endcode
The \e childrenItems list represents the same list as \e childrenProperties.
*/
QList<QtBrowserItem *> QtBrowserItem::children() const
{
return d_ptr->m_children;
}
/**
Returns the property browser which owns \e this item.
*/
QtAbstractPropertyBrowser *QtBrowserItem::browser() const
{
return d_ptr->m_browser;
}
QtBrowserItem::QtBrowserItem(QtAbstractPropertyBrowser *browser, QtProperty *property, QtBrowserItem *parent)
{
d_ptr = new QtBrowserItemPrivate(browser, property, parent);
d_ptr->q_ptr = this;
}
QtBrowserItem::~QtBrowserItem()
{
delete d_ptr;
}
////////////////////////////////////
typedef QMap<QtAbstractPropertyBrowser *, QMap<QtAbstractPropertyManager *,
QtAbstractEditorFactoryBase *> > Map1;
typedef QMap<QtAbstractPropertyManager *, QMap<QtAbstractEditorFactoryBase *,
QList<QtAbstractPropertyBrowser *> > > Map2;
Q_GLOBAL_STATIC(Map1, m_viewToManagerToFactory)
Q_GLOBAL_STATIC(Map2, m_managerToFactoryToViews)
class QtAbstractPropertyBrowserPrivate
{
QtAbstractPropertyBrowser *q_ptr;
Q_DECLARE_PUBLIC(QtAbstractPropertyBrowser)
public:
QtAbstractPropertyBrowserPrivate();
void insertSubTree(QtProperty *property,
QtProperty *parentProperty);
void removeSubTree(QtProperty *property,
QtProperty *parentProperty);
void createBrowserIndexes(QtProperty *property, QtProperty *parentProperty, QtProperty *afterProperty);
void removeBrowserIndexes(QtProperty *property, QtProperty *parentProperty);
QtBrowserItem *createBrowserIndex(QtProperty *property, QtBrowserItem *parentIndex, QtBrowserItem *afterIndex);
void removeBrowserIndex(QtBrowserItem *index);
void clearIndex(QtBrowserItem *index);
void slotPropertyInserted(QtProperty *property,
QtProperty *parentProperty, QtProperty *afterProperty);
void slotPropertyRemoved(QtProperty *property, QtProperty *parentProperty);
void slotPropertyDestroyed(QtProperty *property);
void slotPropertyDataChanged(QtProperty *property);
QList<QtProperty *> m_subItems;
QMap<QtAbstractPropertyManager *, QList<QtProperty *> > m_managerToProperties;
QMap<QtProperty *, QList<QtProperty *> > m_propertyToParents;
QMap<QtProperty *, QtBrowserItem *> m_topLevelPropertyToIndex;
QList<QtBrowserItem *> m_topLevelIndexes;
QMap<QtProperty *, QList<QtBrowserItem *> > m_propertyToIndexes;
QtBrowserItem *m_currentItem;
};
QtAbstractPropertyBrowserPrivate::QtAbstractPropertyBrowserPrivate() :
m_currentItem(0)
{
}
void QtAbstractPropertyBrowserPrivate::insertSubTree(QtProperty *property,
QtProperty *parentProperty)
{
if (m_propertyToParents.contains(property)) {
// property was already inserted, so its manager is connected
// and all its children are inserted and theirs managers are connected
// we just register new parent (parent has to be new).
m_propertyToParents[property].append(parentProperty);
// don't need to update m_managerToProperties map since
// m_managerToProperties[manager] already contains property.
return;
}
QtAbstractPropertyManager *manager = property->propertyManager();
if (m_managerToProperties[manager].isEmpty()) {
// connect manager's signals
q_ptr->connect(manager, SIGNAL(propertyInserted(QtProperty *,
QtProperty *, QtProperty *)),
q_ptr, SLOT(slotPropertyInserted(QtProperty *,
QtProperty *, QtProperty *)));
q_ptr->connect(manager, SIGNAL(propertyRemoved(QtProperty *,
QtProperty *)),
q_ptr, SLOT(slotPropertyRemoved(QtProperty *, QtProperty *)));
q_ptr->connect(manager, SIGNAL(propertyDestroyed(QtProperty *)),
q_ptr, SLOT(slotPropertyDestroyed(QtProperty *)));
q_ptr->connect(manager, SIGNAL(propertyChanged(QtProperty *)),
q_ptr, SLOT(slotPropertyDataChanged(QtProperty *)));
}
m_managerToProperties[manager].append(property);
m_propertyToParents[property].append(parentProperty);
QList<QtProperty *> subList = property->subProperties();
QListIterator<QtProperty *> itSub(subList);
while (itSub.hasNext()) {
QtProperty *subProperty = itSub.next();
insertSubTree(subProperty, property);
}
}
void QtAbstractPropertyBrowserPrivate::removeSubTree(QtProperty *property,
QtProperty *parentProperty)
{
if (!m_propertyToParents.contains(property)) {
// ASSERT
return;
}
m_propertyToParents[property].removeAll(parentProperty);
if (!m_propertyToParents[property].isEmpty())
return;
m_propertyToParents.remove(property);
QtAbstractPropertyManager *manager = property->propertyManager();
m_managerToProperties[manager].removeAll(property);
if (m_managerToProperties[manager].isEmpty()) {
// disconnect manager's signals
q_ptr->disconnect(manager, SIGNAL(propertyInserted(QtProperty *,
QtProperty *, QtProperty *)),
q_ptr, SLOT(slotPropertyInserted(QtProperty *,
QtProperty *, QtProperty *)));
q_ptr->disconnect(manager, SIGNAL(propertyRemoved(QtProperty *,
QtProperty *)),
q_ptr, SLOT(slotPropertyRemoved(QtProperty *, QtProperty *)));
q_ptr->disconnect(manager, SIGNAL(propertyDestroyed(QtProperty *)),
q_ptr, SLOT(slotPropertyDestroyed(QtProperty *)));
q_ptr->disconnect(manager, SIGNAL(propertyChanged(QtProperty *)),
q_ptr, SLOT(slotPropertyDataChanged(QtProperty *)));
m_managerToProperties.remove(manager);
}
QList<QtProperty *> subList = property->subProperties();
QListIterator<QtProperty *> itSub(subList);
while (itSub.hasNext()) {
QtProperty *subProperty = itSub.next();
removeSubTree(subProperty, property);
}
}
void QtAbstractPropertyBrowserPrivate::createBrowserIndexes(QtProperty *property, QtProperty *parentProperty, QtProperty *afterProperty)
{
QMap<QtBrowserItem *, QtBrowserItem *> parentToAfter;
if (afterProperty) {
QMap<QtProperty *, QList<QtBrowserItem *> >::ConstIterator it =
m_propertyToIndexes.find(afterProperty);
if (it == m_propertyToIndexes.constEnd())
return;
QList<QtBrowserItem *> indexes = it.value();
QListIterator<QtBrowserItem *> itIndex(indexes);
while (itIndex.hasNext()) {
QtBrowserItem *idx = itIndex.next();
QtBrowserItem *parentIdx = idx->parent();
if ((parentProperty && parentIdx && parentIdx->property() == parentProperty) || (!parentProperty && !parentIdx))
parentToAfter[idx->parent()] = idx;
}
} else if (parentProperty) {
QMap<QtProperty *, QList<QtBrowserItem *> >::ConstIterator it =
m_propertyToIndexes.find(parentProperty);
if (it == m_propertyToIndexes.constEnd())
return;
QList<QtBrowserItem *> indexes = it.value();
QListIterator<QtBrowserItem *> itIndex(indexes);
while (itIndex.hasNext()) {
QtBrowserItem *idx = itIndex.next();
parentToAfter[idx] = 0;
}
} else {
parentToAfter[0] = 0;
}
const QMap<QtBrowserItem *, QtBrowserItem *>::ConstIterator pcend = parentToAfter.constEnd();
for (QMap<QtBrowserItem *, QtBrowserItem *>::ConstIterator it = parentToAfter.constBegin(); it != pcend; ++it)
createBrowserIndex(property, it.key(), it.value());
}
QtBrowserItem *QtAbstractPropertyBrowserPrivate::createBrowserIndex(QtProperty *property,
QtBrowserItem *parentIndex, QtBrowserItem *afterIndex)
{
QtBrowserItem *newIndex = new QtBrowserItem(q_ptr, property, parentIndex);
if (parentIndex) {
parentIndex->d_ptr->addChild(newIndex, afterIndex);
} else {
m_topLevelPropertyToIndex[property] = newIndex;
m_topLevelIndexes.insert(m_topLevelIndexes.indexOf(afterIndex) + 1, newIndex);
}
m_propertyToIndexes[property].append(newIndex);
q_ptr->itemInserted(newIndex, afterIndex);
QList<QtProperty *> subItems = property->subProperties();
QListIterator<QtProperty *> itChild(subItems);
QtBrowserItem *afterChild = 0;
while (itChild.hasNext()) {
QtProperty *child = itChild.next();
afterChild = createBrowserIndex(child, newIndex, afterChild);
}
return newIndex;
}
void QtAbstractPropertyBrowserPrivate::removeBrowserIndexes(QtProperty *property, QtProperty *parentProperty)
{
QList<QtBrowserItem *> toRemove;
QMap<QtProperty *, QList<QtBrowserItem *> >::ConstIterator it =
m_propertyToIndexes.find(property);
if (it == m_propertyToIndexes.constEnd())
return;
QList<QtBrowserItem *> indexes = it.value();
QListIterator<QtBrowserItem *> itIndex(indexes);
while (itIndex.hasNext()) {
QtBrowserItem *idx = itIndex.next();
QtBrowserItem *parentIdx = idx->parent();
if ((parentProperty && parentIdx && parentIdx->property() == parentProperty) || (!parentProperty && !parentIdx))
toRemove.append(idx);
}
QListIterator<QtBrowserItem *> itRemove(toRemove);
while (itRemove.hasNext()) {
QtBrowserItem *index = itRemove.next();
removeBrowserIndex(index);
}
}
void QtAbstractPropertyBrowserPrivate::removeBrowserIndex(QtBrowserItem *index)
{
QList<QtBrowserItem *> children = index->children();
for (int i = children.count(); i > 0; i--) {
removeBrowserIndex(children.at(i - 1));
}
q_ptr->itemRemoved(index);
if (index->parent()) {
index->parent()->d_ptr->removeChild(index);
} else {
m_topLevelPropertyToIndex.remove(index->property());
m_topLevelIndexes.removeAll(index);
}
QtProperty *property = index->property();
m_propertyToIndexes[property].removeAll(index);
if (m_propertyToIndexes[property].isEmpty())
m_propertyToIndexes.remove(property);
delete index;
}
void QtAbstractPropertyBrowserPrivate::clearIndex(QtBrowserItem *index)
{
QList<QtBrowserItem *> children = index->children();
QListIterator<QtBrowserItem *> itChild(children);
while (itChild.hasNext()) {
clearIndex(itChild.next());
}
delete index;
}
void QtAbstractPropertyBrowserPrivate::slotPropertyInserted(QtProperty *property,
QtProperty *parentProperty, QtProperty *afterProperty)
{
if (!m_propertyToParents.contains(parentProperty))
return;
createBrowserIndexes(property, parentProperty, afterProperty);
insertSubTree(property, parentProperty);
//q_ptr->propertyInserted(property, parentProperty, afterProperty);
}
void QtAbstractPropertyBrowserPrivate::slotPropertyRemoved(QtProperty *property,
QtProperty *parentProperty)
{
if (!m_propertyToParents.contains(parentProperty))
return;
removeSubTree(property, parentProperty); // this line should be probably moved down after propertyRemoved call
//q_ptr->propertyRemoved(property, parentProperty);
removeBrowserIndexes(property, parentProperty);
}
void QtAbstractPropertyBrowserPrivate::slotPropertyDestroyed(QtProperty *property)
{
if (!m_subItems.contains(property))
return;
q_ptr->removeProperty(property);
}
void QtAbstractPropertyBrowserPrivate::slotPropertyDataChanged(QtProperty *property)
{
if (!m_propertyToParents.contains(property))
return;
QMap<QtProperty *, QList<QtBrowserItem *> >::ConstIterator it =
m_propertyToIndexes.find(property);
if (it == m_propertyToIndexes.constEnd())
return;
QList<QtBrowserItem *> indexes = it.value();
QListIterator<QtBrowserItem *> itIndex(indexes);
while (itIndex.hasNext()) {
QtBrowserItem *idx = itIndex.next();
q_ptr->itemChanged(idx);
}
//q_ptr->propertyChanged(property);
}
/**
\class QtAbstractPropertyBrowser
\brief QtAbstractPropertyBrowser provides a base class for
implementing property browsers.
A property browser is a widget that enables the user to edit a
given set of properties. Each property is represented by a label
specifying the property's name, and an editing widget (e.g. a line
edit or a combobox) holding its value. A property can have zero or
more subproperties.
\image qtpropertybrowser.png
The top level properties can be retrieved using the
properties() function. To traverse each property's
subproperties, use the QtProperty::subProperties() function. In
addition, the set of top level properties can be manipulated using
the addProperty(), insertProperty() and removeProperty()
functions. Note that the QtProperty class provides a corresponding
set of functions making it possible to manipulate the set of
subproperties as well.
To remove all the properties from the property browser widget, use
the clear() function. This function will clear the editor, but it
will not delete the properties since they can still be used in
other editors.
The properties themselves are created and managed by
implementations of the QtAbstractPropertyManager class. A manager
can handle (i.e. create and manage) properties of a given type. In
the property browser the managers are associated with
implementations of the QtAbstractEditorFactory: A factory is a
class able to create an editing widget of a specified type.
When using a property browser widget, managers must be created for
each of the required property types before the properties
themselves can be created. To ensure that the properties' values
will be displayed using suitable editing widgets, the managers
must be associated with objects of the preferred factory
implementations using the setFactoryForManager() function. The
property browser will use these associations to determine which
factory it should use to create the preferred editing widget.
Note that a factory can be associated with many managers, but a
manager can only be associated with one single factory within the
context of a single property browser. The associations between
managers and factories can at any time be removed using the
unsetFactoryForManager() function.
Whenever the property data changes or a property is inserted or
removed, the itemChanged(), itemInserted() or
itemRemoved() functions are called, respectively. These
functions must be reimplemented in derived classes in order to
update the property browser widget. Be aware that some property
instances can appear several times in an abstract tree
structure. For example:
\table 100%
\row
\o
\code
QtProperty *property1, *property2, *property3;
property2->addSubProperty(property1);
property3->addSubProperty(property2);
QtAbstractPropertyBrowser *editor;
editor->addProperty(property1);
editor->addProperty(property2);
editor->addProperty(property3);
\endcode
\o \image qtpropertybrowser-duplicate.png
\endtable
The addProperty() function returns a QtBrowserItem that uniquely
identifies the created item.
To make a property editable in the property browser, the
createEditor() function must be called to provide the
property with a suitable editing widget.
Note that there are two ready-made property browser
implementations:
\list
\o QtGroupBoxPropertyBrowser
\o QtTreePropertyBrowser
\endlist
\sa QtAbstractPropertyManager, QtAbstractEditorFactoryBase
*/
/**
\fn void QtAbstractPropertyBrowser::setFactoryForManager(PropertyManager *manager,
QtAbstractEditorFactory<PropertyManager> *factory)
Connects the given \a manager to the given \a factory, ensuring
that properties of the \a manager's type will be displayed with an
editing widget suitable for their value.
For example:
\code
QtIntPropertyManager *intManager;
QtDoublePropertyManager *doubleManager;
QtProperty *myInteger = intManager->addProperty();
QtProperty *myDouble = doubleManager->addProperty();
QtSpinBoxFactory *spinBoxFactory;
QtDoubleSpinBoxFactory *doubleSpinBoxFactory;
QtAbstractPropertyBrowser *editor;
editor->setFactoryForManager(intManager, spinBoxFactory);
editor->setFactoryForManager(doubleManager, doubleSpinBoxFactory);
editor->addProperty(myInteger);
editor->addProperty(myDouble);
\endcode
In this example the \c myInteger property's value is displayed
with a QSpinBox widget, while the \c myDouble property's value is
displayed with a QDoubleSpinBox widget.
Note that a factory can be associated with many managers, but a
manager can only be associated with one single factory. If the
given \a manager already is associated with another factory, the
old association is broken before the new one established.
This function ensures that the given \a manager and the given \a
factory are compatible, and it automatically calls the
QtAbstractEditorFactory::addPropertyManager() function if necessary.
\sa unsetFactoryForManager()
*/
/**
\fn virtual void QtAbstractPropertyBrowser::itemInserted(QtBrowserItem *insertedItem,
QtBrowserItem *precedingItem) = 0
This function is called to update the widget whenever a property
is inserted or added to the property browser, passing pointers to
the \a insertedItem of property and the specified
\a precedingItem as parameters.
If \a precedingItem is 0, the \a insertedItem was put at
the beginning of its parent item's list of subproperties. If
the parent of \a insertedItem is 0, the \a insertedItem was added as a top
level property of \e this property browser.
This function must be reimplemented in derived classes. Note that
if the \a insertedItem's property has subproperties, this
method will be called for those properties as soon as the current call is finished.
\sa insertProperty(), addProperty()
*/
/**
\fn virtual void QtAbstractPropertyBrowser::itemRemoved(QtBrowserItem *item) = 0
This function is called to update the widget whenever a property
is removed from the property browser, passing the pointer to the
\a item of the property as parameters. The passed \a item is
deleted just after this call is finished.
If the the parent of \a item is 0, the removed \a item was a
top level property in this editor.
This function must be reimplemented in derived classes. Note that
if the removed \a item's property has subproperties, this
method will be called for those properties just before the current call is started.
\sa removeProperty()
*/
/**
\fn virtual void QtAbstractPropertyBrowser::itemChanged(QtBrowserItem *item) = 0
This function is called whenever a property's data changes,
passing a pointer to the \a item of property as parameter.
This function must be reimplemented in derived classes in order to
update the property browser widget whenever a property's name,
tool tip, status tip, "what's this" text, value text or value icon
changes.
Note that if the property browser contains several occurrences of
the same property, this method will be called once for each
occurrence (with a different item each time).
\sa QtProperty, items()
*/
/**
Creates an abstract property browser with the given \a parent.
*/
QtAbstractPropertyBrowser::QtAbstractPropertyBrowser(QWidget *parent)
: QWidget(parent)
{
d_ptr = new QtAbstractPropertyBrowserPrivate;
d_ptr->q_ptr = this;
}
/**
Destroys the property browser, and destroys all the items that were
created by this property browser.
Note that the properties that were displayed in the editor are not
deleted since they still can be used in other editors. Neither
does the destructor delete the property managers and editor
factories that were used by this property browser widget unless
this widget was their parent.
\sa QtAbstractPropertyManager::~QtAbstractPropertyManager()
*/
QtAbstractPropertyBrowser::~QtAbstractPropertyBrowser()
{
QList<QtBrowserItem *> indexes = topLevelItems();
QListIterator<QtBrowserItem *> itItem(indexes);
while (itItem.hasNext())
d_ptr->clearIndex(itItem.next());
delete d_ptr;
}
/**
Returns the property browser's list of top level properties.
To traverse the subproperties, use the QtProperty::subProperties()
function.
\sa addProperty(), insertProperty(), removeProperty()
*/
QList<QtProperty *> QtAbstractPropertyBrowser::properties() const
{
return d_ptr->m_subItems;
}
/**
Returns the property browser's list of all items associated
with the given \a property.
There is one item per instance of the property in the browser.
\sa topLevelItem()
*/
QList<QtBrowserItem *> QtAbstractPropertyBrowser::items(QtProperty *property) const
{
return d_ptr->m_propertyToIndexes.value(property);
}
/**
Returns the top-level items associated with the given \a property.
Returns 0 if \a property wasn't inserted into this property
browser or isn't a top-level one.
\sa topLevelItems(), items()
*/
QtBrowserItem *QtAbstractPropertyBrowser::topLevelItem(QtProperty *property) const
{
return d_ptr->m_topLevelPropertyToIndex.value(property);
}
/**
Returns the list of top-level items.
\sa topLevelItem()
*/
QList<QtBrowserItem *> QtAbstractPropertyBrowser::topLevelItems() const
{
return d_ptr->m_topLevelIndexes;
}
/**
Removes all the properties from the editor, but does not delete
them since they can still be used in other editors.
\sa removeProperty(), QtAbstractPropertyManager::clear()
*/
void QtAbstractPropertyBrowser::clear()
{
QList<QtProperty *> subList = properties();
QListIterator<QtProperty *> itSub(subList);
itSub.toBack();
while (itSub.hasPrevious()) {
QtProperty *property = itSub.previous();
removeProperty(property);
}
}
/**
Appends the given \a property (and its subproperties) to the
property browser's list of top level properties. Returns the item
created by property browser which is associated with the \a property.
In order to get all children items created by the property
browser in this call, the returned item should be traversed.
If the specified \a property is already added, this function does
nothing and returns 0.
\sa insertProperty(), QtProperty::addSubProperty(), properties()
*/
QtBrowserItem *QtAbstractPropertyBrowser::addProperty(QtProperty *property)
{
QtProperty *afterProperty = 0;
if (d_ptr->m_subItems.count() > 0)
afterProperty = d_ptr->m_subItems.last();
return insertProperty(property, afterProperty);
}
/**
\fn QtBrowserItem *QtAbstractPropertyBrowser::insertProperty(QtProperty *property,
QtProperty *afterProperty)
Inserts the given \a property (and its subproperties) after
the specified \a afterProperty in the browser's list of top
level properties. Returns item created by property browser which
is associated with the \a property. In order to get all children items
created by the property browser in this call returned item should be traversed.
If the specified \a afterProperty is 0, the given \a property is
inserted at the beginning of the list. If \a property is
already inserted, this function does nothing and returns 0.
\sa addProperty(), QtProperty::insertSubProperty(), properties()
*/
QtBrowserItem *QtAbstractPropertyBrowser::insertProperty(QtProperty *property,
QtProperty *afterProperty)
{
if (!property)
return 0;
// if item is already inserted in this item then cannot add.
QList<QtProperty *> pendingList = properties();
int pos = 0;
int newPos = 0;
while (pos < pendingList.count()) {
QtProperty *prop = pendingList.at(pos);
if (prop == property)
return 0;
if (prop == afterProperty) {
newPos = pos + 1;
}
pos++;
}
d_ptr->createBrowserIndexes(property, 0, afterProperty);
// traverse inserted subtree and connect to manager's signals
d_ptr->insertSubTree(property, 0);
d_ptr->m_subItems.insert(newPos, property);
return topLevelItem(property);
}
/**
Removes the specified \a property (and its subproperties) from the
property browser's list of top level properties. All items
that were associated with the given \a property and its children
are deleted.
Note that the properties are \e not deleted since they can still
be used in other editors.
\sa clear(), QtProperty::removeSubProperty(), properties()
*/
void QtAbstractPropertyBrowser::removeProperty(QtProperty *property)
{
if (!property)
return;
QList<QtProperty *> pendingList = properties();
int pos = 0;
while (pos < pendingList.count()) {
if (pendingList.at(pos) == property) {
d_ptr->m_subItems.removeAt(pos); //perhaps this two lines
d_ptr->removeSubTree(property, 0); //should be moved down after propertyRemoved call.
//propertyRemoved(property, 0);
d_ptr->removeBrowserIndexes(property, 0);
// when item is deleted, item will call removeItem for top level items,
// and itemRemoved for nested items.
return;
}
pos++;
}
}
/**
Creates an editing widget (with the given \a parent) for the given
\a property according to the previously established associations
between property managers and editor factories.
If the property is created by a property manager which was not
associated with any of the existing factories in \e this property
editor, the function returns 0.
To make a property editable in the property browser, the
createEditor() function must be called to provide the
property with a suitable editing widget.
Reimplement this function to provide additional decoration for the
editing widgets created by the installed factories.
\sa setFactoryForManager()
*/
QWidget *QtAbstractPropertyBrowser::createEditor(QtProperty *property,
QWidget *parent)
{
QtAbstractEditorFactoryBase *factory = 0;
QtAbstractPropertyManager *manager = property->propertyManager();
if (m_viewToManagerToFactory()->contains(this) &&
(*m_viewToManagerToFactory())[this].contains(manager)) {
factory = (*m_viewToManagerToFactory())[this][manager];
}
if (!factory)
return 0;
return factory->createEditor(property, parent);
}
bool QtAbstractPropertyBrowser::addFactory(QtAbstractPropertyManager *abstractManager,
QtAbstractEditorFactoryBase *abstractFactory)
{
bool connectNeeded = false;
if (!m_managerToFactoryToViews()->contains(abstractManager) ||
!(*m_managerToFactoryToViews())[abstractManager].contains(abstractFactory)) {
connectNeeded = true;
} else if ((*m_managerToFactoryToViews())[abstractManager][abstractFactory]
.contains(this)) {
return connectNeeded;
}
if (m_viewToManagerToFactory()->contains(this) &&
(*m_viewToManagerToFactory())[this].contains(abstractManager)) {
unsetFactoryForManager(abstractManager);
}
(*m_managerToFactoryToViews())[abstractManager][abstractFactory].append(this);
(*m_viewToManagerToFactory())[this][abstractManager] = abstractFactory;
return connectNeeded;
}
/**
Removes the association between the given \a manager and the
factory bound to it, automatically calling the
QtAbstractEditorFactory::removePropertyManager() function if necessary.
\sa setFactoryForManager()
*/
void QtAbstractPropertyBrowser::unsetFactoryForManager(QtAbstractPropertyManager *manager)
{
if (!m_viewToManagerToFactory()->contains(this) ||
!(*m_viewToManagerToFactory())[this].contains(manager)) {
return;
}
QtAbstractEditorFactoryBase *abstractFactory =
(*m_viewToManagerToFactory())[this][manager];
(*m_viewToManagerToFactory())[this].remove(manager);
if ((*m_viewToManagerToFactory())[this].isEmpty()) {
(*m_viewToManagerToFactory()).remove(this);
}
(*m_managerToFactoryToViews())[manager][abstractFactory].removeAll(this);
if ((*m_managerToFactoryToViews())[manager][abstractFactory].isEmpty()) {
(*m_managerToFactoryToViews())[manager].remove(abstractFactory);
abstractFactory->breakConnection(manager);
if ((*m_managerToFactoryToViews())[manager].isEmpty()) {
(*m_managerToFactoryToViews()).remove(manager);
}
}
}
/**
Returns the current item in the property browser.
\sa setCurrentItem()
*/
QtBrowserItem *QtAbstractPropertyBrowser::currentItem() const
{
return d_ptr->m_currentItem;
}
/**
Sets the current item in the property browser to \a item.
\sa currentItem(), currentItemChanged()
*/
void QtAbstractPropertyBrowser::setCurrentItem(QtBrowserItem *item)
{
QtBrowserItem *oldItem = d_ptr->m_currentItem;
d_ptr->m_currentItem = item;
if (oldItem != item)
emit currentItemChanged(item);
}