vtkKWTree.h

Go to the documentation of this file.

/*=========================================================================

Copyright (c) 1998-2003 Kitware Inc. 469 Clifton Corporate Parkway,
Clifton Park, NY, 12065, USA.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * Neither the name of Kitware nor the names of any contributors may be used
   to endorse or promote products derived from this software without specific
   prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
#ifndef __vtkKWTree_h
#define __vtkKWTree_h

#include "vtkKWCoreWidget.h"

class vtkKWTreeInternals;

class KWWidgets_EXPORT vtkKWTree : public vtkKWCoreWidget
{
// @cond section_public
public:
  static vtkKWTree* New();
  vtkTypeRevisionMacro(vtkKWTree,vtkKWCoreWidget);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual void AddNode(const char *parent, const char *node, const char *text);
  
  virtual void DeleteNode(const char *node);


  virtual const char* GetNodeText(const char *node);
  virtual void SetNodeText(const char *node, const char *text);


  virtual int GetNodeSelectableFlag(const char *node);
  virtual void SetNodeSelectableFlag(const char *node, int flag);


  virtual const char* GetNodeFont(const char *node);
  virtual void SetNodeFont(const char *node, const char *font);


  virtual void SetNodeFontWeightToBold(const char *node);
  virtual void SetNodeFontWeightToNormal(const char *node);
  virtual void SetNodeFontSlantToItalic(const char *node);
  virtual void SetNodeFontSlantToRoman(const char *node);


  virtual const char* GetNodeUserData(const char *node);
  virtual void SetNodeUserData(const char *node, const char *data);
  virtual int GetNodeUserDataAsInt(const char *node);
  virtual void SetNodeUserDataAsInt(const char *node, int);

  virtual int HasNode(const char *node);

  virtual void DeleteAllNodes();
  
  virtual void DeleteNodeChildren(const char *node);
  
  virtual const char* GetNodeChildren(const char *node);

  virtual const char* GetNodeParent(const char *node);

  virtual int IsNodeAncestor(const char *ancestor, const char *node);

  virtual void MoveNode(const char *node, const char *new_parent, int pos);


  virtual const char* FindNodeWithUserData(
    const char *parent, const char *data);
  virtual const char* FindNodeWithUserDataAsInt(
    const char *parent, int data);


  virtual void SetSelectionMode(int);
  vtkGetMacro(SelectionMode, int);
  virtual void SetSelectionModeToSingle();
  virtual void SetSelectionModeToMultiple();


  virtual void SelectNode(const char *node);
  virtual void DeselectNode(const char *node);

  virtual void SelectSingleNode(const char *node);

  virtual void ClearSelection();

  virtual const char* GetSelection();

  virtual int HasSelection();


  virtual void SelectNodeChildren(const char *node);
  virtual void DeselectNodeChildren(const char *node);

  virtual void SeeNode(const char *node);


  virtual void OpenNode(const char *node);
  virtual void CloseNode(const char *node);
  virtual int IsNodeOpen(const char *node);


  virtual void OpenFirstNode();
  virtual void CloseFirstNode();


  virtual void OpenTree(const char *node);
  virtual void CloseTree(const char *node);


  vtkBooleanMacro(EnableReparenting, int);
  vtkGetMacro(EnableReparenting, int);
  virtual void SetEnableReparenting(int);


  virtual void SetWidth(int);
  virtual int GetWidth();
  virtual void SetHeight(int);
  virtual int GetHeight();


  virtual void SetNodeImageToIcon(const char *node, vtkKWIcon *icon);
  virtual void SetNodeImageToPredefinedIcon(const char *node, int icon_index);
  virtual void SetNodeImageToPixels(const char *node,
    const unsigned char *pixels, int width, int height, int pixel_size,
    unsigned long buffer_length = 0);
  

  virtual void SetNodeWindow(const char *node, vtkKWWidget *w);
  virtual vtkKWWidget* GetNodeWindow(const char *node);

  virtual void DeleteAllNodeWindows(const char *parent);


  virtual void SetNodePadX(const char *node, int);
  virtual int GetNodePadX(const char *node);


  vtkBooleanMacro(RedrawOnIdle, int);
  virtual void SetRedrawOnIdle(int);
  virtual int GetRedrawOnIdle();


  vtkBooleanMacro(LinesVisibility, int);
  virtual void SetLinesVisibility(int);
  virtual int GetLinesVisibility();


  vtkBooleanMacro(SelectionFill, int);
  virtual void SetSelectionFill(int);
  virtual int GetSelectionFill();


  virtual void GetBackgroundColor(double *r, double *g, double *b);
  virtual double* GetBackgroundColor();
  virtual void SetBackgroundColor(double r, double g, double b);
  virtual void SetBackgroundColor(double rgb[3])
    { this->SetBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void SetHighlightThickness(int);
  virtual int GetHighlightThickness();
  

  virtual void SetBorderWidth(int);
  virtual int GetBorderWidth();
  

  virtual void SetRelief(int);
  virtual int GetRelief();
  virtual void SetReliefToRaised();
  virtual void SetReliefToSunken();
  virtual void SetReliefToFlat();
  virtual void SetReliefToRidge();
  virtual void SetReliefToSolid();
  virtual void SetReliefToGroove();


  virtual void SetPadX(int);
  virtual int GetPadX();


  virtual void SetDeltaX(int);
  virtual int GetDeltaX();


  virtual void SetDeltaY(int);
  virtual int GetDeltaY();


  virtual void GetSelectionBackgroundColor(double *r, double *g, double *b);
  virtual double* GetSelectionBackgroundColor();
  virtual void SetSelectionBackgroundColor(double r, double g, double b);
  virtual void SetSelectionBackgroundColor(double rgb[3])
    { this->SetSelectionBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  virtual void GetSelectionForegroundColor(double *r, double *g, double *b);
  virtual double* GetSelectionForegroundColor();
  virtual void SetSelectionForegroundColor(double r, double g, double b);
  virtual void SetSelectionForegroundColor(double rgb[3])
    { this->SetSelectionForegroundColor(rgb[0], rgb[1], rgb[2]); };
  
  virtual void SetOpenCommand(vtkObject *object, const char *method);

  virtual void SetCloseCommand(vtkObject *object, const char *method);
  

  virtual void SetBinding(
    const char *event, vtkObject *object, const char *method);
  virtual void SetBinding(
    const char *event, const char *command);
  virtual void AddBinding(
    const char *event, vtkObject *object, const char *method);
  virtual void AddBinding(
    const char *event, const char *command);
  virtual void RemoveBinding(const char *event);
  virtual void RemoveBinding(
    const char *event, vtkObject *object, const char *method);


  virtual void SetBindText(
    const char *event, vtkObject *object, const char *method);


  virtual void SetDoubleClickOnNodeCommand(
    vtkObject *object, const char *method);
  virtual void SetSingleClickOnNodeCommand(
    vtkObject *object, const char *method);
  virtual void SetRightClickOnNodeCommand(
    vtkObject *object, const char *method);
  

  virtual void SetSelectionChangedCommand(
    vtkObject *object, const char *method);
  

  virtual void SetNodeParentChangedCommand(
    vtkObject *object, const char *method);
  

  enum
  {
    SelectionChangedEvent = 10000,
    RightClickOnNodeEvent,
    NodeParentChangedEvent
  };
  //ETX

  virtual void UpdateEnableState();


  vtkBooleanMacro(UseRawNodeText, int);
  vtkGetMacro(UseRawNodeText, int);
  vtkSetMacro(UseRawNodeText, int);


  vtkBooleanMacro(UseRawNodeUserData, int);
  vtkGetMacro(UseRawNodeUserData, int);
  vtkSetMacro(UseRawNodeUserData, int);


  virtual void Focus();
  virtual int HasFocus();


  virtual void SelectionCallback();
  virtual void RightClickOnNodeCallback(const char *node);
  virtual void KeyNavigationCallback(const char* key);
  virtual void DropOverNodeCallback(const char*, const char*, const char*, const char*, const char*, const char*);

  virtual void DisplayChildNodes(const char* node);

// @endcond
// @cond section_protected
protected:
  vtkKWTree();
  ~vtkKWTree();

  virtual void CreateWidget();
  
  int SelectionMode;
  int EnableReparenting;
  int UseRawNodeUserData;
  int UseRawNodeText;

  char *SelectionChangedCommand;
  virtual void InvokeSelectionChangedCommand();
  
  char *NodeParentChangedCommand;
  virtual void InvokeNodeParentChangedCommand(
    const char *node, const char *new_parent, const char *previous_parent);

  virtual void UpdateDragAndDrop();

  // PIMPL Encapsulation for STL containers
  //BTX
  vtkKWTreeInternals *Internals;
  //ETX

// @endcond
// @cond section_private
private:
  vtkKWTree(const vtkKWTree&); // Not implemented
  void operator=(const vtkKWTree&); // Not implemented
};

#endif
// @endcond

---