Base class for an element wrapping an item. More...
Inheritance diagram for Visualization::ItemWrapperFormElement< ParentType, ChildItemType >:
Public Types | |
| using | ChildItem = ChildItemType *ParentType::* |
Public Member Functions | |
| ItemWrapperFormElement ()=delete | |
| ItemWrapperFormElement (ChildItem item) | |
| ItemWrapperFormElement (const ItemWrapperFormElement< ParentType, ChildItemType > &)=default | |
| virtual | ~ItemWrapperFormElement () |
| virtual QList< const Item *const DeclarativeItemBase::* > | allHandledChildPointers () override |
| Returns a list of all pointer to child items of this form. More... | |
| virtual void | computeSize (Item *item, int availableWidth, int availableHeight) override |
| Method called inside the item's updateGeometry method to compute it's size and position it's child elements. More... | |
| virtual void | destroyChildItems (Item *item, QList< const Item *const DeclarativeItemBase::* > handledChildren) override |
| This method is recursively called on all form elements to destroy all the information they might have about a specific item. More... | |
| bool | elementOrChildHasFocus (Item *item) const override |
| Method called inside the item's elementOrChildHasFocus and by some layout form elements. More... | |
| bool | isEmpty (const Item *item) const override |
| Method called inside the item's isEmpty method, and by some layout form elements. More... | |
| ItemWrapperFormElement< ParentType, ChildItemType > & | operator= (const ItemWrapperFormElement< ParentType, ChildItemType > &)=delete |
| virtual QList< ItemRegion > | regions (DeclarativeItemBase *item, int parentX, int parentY) override |
| Method called inside the item's regions method and returns cursor and item regions of all contained form elements for this item. More... | |
| virtual void | setItemPositions (Item *item, int parentX, int parentY) override |
| Method called inside the item's updateGeometry method to recursively position it's child items relative to the item's position. More... | |
| virtual bool | sizeDependsOnParent (const Item *item) const override |
| Method called inside the item's sizeDependsOnParent method, and by some layout form elements. More... | |
 Public Member Functions inherited from Visualization::FormElement | |
| FormElement ()=default | |
| FormElement (const FormElement &other) | |
| virtual | ~FormElement () |
| virtual FormElement * | clone () const =0 |
| Copy this element and all its children into a new element tree. More... | |
| FormElement * | cloneIfAlreadyUsed () |
| int | height (Item *item) const |
| Returns the cached height of this form element for the specified item. More... | |
| bool | isFormRoot () const |
| FormElement & | operator= (const FormElement &)=delete |
| FormElement * | parent () const |
| QPoint | pos (Item *item) const |
| Returns the cached position of this form element for the specified item. More... | |
| FormElement * | setBottomMargin (int bottom) |
| Sets the bottom margin of this form element. More... | |
| FormElement * | setFormRoot () |
| Sets this element to be a formRoot. More... | |
| FormElement * | setLeftMargin (int left) |
| Sets the left margin of this form element. More... | |
| FormElement * | setMargins (int left, int top, int right, int bottom) |
| Sets the left, top, right and bottom margins to the respective values. More... | |
| FormElement * | setMargins (int margin) |
| Sets all the margins of this form element to the value specified as margin. More... | |
| void | setPos (Item *item, const QPoint &position) |
| Caches the position of this form element for the specified item. More... | |
| FormElement * | setRightMargin (int right) |
| Sets the right margin of this form element. More... | |
| FormElement * | setTopMargin (int top) |
| Sets the top margin of this form element. More... | |
| virtual QList< FormElement * > | shapeElements () |
| Returns the list of shape elements inside this form element. More... | |
| QSize | size (Item *item) const |
| Returns the cached size of this form element for the specified item. More... | |
| virtual void | synchronizeWithItem (Item *item) |
| Method called inside the item's determineChildren method to let the form element and it's children update their information about items and nodes belonging to this item. More... | |
| int | width (Item *item) const |
| Returns the cached width of this form element for the specified item. More... | |
| int | x (Item *item) const |
| Returns the cached position on the x-axis of this form element for the specified item. More... | |
| int | xEnd (Item *item) const |
| Returns the cached position on the x-axis where this form element ends for the specified item. More... | |
| int | y (Item *item) const |
| Returns the cached position on the y-axis of this form element for the specified item. More... | |
| int | yEnd (Item *item) const |
| Returns the cached position on the y-axis where this form element ends for the specified item. More... | |
Protected Member Functions | |
| ChildItem | item () const |
| Protected Member Functions inherited from Visualization::FormElement | |
| void | addChild (FormElement *child) |
| Adds a child to the list of children. More... | |
| int | bottomMargin () |
| Returns the bottom margin. More... | |
| const QVector< FormElement * > & | children () const |
| Returns the list of children. More... | |
| int | leftMargin () |
| Returns the left margin. More... | |
| void | removeChild (FormElement *child) |
| Removes a child from the list of children. More... | |
| int | rightMargin () |
| Returns the right margin. More... | |
| void | setSize (Item *item, const QSize &size) |
| Caches the size of this form element for the specified item. More... | |
| int | topMargin () |
| Returns the top margin. More... | |
Private Attributes | |
| ChildItem | item_ {} |
Detailed Description
template<typename ParentType, typename ChildItemType = Item>
class Visualization::ItemWrapperFormElement< ParentType, ChildItemType >
Base class for an element wrapping an item.
Member Typedef Documentation
◆ ChildItem
template<typename ParentType , typename ChildItemType = Item>
| using Visualization::ItemWrapperFormElement< ParentType, ChildItemType >::ChildItem = ChildItemType* ParentType::* |
Constructor & Destructor Documentation
◆ ItemWrapperFormElement() [1/3]
template<typename ParentType , typename ChildItemType >
| Visualization::ItemWrapperFormElement< ParentType, ChildItemType >::ItemWrapperFormElement | ( | ChildItem | item | ) |
◆ ItemWrapperFormElement() [2/3]
template<typename ParentType , typename ChildItemType = Item>
|
delete |
◆ ItemWrapperFormElement() [3/3]
template<typename ParentType , typename ChildItemType = Item>
|
default |
◆ ~ItemWrapperFormElement()
template<typename ParentType , typename ChildItemType = Item>
|
inlinevirtual |
Member Function Documentation
◆ allHandledChildPointers()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Returns a list of all pointer to child items of this form.
This list should only be used for comparison as in destroyChildItems() and should not be used for writing.
Reimplemented from Visualization::FormElement.
◆ computeSize()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's updateGeometry method to compute it's size and position it's child elements.
The arguments availableWidth and availableHeight are similar to those of Item::updateGeometry. If they are zero, the form element calculates its minimum size, if it they are bigger, the element tries to stretch/grow to this size, but not further.
Implements Visualization::FormElement.
◆ destroyChildItems()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
This method is recursively called on all form elements to destroy all the information they might have about a specific item.
It is called in two cases:
- When the item is being destroyed. In that case all information and child items should be destroyed. The second argument is an empty list.
- When the current form is changing. In that case only information pertaining to child items which are not definitely handled by the new form should be removed. The second argument is a list of all child item pointer handled by the new form.
Reimplemented from Visualization::FormElement.
◆ elementOrChildHasFocus()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's elementOrChildHasFocus and by some layout form elements.
It recursively determines if this form element or any of its children has the focus for the specified item.
Reimplemented from Visualization::FormElement.
◆ isEmpty()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's isEmpty method, and by some layout form elements.
It recursively determines whether the form element is empty for the specified item.
Reimplemented from Visualization::FormElement.
◆ item()
template<typename ParentType , typename ChildItemType >
|
protected |
◆ operator=()
template<typename ParentType , typename ChildItemType = Item>
|
delete |
◆ regions()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's regions method and returns cursor and item regions of all contained form elements for this item.
parentX and parentY are the offsets that this element needs to have from the parent item (similar to the setItemPositions method).
Reimplemented from Visualization::FormElement.
◆ setItemPositions()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's updateGeometry method to recursively position it's child items relative to the item's position.
parentX and parentY are the offsets that this form element needs to have from the parent item. The element then puts its children at this offset plus the offset for its children relative to itself.
Reimplemented from Visualization::FormElement.
◆ sizeDependsOnParent()
template<typename ParentType , typename ChildItemType >
|
overridevirtual |
Method called inside the item's sizeDependsOnParent method, and by some layout form elements.
If the form element returns true it can be, that computeSize is called on it a second time with non-zero availableWidth and availableHeight.
Implements Visualization::FormElement.
Member Data Documentation
◆ item_
template<typename ParentType , typename ChildItemType = Item>
|
private |
