bgui/gadgets/TreeView/TVRemove.c

   1 /*
   2  * @(#) $Header$
   3  *
   4  * BGUI Tree List View class
   5  *
   6  * (C) Copyright 1999 Manuel Lemos.
   7  * (C) Copyright 1996-1999 Nick Christie.
   8  * All Rights Reserved.
   9  *
  10  * $Log$
  11  * Revision 42.2  2004/06/16 20:16:49  verhaegs
  12  * Use METHODPROTO, METHOD_END and REGFUNCPROTOn where needed.
  13  *
  14  * Revision 42.1  2000/05/15 19:29:08  stegerg
  15  * replacements for REG macro
  16  *
  17  * Revision 42.0  2000/05/09 22:21:58  mlemos
  18  * Bumped to revision 42.0 before handing BGUI to AROS team
  19  *
  20  * Revision 41.11  2000/05/09 20:35:45  mlemos
  21  * Bumped to revision 41.11
  22  *
  23  * Revision 1.2  2000/05/09 20:00:42  mlemos
  24  * Merged with the branch Manuel_Lemos_fixes.
  25  *
  26  * Revision 1.1.2.2  1999/05/31 01:12:54  mlemos
  27  * Made the method functions take the arguments in the apropriate registers.
  28  *
  29  * Revision 1.1.2.1  1999/02/21 04:07:58  mlemos
  30  * Nick Christie sources.
  31  *
  32  *
  33  *
  34  */
  35
  36 /************************************************************************
  37 ***********************  TREEVIEW CLASS: REMOVE  ************************
  38 ************************************************************************/
  39
  40 /************************************************************************
  41 ******************************  INCLUDES  *******************************
  42 ************************************************************************/
  43
  44 #include "TreeViewPrivate.h"
  45 #include "TVUtil.h"
  46
  47 /************************************************************************
  48 **************************  LOCAL DEFINITIONS  **************************
  49 ************************************************************************/
  50
  51
  52 /************************************************************************
  53 *************************  EXTERNAL REFERENCES  *************************
  54 ************************************************************************/
  55
  56 /*
  57  * Functions from TVUtil are listed in TVUtil.h
  58  */
  59
  60 /************************************************************************
  61 *****************************  PROTOTYPES  ******************************
  62 ************************************************************************/
  63
  64
  65 /************************************************************************
  66 *****************************  LOCAL DATA  ******************************
  67 ************************************************************************/
  68
  69
  70 /************************************************************************
  71 *****************************  TV_REMOVE()  *****************************
  72 *************************************************************************
  73 * Remove one or more entries from the treeview. In the message structure
  74 * for this method, the user supplies a reference to an entry, a code to
  75 * indicate which entries to affect and some flags that allow further
  76 * conditions, eg. removing only selected entries. This method returns
  77 * the number of entries removed if successful, zero on failure.
  78 *
  79 * Special values allowed for the reference entry are:
  80 *       TV_ROOT                 to represent the root of the tree (a dummy entry).
  81 *       TV_SELECTED             for the (first) currently selected entry.
  82 *
  83 * If the relation entry is TV_SELECTED, but no entry is currently
  84 * selected, nothing is done and zero is returned.
  85 *
  86 * Permitted values for the relationship code are as follows:
  87 *       TVW_ENTRY                               specified entry only
  88 *       TVW_PARENT                              parent of entry
  89 *       TVW_CHILD_FIRST                 first child of entry
  90 *       TVW_CHILD_LAST                  last child of entry
  91 *       TVW_CHILD_ALL                   all children of entry
  92 *       TVW_SIBLING_FIRST               first sibling of entry
  93 *       TVW_SIBLING_LAST                last sibling of entry
  94 *       TVW_SIBLING_NEXT                next sibling of entry
  95 *       TVW_SIBLING_PREV                prev. sibling of entry
  96 *       TVW_SIBLING_ALL                 entry and all siblings
  97 *       TVW_TREE_NEXT                   next in tree from entry
  98 *       TVW_TREE_PREV                   prev. in tree from entry
  99 *
 100 * If the relation entry is TV_ROOT, only the TVW_CHILD_??? codes are
 101 * permitted. When you remove an entry, all of its children are
 102 * automatically removed first. To remove all entries in the treeview
 103 * you are better off using the TVM_CLEAR method.
 104 *
 105 * Permitted bits for the flags parameter are:
 106 *       TVF_SELECTED                    affect only selected entries
 107 *       TVF_VISIBLE                             affect only visible entries
 108 *
 109 *************************************************************************/
 110
 111 METHOD(TV_Remove, struct tvEntry *, tve)
 112 {
 113 struct tvAnchor tva;
 114 TVData                  *tv;
 115 TNPTR                   pn,tn,tn2;
 116 ULONG                   rc;
 117 ULONG                   refreshmethod;
 118
 119 TV_DebugDumpMethod((Msg) tve);
 120
 121 tv = (TVData *) INST_DATA(cl,obj);
 122 rc = 0;
 123 memset(&tva,0,sizeof(tva));
 124 refreshmethod = 0;
 125
 126 /*
 127  * Find each treenode corresponding to this tvEntry.
 128  */
 129
 130 tn2 = TV_MatchNextEntry(tv,tve->tve_Entry,tve->tve_Which,tve->tve_Flags,&tva);
 131
 132 while((tn = tn2))               /* assign and test */
 133         {
 134         /*
 135          * Find next match now, before we remove this one
 136          */
 137
 138         tn2 = TV_MatchNextEntry(tv,tve->tve_Entry,tve->tve_Which,tve->tve_Flags,&tva);
 139
 140         /*
 141          * Recurse down child nodes of this entry, removing each.
 142          */
 143
 144         while (HasChildren(tn))
 145                 rc += DoMethod(obj,TVM_REMOVE,NULL,FirstChildOf(tn),TVW_ENTRY,TVF_INTERNAL);
 146
 147         /*
 148          * If it's displayed in the listview, remove it
 149          */
 150
 151         if (TV_IsDisplayed(tn))
 152                 {
 153                 DoMethod(tv->tv_Listview,LVM_REMENTRY,NULL,tn);
 154                 refreshmethod = TVM_REFRESH;
 155                 }
 156
 157         /*
 158          * Now remove the entry from the tree
 159          */
 160
 161         if ((pn = ParentOf(tn)))
 162                 pn->tn_NumChildren--;
 163         tv->tv_NumEntries--;
 164         Remove((NODEPTR) tn);
 165         TV_FreeTreeNode(tv,tn);
 166         rc++;
 167
 168         /*
 169          * If tv_NoLeafImage is set and this was the last child of its
 170          * parent, we need to refresh in order for the parent's image
 171          * to be changed.
 172          */
 173
 174         if (tv->tv_NoLeafImage && pn && !HasChildren(pn))
 175                 refreshmethod = TVM_REFRESH;
 176
 177         } /* endwhile match another entry */
 178
 179 if (refreshmethod)
 180         {
 181         /*
 182          * Refresh the listview:
 183          */
 184
 185         if (tve->tve_GInfo)
 186                 DoMethod(obj,refreshmethod,tve->tve_GInfo);
 187         }
 188
 189 return(rc);
 190 }
 191 METHOD_END
 192