interface/treebase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        treebase.h
   3 // Purpose:     documentation for wxTreeItemId class
   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     @seealso
  19     wxTreeCtrl, wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl
  20     overview"
  21 */
  22 class wxTreeItemId
  23 {
  24 public:
  25     /**
  26         Default constructor. wxTreemItemIds are not meant to be constructed explicitly
  27         by
  28         the user; they are returned by the wxTreeCtrl functions instead.
  29     */
  30     wxTreeItemId();
  31
  32     /**
  33         Returns @true if this instance is referencing a valid tree item.
  34     */
  35     bool IsOk() const;
  36
  37     //@{
  38     /**
  39         Operators for comparison between wxTreeItemId objects.
  40     */
  41     void operator !() const;
  42     const bool operator ==(const wxTreeItemId& item) const;
  43     const bool operator !=(const wxTreeItemId& item) const;
  44     //@}
  45 };