qgsattributeformwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsattributeformwidget.h
    ---------------------
    begin                : November 2017
    copyright            : (C) 2017 by Matthias Kuhn
    email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSATTRIBUTEFORMWIDGET_H
#define QGSATTRIBUTEFORMWIDGET_H
 
#include "qgis_sip.h"
#include "qgis_gui.h"
#include "qgsattributeeditorcontext.h"
#include "qgssearchwidgetwrapper.h"
 
#include <QWidget>
#include <QVariant>
 
class QgsAttributeForm;
class QStackedWidget;
class QgsSearchWidgetToolButton;
 
class GUI_EXPORT QgsAttributeFormWidget : public QWidget // SIP_ABSTRACT
{
    Q_OBJECT
 
  public:
 
    enum Mode
    {
      DefaultMode, 
      MultiEditMode, 
      SearchMode, 
      AggregateSearchMode, 
    };
 
    explicit QgsAttributeFormWidget( QgsWidgetWrapper *widget, QgsAttributeForm *form );
 
    ~QgsAttributeFormWidget() override;
 
    virtual void createSearchWidgetWrappers( const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext() ) = 0;
 
    virtual QString currentFilterExpression() const;
 
 
    void setMode( Mode mode );
 
    Mode mode() const { return mMode; }
 
    QgsVectorLayer *layer();
 
    QgsAttributeForm *form() const;
 
    QWidget *searchWidgetFrame() SIP_SKIP;
 
 
    void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
 
    void addAdditionalSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper );
 
    QList< QgsSearchWidgetWrapper * > searchWidgetWrappers();
 
    void resetSearch();
 
    bool searchWidgetToolButtonVisible() const;
 
    void setSearchWidgetToolButtonVisible( bool searchWidgetToolButtonVisible );
 
  protected:
 
    QWidget *editPage() const SIP_SKIP;
 
    QStackedWidget *stack() const SIP_SKIP;
 
    QWidget *searchPage() const SIP_SKIP;
 
    void setVisiblePageForMode( QgsAttributeFormWidget::Mode mode );
 
  private slots:
 
    void searchWidgetFlagsChanged( QgsSearchWidgetWrapper::FilterFlags flags );
 
  private:
    virtual void updateWidgets();
    QgsAttributeFormWidget::Mode mMode = DefaultMode;
    QgsSearchWidgetToolButton *mSearchWidgetToolButton = nullptr;
    QWidget *mEditPage = nullptr;
    QWidget *mSearchPage = nullptr;
    QStackedWidget *mStack = nullptr;
    QWidget *mSearchFrame = nullptr;
    QgsAttributeForm *mForm = nullptr;
    QList< QgsSearchWidgetWrapper * > mSearchWidgets;
    QgsWidgetWrapper *mWidget = nullptr;
};
 
#endif // QGSATTRIBUTEFORMWIDGET_H