Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Address review
  • Loading branch information
nyalldawson committed Apr 22, 2023
1 parent 538cf4c commit 30870df
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions python/gui/auto_generated/history/qgshistoryentrynode.sip.in
Expand Up @@ -51,6 +51,8 @@ Returns a HTML formatted text string which should be shown to a user when
selecting the node.

Subclasses should implement this method or :py:func:`~QgsHistoryEntryNode.createWidget`, but not both.

.. seealso:: :py:func:`createWidget`
%End

virtual QWidget *createWidget( const QgsHistoryWidgetContext &context ) /Factory/;
Expand All @@ -59,6 +61,8 @@ Returns a new widget which should be shown to users when selecting the node.

If a ``None`` is returned, the node's :py:func:`~QgsHistoryEntryNode.html` method will be called instead to
create the node's content.

.. seealso:: :py:func:`html`
%End


Expand Down
2 changes: 1 addition & 1 deletion src/gui/history/qgshistoryentrynode.cpp
@@ -1,7 +1,7 @@
/***************************************************************************
qgshistoryentrynode.cpp
--------------------------
begin : Aprial 2023
begin : April 2023
copyright : (C) 2023 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
Expand Down
6 changes: 5 additions & 1 deletion src/gui/history/qgshistoryentrynode.h
@@ -1,7 +1,7 @@
/***************************************************************************
qgshistoryentrynode.h
--------------------------
begin : Aprial 2023
begin : April 2023
copyright : (C) 2023 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
Expand Down Expand Up @@ -72,6 +72,8 @@ class GUI_EXPORT QgsHistoryEntryNode
* selecting the node.
*
* Subclasses should implement this method or createWidget(), but not both.
*
* \see createWidget()
*/
virtual QString html( const QgsHistoryWidgetContext &context ) const;

Expand All @@ -80,6 +82,8 @@ class GUI_EXPORT QgsHistoryEntryNode
*
* If a NULLPTR is returned, the node's html() method will be called instead to
* create the node's content.
*
* \see html()
*/
virtual QWidget *createWidget( const QgsHistoryWidgetContext &context ) SIP_FACTORY;

Expand Down

0 comments on commit 30870df

Please sign in to comment.