Object.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2011-2023 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave 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 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
 
#if ! defined (octave_Object_h)
#define octave_Object_h 1
 
#include <QObject>
 
#include "event-manager.h"
#include "graphics.h"
 
class QObject;
class QString;
class QWidget;
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
class base_qobject;
class interpreter;
 
class Container;
class ObjectProxy;
 
class Object : public QObject
{
  Q_OBJECT
 
public:
  Object (octave::base_qobject& qobj, octave::interpreter& interp,
          const graphics_object& go, QObject *obj = nullptr);
 
  virtual ~Object (void);
 
  base_properties& properties (void)
  { return object ().get_properties (); }
 
  const base_properties& properties (void) const
  { return object ().get_properties (); }
 
  template <typename T>
  typename T::properties& properties (void)
  {
    return dynamic_cast<typename T::properties&>
      (object ().get_properties ());
  }
 
  template <typename T>
  const typename T::properties& properties (void) const
  {
    return dynamic_cast<const typename T::properties&>
      (object ().get_properties ());
  }
 
  graphics_object object (void) const;
 
  virtual QObject * qObject (void) { return m_qobject; }
 
  template <typename T>
  T * qWidget (void) { return qobject_cast<T *>(qObject ()); }
 
  virtual Container * innerContainer (void) = 0;
 
  static Object * fromQObject (QObject *obj);
 
  virtual void do_connections (const QObject *receiver,
                               const QObject *emitter = nullptr);
 
signals:
 
  void interpreter_event (const octave::fcn_callback& fcn);
  void interpreter_event (const octave::meth_callback& meth);
 
  void gh_callback_event (const graphics_handle& h, const std::string& name);
 
  void gh_callback_event (const graphics_handle& h, const std::string& name,
                          const octave_value& data);
 
  void gh_set_event (const graphics_handle& h, const std::string& name,
                     const octave_value& value);
 
  void gh_set_event (const graphics_handle& h, const std::string& name,
                     const octave_value& value, bool notify_toolkit);
 
  void gh_set_event (const graphics_handle& h, const std::string& name,
                     const octave_value& value, bool notify_toolkit,
                     bool redraw_figure);
 
public slots:
  void slotUpdate (int pId);
  void slotFinalize (void);
  void slotRedraw (void);
  void slotShow (void);
  void slotPrint (const QString& file_cmd, const QString& term);
 
  void objectDestroyed (QObject *obj = nullptr);
 
protected:
  static Object *
  parentObject (octave::interpreter& interp, const graphics_object& go);
 
  void init (QObject *obj, bool callBase = false);
 
  virtual void update (int pId);
  virtual void finalize (void);
  virtual void redraw (void);
  virtual void show (void);
  virtual void print (const QString& file_cmd, const QString& term);
 
  virtual void beingDeleted (void);
 
protected:
 
  octave::base_qobject& m_octave_qobj;
  octave::interpreter& m_interpreter;
 
  // Store the graphics object directly so that it will exist when
  // we need it.  Previously, it was possible for the graphics
  // toolkit to get a handle to a figure, then have the interpreter
  // thread delete the corresponding object before the graphics
  // toolkit (GUI) thread had a chance to display it.  It should be OK
  // to store this object and use it in both threads (graphics_object
  // uses a std::shared_ptr) provided that we protect access with
  // mutex locks.
  graphics_object m_go;
 
  // Handle to the graphics object.  This may be redundant now.
  // Also, the whole ObjectProxy thing may not need to store a
  // pointer now?  Maybe we can just have a lookup table from figure
  // handle to Object?  What does the FLTK toolkit do?  Why does
  // this seem to be so complicated?
  graphics_handle m_handle;
 
  QObject *m_qobject;
};
 
OCTAVE_END_NAMESPACE(octave)
 
#endif