interface/treebase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treebase.h
   3 // Purpose:     interface of wxTreeItemId
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxTreeItemId
  11     @wxheader{treebase.h}
  12
  13     An opaque reference to a tree item.
  14
  15     @library{wxcore}
  16     @category{FIXME}
  17
  18     @see wxTreeCtrl, wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl
  19     overview"
  20 */
  21 class wxTreeItemId
  22 {
  23 public:
  24     /**
  25         Default constructor. wxTreemItemIds are not meant to be constructed explicitly
  26         by
  27         the user; they are returned by the wxTreeCtrl functions instead.
  28     */
  29     wxTreeItemId();
  30
  31     /**
  32         Returns @true if this instance is referencing a valid tree item.
  33     */
  34     bool IsOk() const;
  35
  36     //@{
  37     /**
  38         Operators for comparison between wxTreeItemId objects.
  39     */
  40     void operator !() const;
  41     const bool operator ==(const wxTreeItemId& item) const;
  42     const bool operator !=(const wxTreeItemId& item) const;
  43     //@}
  44 };
  45