Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdesdk@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 206 insertions, 0 deletions

diff --git a/kcachegrind/kcachegrind/traceitemview.h b/kcachegrind/kcachegrind/traceitemview.h
new file mode 100644
index 00000000..e74a009c
--- /dev/null
+++ b/kcachegrind/kcachegrind/traceitemview.h
@@ -0,0 +1,206 @@
+/* This file is part of KCachegrind.
+   Copyright (C) 2003 Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
+
+   KCachegrind 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, version 2.
+
+   This program 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 this program; see the file COPYING.  If not, write to
+   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+   Boston, MA 02111-1307, USA.
+*/
+
+/*
+ * Trace Item View
+ */
+
+#ifndef TRACEITEMVIEW_H
+#define TRACEITEMVIEW_H
+
+#include "tracedata.h"
+
+class QWidget;
+class QPopupMenu;
+
+class KConfig;
+class KConfigGroup;
+class KConfigBase;
+
+class TopLevel;
+
+/**
+ * Abstract Base Class for KCachegrind Views
+ *
+ * This class delivers the shared functionality of all KCachegrind
+ * Views for one TraceItem (like Function, Object...), the "active"
+ * item. Additional view attributes are current primary cost type,
+ * an optional secondary cost type, group type,
+ * and possibly a selected costitem in this view.
+ * Note that there is a difference in changing the selected item of
+ * a view (this usually changes selection in other views, too), and
+ * activating that item.
+ */
+class TraceItemView
+{
+public:
+
+  /**
+   * Change type for update functions
+   * - <dataChanged> is used if e.g. cycles are recalculated
+   */
+  enum { nothingChanged      = 0,
+	 costTypeChanged     = 1,
+	 costType2Changed    = 2,
+	 groupTypeChanged    = 4,
+	 partsChanged        = 8,
+	 activeItemChanged   = 16,
+	 selectedItemChanged = 32,
+	 dataChanged         = 64,
+	 configChanged       = 128 };
+
+  enum Direction { None, Back, Forward, Up };
+
+  // a TraceItemView can have a position in a parent container
+  enum Position { Hidden, Top, Right, Left, Bottom };
+
+  TraceItemView(TraceItemView* parentView, TopLevel* top = 0);
+  virtual ~TraceItemView() {}
+
+  virtual QString whatsThis() const;
+
+  static KConfigGroup* configGroup(KConfig*, QString prefix, QString postfix);
+  static void writeConfigEntry(KConfigBase*, const char* pKey, QString value,
+                               const char* def, bool bNLS = false);
+  static void writeConfigEntry(KConfigBase*, const char* pKey,
+                               int value, int def);
+  static void writeConfigEntry(KConfigBase*, const char* pKey,
+                               bool value, bool def);
+  static void writeConfigEntry(KConfigBase*, const char* pKey,
+                               double value, double def);
+  virtual void readViewConfig(KConfig*, QString prefix, QString postfix,
+			      bool withOptions);
+  virtual void saveViewConfig(KConfig*, QString prefix, QString postfix,
+			      bool withOptions);
+
+  // Immediate remove all references to old data, and set the new.
+  // This resets the visualization state.
+  // A GUI update has to be triggered with updateView().
+  // Overwrite in container views to also set new data for all members.
+  virtual void setData(TraceData* d);
+
+  // change from parent, call updateView() to update lazily (only if visible)
+  void setCostType(TraceCostType* t) { _newCostType = t; }
+  void setCostType2(TraceCostType* t) { _newCostType2 = t; }
+  void set(TraceItem::CostType g) { _newGroupType = g; }
+  void set(const TracePartList& l) { _newPartList = l; }
+  // returns false if nothing can be shown for this trace item
+  bool activate(TraceItem* i);
+  void select(TraceItem* i);
+  void notifyChange(int changeType) { _status |= changeType; }
+  // all in one
+  bool set(int, TraceData*, TraceCostType*, TraceCostType*,
+	   TraceItem::CostType, const TracePartList&,
+	   TraceItem*, TraceItem*);
+
+  // general update request, call if view is/gets visible
+  void updateView(bool force = false);
+
+  /**
+   * Notification from child views.
+   * Default implementation notifies parent
+   */
+  virtual void selected(TraceItemView* sender, TraceItem*);
+  virtual void selected(TraceItemView* sender, const TracePartList&);
+  virtual void activated(TraceItemView* sender, Direction);
+  virtual void selectedCostType(TraceItemView* sender, TraceCostType*);
+  virtual void selectedCostType2(TraceItemView* sender, TraceCostType*);
+  virtual void activated(TraceItemView* sender, TraceItem*);
+
+  // getters...
+  // always get the newest values
+  TraceData* data() const { return _newData; }
+  TraceItem* activeItem() const { return _newActiveItem; }
+  TraceItem* selectedItem() const { return _newSelectedItem; }
+  TraceCostType* costType() const { return _newCostType; }
+  TraceCostType* costType2() const { return _newCostType2; }
+  TraceItem::CostType groupType() const { return _newGroupType; }
+  const TracePartList& partList() const { return _newPartList; }
+
+  TraceFunction* activeFunction();
+  int status() const { return _status; }
+
+  // pointer to top level window to e.g. show status messages
+  void setTopLevel(TopLevel* t) { _topLevel = t; }
+  TopLevel* topLevel() const { return _topLevel; }
+
+  void setPosition(Position p) { _pos = p; }
+  Position position() const { return _pos; }
+
+  void setTitle(QString t) { _title = t; }
+  QString title() const { return _title; }
+
+  // We depend on derived class to be a widget.
+  // Force overiding by making this abstract.
+  virtual QWidget* widget() = 0;
+
+  /**
+   * This function is called when a new item should become active.
+   * Reimplement this in subclasses.
+   *
+   * Returns the real item to become active. You can call select() here.
+   * Return 0 if nothing can be shown.
+   * Use the methods like data() instead of _data here, as
+   * _data possibly will give old/wrong information.
+   */
+  virtual TraceItem* canShow(TraceItem* i) { return i; }
+
+  /* convenience functions for often used context menu items */
+  void addCostMenu(QPopupMenu*,bool withCost2 = true);
+  void addGoMenu(QPopupMenu*);
+
+protected:
+  // helpers to call selected()/activated() of parentView
+  void selected(TraceItem*);
+  void selected(const TracePartList&);
+  void activated(TraceItem*);
+  void selectedCostType(TraceCostType*);
+  void selectedCostType2(TraceCostType*);
+  void activated(Direction);
+
+  /* Is this view visible?
+   * if not, doUpdate() won't be called by updateView()
+   */
+  virtual bool isViewVisible();
+
+  // update handler (to be reimplemented)
+  virtual void doUpdate(int changeType);
+
+  TraceItemView* _parentView;
+  TopLevel* _topLevel;
+
+  TraceData* _data;
+  TracePartList _partList;
+  TraceItem *_activeItem, *_selectedItem;
+  TraceCostType *_costType, *_costType2;
+  TraceItem::CostType _groupType;
+
+private:
+  TraceData* _newData;
+  TracePartList _newPartList;
+  TraceItem *_newActiveItem, *_newSelectedItem;
+  TraceCostType *_newCostType, *_newCostType2;
+  TraceItem::CostType _newGroupType;
+
+  QString _title;
+  int _status;
+  bool _inUpdate;
+  Position _pos;
+};
+
+#endif