Constructs a QGraphicsWidget instance. The parent argument is passed to QGraphicsItem's constructor and the flags argument specifies the widget's window flags. The flags are used to specify if the widget should be a window, a tool, a popup, etc.

Destroys the QGraphicsWidget instance.

Returns the list of this widget's actions.

See also

insertAction(), removeAction(), QWidget::actions(), QAction::associatedWidgets(), QAction::associatedGraphicsWidgets()

Appends the givenaction to this widget's list of actions. All QGraphicsWidgets have a list of QActions, however they can be represented graphically in many different ways. The default use of the QAction list (as returned by actions()) is to create a context QMenu.

A QGraphicsWidget should only have one of each action and adding an action it already has will not cause the same action to be in the widget twice.

See also

removeAction(), insertAction(), actions(), QWidget::addAction()

Appends the given actions to this widget's list of actions.

See also

removeAction(), QMenu, addAction(), QWidget::addActions()

Adjusts the size of the widget to its effective preferred size hint. This method is called implicitly when the item is shown for the first time.

See also

effectiveSizeHint(), Qt::SizeHint

Returns the value of the property.

Reimplemented from QGraphicsItem::boundingRect()

This event handler can be reimplemented to respond to various state changes. The new state can be retrieved using event. The following is a list of the events which will be passed to this method.

• QEvent::ActivationChange
• QEvent::EnabledChange
• QEvent::FontChange
• QEvent::StyleChange
• QEvent::PaletteChange
• QEvent::ParentChange
• QEvent::LayoutDirectionChange
• QEvent::ContentsRectChange

Returns a list of child objects. The first child added is the first object in the list and the last child added is the last object in the list. New children are appended at the end.

The list order changes whenever QWidget children are moved in the Z order, causing them to be raised or lowered. A widget that is raised becomes the last object in the list and a widget that is lowered becomes the first object in the list.

See also

findChild(), findChildren(), parent(), setParent()

Closes the widget. Returns true if the widget was closed, otherwise returns false. Send a QCloseEvent to the widget, which may or may not accept the event. If the event was ignored, nothing happens. If the event was accepted, it will hide() the widget. If the widget has the Qt::WA_DeleteOnClose attribute set it will be deleted.

The given event handler event, can be reimplemented in a subclass to receive widget close events. The default implementation accepts the event.

See also

close(), QCloseEvent

Handles the given event.

Reimplemented from QGraphicsItem::focusInEvent()

Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget; returns false otherwise. If next is true this method searches forward. If next is false it searches backward.

Sometimes, you will want to reimplement this method to provide special focus handling for your widget and its subwidgets. For example, a web browser might reimplement it to move its current active link forward or backward, and call the base implementation only when it reaches the last or first link on the page.

Child widgets call focusNextPrevChild() on their parent widgets, but only the window that contains the child widgets decides where to redirect focus. By reimplementing this method for an object, you gain control of focus traversal for all child widgets.

See also

focusPolicy()

Reimplemented in QGraphicsWebView::focusNextPrevChild(), QGraphicsProxyWidget::focusNextPrevChild()

Reimplemented from QGraphicsItem::focusOutEvent()

Returns the value of the property.

If this widget or one of its children currently has input focus, this method will return a pointer to that widget. If no descendant widget has input focus a nullptr is returned.

See also

QGraphicsItem::focusItem(), QWidget::focusWidget()

Returns the value of the property.

This signal is emitted whenever the geometry is changed in setGeometry().

Gets the widget's contents margins. The margins are stored in left, top, right and bottom, as pointers to qreals. Each argument can be omitted by passing a nullptr.

See also

setContentsMargins()

Reimplemented from QGraphicsLayoutItem::getContentsMargins()

Gets the widget's window frame margins. The margins are stored in left, top, right and bottom as pointers to qreals. Each argument can be omitted by passing a nullptr.

See also

setWindowFrameMargins(), windowFrameRect()

This event handler can be reimplemented in a subclass to receive notifications for QEvent::GrabKeyboard events.

See also

grabKeyboard(), grabMouse()

This event handler can be reimplemented in a subclass to receive notifications for QEvent::GrabMouse events.

See also

grabMouse(), grabKeyboard()

Reimplemented in QGraphicsProxyWidget::grabMouseEvent()

Adds a shortcut to the CopperSpice shortcut system that watches for the given key sequence in the given context. If the context is Qt::ApplicationShortcut, the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, Qt::WidgetShortcut, or to the window itself, Qt::WidgetShortcut. For widgets that are not part of a window (i.e., top-level widgets and their children), Qt::WidgetShortcut shortcuts apply to the scene.

If the same key sequence has been grabbed by several widgets, when the key sequence occurs a QEvent::Shortcut event is sent to all the widgets to which it applies in a non-deterministic order, but with the ambiguous flag set to true.

Warning

You should not normally need to use this function; instead create QActions with the shortcut key sequences you require (if you also want equivalent menu options and toolbar buttons), or create QShortcuts if you just need key sequences. Both QAction and QShortcut handle all the event filtering for you, and provide signals which are triggered when the user triggers the key sequence, so are much easier to use than this low-level function.

See also

releaseShortcut(), setShortcutEnabled(), QWidget::grabShortcut()

This event handler, for Hide events, is delivered after the widget has been hidden, for example, setVisible(false) has been called for the widget or one of its ancestors when the widget was previously shown. You can reimplement this event handler to detect when your widget is hidden. Calling QEvent::accept() or QEvent::ignore() on event has no effect.

See also

showEvent(), QWidget::hideEvent(), QGraphicsItem::GraphicsItemChange

Reimplemented in QGraphicsProxyWidget::hideEvent()

Reimplemented from QGraphicsItem::hoverLeaveEvent ()

Reimplemented from QGraphicsItem::hoverMoveEvent()

Populates a style option object for this widget based on its current state, and stores the output in option. The default implementation populates option with the following properties.

Subclasses of QGraphicsWidget should call the base implementation, and then test the type of option using qstyleoption_cast<>() or test QStyleOption::Type before storing widget-specific options.

See also

QStyleOption::initFrom()

Inserts the action to the current widget list of actions prior to the action specified by before. The action is appended if the before parameter is a nullptr or is not a valid action for this widget. A QGraphicsWidget should only have one of each action.

See also

removeAction(), addAction(), QMenu, actions(), QWidget::insertActions()

Inserts the actions to the current widget list of actions prior to the action specified by before. The actions are appended if the before parameter is a nullptr or is not a valid action for this widget. A QGraphicsWidget should only have one of each action.

See also

removeAction(), QMenu, insertAction(), QWidget::insertActions()

Returns true if this widget's window is in the active window, or if the widget does not have a window but is in an active scene (i.e., a scene that currently has focus). The active window is the window that either contains a child widget that currently has input focus, or that itself has input focus.

See also

QGraphicsScene::activeWindow(), QGraphicsScene::setActiveWindow(), isActive()

QGraphicsWidget uses the base implementation of this function to catch and deliver events related to state changes in the item. Because of this, it is very important that subclasses call the base implementation. The value for change specifies the type of change and value is the new value.

For example, QGraphicsWidget uses QGraphicsItem::ItemVisibleChange to deliver Show and Hide events, QGraphicsItem::ItemPositionHasChanged to deliver Move events, and QGraphicsItem::ItemParentChange both to deliver ParentChange events and for managing the focus chain. QGraphicsWidget enables the ItemSendsGeometryChanges flag by default in order to track position changes.

See also

QGraphicsItem::itemChange()

Returns this widget's layout or a nullptr if no layout is currently managing this widget. Retrieves the value of the layout property.

See also

setLayout()

Returns the value of the property.

This event handler is delivered after the widget has moved (e.g., its local position has changed). This event is only delivered when the item is moved locally. Calling setTransform() or moving any of the item's ancestors does not affect the item's local position. This method can be reimplemented to detect when your widget has moved. Calling QEvent::accept() or QEvent::ignore() on event has no effect.

See also

QGraphicsItem::GraphicsItemChange

Reimplemented from QGraphicsItem::paint()

This virtual function is called by QGraphicsScene to draw the window frame for windows using painter, option, and widget, in local coordinates. The base implementation uses the current style to render the frame and title bar. You can reimplement this method in a subclass of QGraphicsWidget to provide custom rendering of the widget's window frame.

See also

QGraphicsItem::paint()

Returns the value of the property.

This event is delivered to the item by the scene at some point after it has been constructed, but before it is shown or otherwise accessed through the scene. You can use this event handler to do last-minute initializations of the widget which require the item to be fully constructed.

The base implementation does nothing.

Returns the item's local rect as a QRectF. This function is equivalent to QRectF(QPointF(), size()).

See also

setGeometry(), resize()

Removes the shortcut with the given id from the CopperSpice shortcut system. The widget will no longer receive QEvent::Shortcut events for the shortcut's key sequence (unless it has other shortcuts with the same key sequence).

Warning

You should not normally need to use this function since the CopperSpice shortcut system removes shortcuts automatically when their parent widget is destroyed. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function. Note also that this is an expensive operation.

See also

grabShortcut(), setShortcutEnabled(), QWidget::releaseShortcut()

Removes the action from widget list of actions.

See also

insertAction(), actions(), insertAction(), QWidget::removeAction()

Sets the value of the property to size.

Resizes the current QGraphicsWidget with the given width and height. Equivalent to calling resize(QSizeF(width, height)). This method sets the size property.

See also

setGeometry(), setTransform()

This event handler, for GraphicsSceneResize events, is delivered after the widget has been resized (i.e., its local size has changed). The event contains both the old and the new size. This event is only delivered when the widget is resized locally. Calling setTransform() on the widget or any of its ancestors or view, does not affect the widget's local size.

You can reimplement this event handler to detect when your widget has been resized. Calling QEvent::accept() or QEvent::ignore() on event has no effect.

See also

geometry(), setGeometry()

Reimplemented in QGraphicsProxyWidget::resizeEvent()

The default implementation passes event to QGraphicsWidget::event(). Events for a custom widget can be handled by overriding the event() method or methods like resizeEvent() and showEvent().

See also

QGraphicsItem::sceneEvent()

If on is true, this method enables attribute, otherwise attribute is disabled. Refer to the class documentation for QGraphicsWidget for a complete list of which attributes are supported and what they are for.

See also

testAttribute(), QWidget::setAttribute()

Sets the value of the property to enabled.

Sets the widget's contents margins to left, top, right and bottom.

Contents margins are used by the assigned layout to define the placement of subwidgets and layouts. Margins are particularly useful for widgets that constrain subwidgets to only a section of its own geometry. For example, a group box with a layout will place subwidgets inside its frame, but below the title.

Changing a widget's contents margins will always trigger an update() and any assigned layout will be activated automatically. The widget will then receive a ContentsRectChange event.

See also

getContentsMargins(), setGeometry()

Sets the value of the property to policy.

Sets the value of the property to font.

Sets the geometry of the QGraphicsLayoutItem to rect, which is in coordinates relative to the parent. If rect is outside of the bounds of minimumSize and maximumSize, it will be adjusted to the closest size which is within the legal bounds.

Reimplement this method in a subclass of QGraphicsLayoutItem to receive geometry updates. The layout will call this method when it does a rearrangement.

See also

geometry()

Reimplemented from QGraphicsLayoutItem::setGeometry()

Reimplemented in QGraphicsWebView::setGeometry()

Sets the geometry of the QGraphicsLayoutItem to rect, which is in coordinates relative to the parent. If rect is outside of the bounds of minimumSize and maximumSize, it will be adjusted to the closest size which is within the legal bounds.

Reimplement this method in a subclass of QGraphicsLayoutItem to receive geometry updates. The layout will call this method when it does a rearrangement.

See also

geometry()

Reimplemented from QGraphicsLayoutItem::setGeometry()

Reimplemented in QGraphicsWebView::setGeometry()

Equivalent to calling setGeometry(QRectF(x, y, width, height)). This method sets the geometry property.

See also

geometry(), resize()

Sets the layout for this widget to layout.

Any existing layout manager is deleted before the new layout is assigned. If layout is nullptr, the widget is left without a layout. Existing subwidgets' geometries will remain unaffected. All widgets that are currently managed by layout or all of its sublayouts, are automatically reparented to this item. The layout is then invalidated, and the child widget geometries are adjusted according to this item's geometry() and contentsMargins(). Children who are not explicitly managed by layout remain unaffected by the layout after it has been assigned to this widget.

QGraphicsWidget takes ownership of layout.

See also

layout(), QGraphicsLinearLayout::addItem(), QGraphicsLayout::invalidate()

Sets the value of the property to direction.

Sets the value of the property to palette.

If enabled is true the shortcut with the given id will have auto repeat enabled, otherwise it is disabled.

See also

grabShortcut(), releaseShortcut(), QWidget::setShortcutAutoRepeat()

If enabled is true the shortcut with the given id is enabled, otherwise the shortcut is disabled.

Warning

You should not normally need to use this method since the CopperSpice shortcut system enables/disables shortcuts automatically as widgets become hidden/visible and gain or lose focus. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function.

See also

grabShortcut(), releaseShortcut(), QWidget::setShortcutEnabled()

Sets the widget's style to style. QGraphicsWidget does not take ownership of style. If no style is assigned or style is a nullptr the widget will use QGraphicsScene::style() if this has been set. Otherwise the widget will use QApplication::style().

This method sets the Qt::WA_SetStyle attribute if style is not a nullptr, otherwise it clears the attribute.

See also

style()

Adjusts the tab order so the focus of the second widget occurs immediately after the first widget. The following code shows how to set the tab order to a, b, c, d.

This code fragment will set a tab order however it does not produce the same result.

If first is a nullptr this indicates the second widget should have initial focus when the window gains focus. If second is a nullptr this indicates the first widget should be placed at the end of the focus sequence.

By default tab order is defined implicitly using widget creation order.

See also

Qt:focusPolicy, Keyboard Focus

Sets the value of the property to flags.

Sets the widget's window frame margins to left, top, right and bottom. The default frame margins are provided by the style, and they depend on the current window flags. If you would like to draw your own window decoration, you can set your own frame margins to override the default margins.

See also

unsetWindowFrameMargins(), getWindowFrameMargins(), windowFrameRect()

Sets the value of the property to title.

Reimplemented from QGraphicsItem::shape()

This event handler, for Show events, is delivered before the widget has been shown, for example, setVisible(true) has been called for the widget or one of its ancestors when the widget was previously hidden. You can reimplement this event handler to detect when your widget is shown. Calling QEvent::accept() or QEvent::ignore() on event has no effect.

See also

hideEvent(), QWidget::showEvent(), QGraphicsItem::GraphicsItemChange

Reimplemented in QGraphicsProxyWidget::showEvent()

Returns the value of the property.

Implements QGraphicsLayoutItem::sizeHint()

Reimplemented in QGraphicsWebView::sizeHint()

Returns a pointer to the widget's style. If this widget does not have any explicitly assigned style, the scene's style is returned instead. In turn, if the scene does not have any assigned style, this function returns QApplication::style().

See also

setStyle()

Returns true if attribute is enabled for this widget, otherwise returns false.

See also

setAttribute()

Reimplemented from QGraphicsItem::type()

This method can be reimplemented in a subclass to receive notifications for event.

See also

ungrabKeyboard(), ungrabMouse()

This method can be reimplemented in a subclass to receive notifications for event.

See also

ungrabMouse(), ungrabKeyboard()

Reimplemented in QGraphicsProxyWidget::ungrabMouseEvent()

Removes the value of the layoutDirection property.

Resets the window frame margins to the default value, provided by the style.

See also

setWindowFrameMargins(), getWindowFrameMargins(), windowFrameRect()

If this widget is currently managed by a layout, this function notifies the layout that the widget's size hints have changed and the layout may need to resize and reposition the widget accordingly. Call this method if the widget's sizeHint() has changed.

See also

QGraphicsLayout::invalidate()

Reimplemented from QGraphicsLayoutItem::updateGeometry()

Reimplemented in QGraphicsWebView::updateGeometry()

Returns the value of the property.

This method receives an event for the window frame. The base class implementation provides support for default window frame actions like moving, resizing, etc. Returns true if event has been recognized and processed, otherwise returns false.

You can reimplement this method to provide custom window frame interaction support.

See also

event()

Returns the widget's geometry in parent coordinates including any window frame.

See also

windowFrameRect(), getWindowFrameMargins(), setWindowFrameMargins()

Returns the widget's local rect including any window frame.

See also

windowFrameGeometry(), getWindowFrameMargins(), setWindowFrameMargins()

Returns the window frame section at position pos, or Qt::NoSection if there is no window frame section at this position.

This method is used in QGraphicsWidget's base implementation for window frame interaction.

You can reimplement this function if you want to customize how a window can be interactively moved or resized. For instance, if you only want to allow a window to be resized by the bottom right corner, you can reimplement this function to return Qt::NoSection for all sections except Qt::BottomRightSection.

See also

windowFrameEvent(), paintWindowFrame(), windowFrameGeometry()

Returns the value of the property.

Returns the widgets window type.

See also

windowFlags(), isWindow(), isPanel()

This property holds whether the widget background is filled automatically. If enabled, this property will cause CopperSpice to fill the background of the widget before invoking the paint() method. The color used is defined by the QPalette::Window color role from the widget's palette. Windows are always filled with QPalette::Window unless the Qt::WA_OpaquePaintEvent or Qt::WA_NoSystemBackground attributes are set.

By default, this property is false.

See also

Qt::WidgetAttribute

This property holds the way the widget accepts keyboard focus.

The focus policy is Qt::TabFocus if the widget accepts keyboard focus by tabbing, Qt::ClickFocus if the widget accepts focus by clicking, Qt::StrongFocus if it accepts both, and Qt::NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget's constructor. For instance, the QLineEdit constructor calls setFocusPolicy(Qt::StrongFocus).

If you enable a focus policy (i.e., not Qt::NoFocus), QGraphicsWidget will automatically enable the QGraphicsItem::ItemIsFocusable flag. Setting Qt::NoFocus on a widget will clear the QGraphicsItem::ItemIsFocusable flag. If the widget currently has keyboard focus, the widget will automatically lose focus.

See also

focusInEvent(), focusOutEvent(), keyPressEvent(), keyReleaseEvent(), QGraphicsObject::enabled

This property holds the font for the widget.

QFont consists of font properties that have been explicitly defined and properties implicitly inherited from the widget's parent. Hence, font() can return a different font compared to the one set with setFont(). This scheme allows you to define single entries in a font without affecting the font's inherited entries.

When a widget's font changes, it resolves its entries against its parent widget. If the widget does not have a parent widget, it resolves its entries against the scene. The widget then sends itself a FontChange event and notifies all its descendants so that they can resolve their fonts as well.

By default, this property contains the application's default font.

See also

QApplication::font(), QGraphicsScene::font, QFont::resolve()

This property holds the geometry of the widget.

Calling setGeometry() sets the item's geometry to the given rectangle. The item's position and size are modified as a result of calling this method. The item is first moved then resized. A side effect of calling this method is that the widget will receive a move event and a resize event. If the widget has a layout assigned the layout will activate.

See also

geometry(), resize(), setGeometry()

This property holds the layout of the widget.

Any existing layout manager is deleted before the new layout is assigned. If layout is a nullptr, the widget is left without a layout. Existing subwidgets' geometries will remain unaffected. QGraphicsWidget takes ownership of layout.

All widgets that are currently managed by layout or all of its sublayouts, are automatically reparented to this item. The layout is then invalidated, and the child widget geometries are adjusted according to this item's geometry() and contentsMargins(). Children who are not explicitly managed by layout remain unaffected by the layout after it has been assigned to this widget.

If no layout is currently managing this widget, layout() will return a nullptr.

This property holds the layout direction for this widget. This property modifies this widget's and all of its descendants' Qt::WA_RightToLeft attribute. It also sets this widget's Qt::WA_SetLayoutDirection attribute.

The widget's layout direction determines the order in which the layout manager horizontally arranges subwidgets of this widget. The default value depends on the language and locale of the application, and is typically in the same direction as words are read and written. With Qt::LeftToRight, the layout starts placing subwidgets from the left side of this widget towards the right. Qt::RightToLeft does the opposite, the layout will place widgets starting from the right edge moving towards the left.

Subwidgets inherit their layout direction from the parent. Top-level widget items inherit their layout direction from QGraphicsScene::layoutDirection. If you change a widget's layout direction by calling setLayoutDirection(), the widget will send itself a LayoutDirectionChange event, and then propagate the new layout direction to all its descendants.

See also

QWidget::layoutDirection, QApplication::layoutDirection

This property holds the maximum size of the widget.

See also

setMaximumSize(), maximumSize(), Qt::SizeHint

This property holds the minimum size of the widget.

See also

setMinimumSize(), minimumSize(), Qt::SizeHint

This property provides the widget's palette. The palette provides colors and brushes for color groups (e.g., QPalette::Button) and states (e.g., QPalette::Inactive), loosely defining the general look of the widget and its children.

QPalette consists of color groups that have been explicitly defined, and groups that are implicitly inherited from the widget's parent. Because of this, palette() can return a different palette than what has been set with setPalette(). This scheme allows you to define single entries in a palette without affecting the palette's inherited entries.

When a widget's palette changes, it resolves its entries against its parent widget, or if it does not have a parent widget, it resolves against the scene. It then sends itself a PaletteChange event, and notifies all its descendants so they can resolve their palettes as well.

By default, this property contains the application's default palette.

See also

QApplication::palette(), QGraphicsScene::palette, QPalette::resolve()

This property holds the preferred size of the widget.

See also

setPreferredSize(), preferredSize(), Qt::SizeHint

This property holds the size of the widget.

Calling resize() resizes the widget to a size bounded by minimumSize() and maximumSize(). This property only affects the widget's width and height (e.g., its right and bottom edges); the widget's position and top-left corner remains unaffected.

Resizing a widget triggers the widget to immediately receive a GraphicsSceneResize event with the widget's old and new size. If the widget has a layout assigned when this event arrives, the layout will be activated and it will automatically update any child widget's geometry.

This property does not affect any layout of the parent widget. If the widget itself is managed by a parent layout; e.g., it has a parent widget with a layout assigned, that layout will not activate.

By default, this property contains a size with zero width and height.

See also

setGeometry(), QGraphicsSceneResizeEvent, QGraphicsLayout

This property holds the size policy for the widget.

See also

sizePolicy(), setSizePolicy(), QWidget::sizePolicy()

This property holds the widget's window flags. Window flags are a combination of a window type (e.g., Qt::Dialog) and several flags giving hints on the behavior of the window. The behavior is platform dependent. By default, this property contains no window flags.

Windows are panels. If you set the Qt::Window flag, the ItemIsPanel flag will be set automatically. If you clear the Qt::Window flag, the ItemIsPanel flag is also cleared. Note that the ItemIsPanel flag can be set independently of Qt::Window.

See also

isWindow(), isPanel()

This property holds this property holds the window title (caption). This property is only used for windows. By default, if no title has been set, this property contains an empty string.