property.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef PROPERTY_H
#define PROPERTY_H

#include <string>

#include <QObject>
#include <QIcon>
#include <QVariant>

#include "rviz/config.h"
#include "rviz/rviz_export.h"

class QModelIndex;
class QPainter;
class QStyleOptionViewItem;

namespace rviz
{
class PropertyTreeModel;

class RVIZ_EXPORT Property : public QObject
{
  Q_OBJECT
public:
  Property(const QString& name = QString(),
           const QVariant default_value = QVariant(),
           const QString& description = QString(),
           Property* parent = nullptr,
           const char* changed_slot = nullptr,
           QObject* receiver = nullptr);

  ~Property() override;

  virtual void removeChildren(int start_index = 0, int count = -1);

  virtual bool setValue(const QVariant& new_value);

  virtual QVariant getValue() const;

  virtual void setName(const QString& name);

  virtual QString getName() const;

  std::string getNameStd() const
  {
    return getName().toStdString();
  }

  virtual void setDescription(const QString& description);

  virtual QString getDescription() const;

  virtual void setIcon(const QIcon& icon)
  {
    icon_ = icon;
  }

  virtual QIcon getIcon() const
  {
    return icon_;
  }

  virtual Property* subProp(const QString& sub_name);

  virtual int numChildren() const
  {
    return children_.size();
  }

  Property* childAt(int index) const;

  virtual Property* childAtUnchecked(int index) const;

  bool contains(Property* possible_child) const;

  Property* getParent() const;

  void setParent(Property* new_parent);

  virtual QVariant getViewData(int column, int role) const;

  virtual Qt::ItemFlags getViewFlags(int column) const;

  virtual bool paint(QPainter* painter, const QStyleOptionViewItem& option) const
  {
    (void)painter;
    (void)option;
    return false;
  }


  virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option);

  bool isAncestorOf(Property* possible_child) const;

  Property* takeChild(Property* child);

  virtual Property* takeChildAt(int index);

  virtual void addChild(Property* child, int index = -1);

  void insertChildSorted(Property* child);

  void setModel(PropertyTreeModel* model);

  PropertyTreeModel* getModel() const
  {
    return model_;
  }

  int rowNumberInParent() const;

  virtual void moveChild(int from_index, int to_index);

  virtual void load(const Config& config);

  virtual void save(Config config) const;

  bool shouldBeSaved() const
  {
    return !is_read_only_ && save_;
  }

  void setShouldBeSaved(bool save)
  {
    save_ = save;
  }

  virtual bool getDisableChildren();

  void hide()
  {
    setHidden(true);
  }

  void show()
  {
    setHidden(false);
  }

  virtual void setHidden(bool hidden);

  virtual bool getHidden() const
  {
    return hidden_;
  }

  virtual void setReadOnly(bool read_only)
  {
    is_read_only_ = read_only;
  }

  virtual bool getReadOnly()
  {
    return is_read_only_;
  }

  virtual void collapse();

  virtual void expand();

Q_SIGNALS:
  void aboutToChange();
  void changed();

  void childListChanged(Property* this_property);

protected:
  void loadValue(const Config& config);

  QVariant value_;

  PropertyTreeModel* model_;

  bool child_indexes_valid_;

  QIcon icon_;

private:
  void reindexChildren();

  Property* parent_;
  QList<Property*> children_;
  QString description_;
  bool hidden_;

  static Property* failprop_;

  int row_number_within_parent_;
  bool is_read_only_;
  bool save_;
};

} // end namespace rviz

#endif // PROPERTY_H