vtkKWDirectoryExplorer.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWDirectoryExplorer.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkKWDirectoryExplorer_h
#define __vtkKWDirectoryExplorer_h

#include "vtkKWCompositeWidget.h"

class vtkKWIcon;
class vtkKWToolbar;
class vtkKWPushButton;
class vtkKWTreeWithScrollbars;
class vtkKWPushButtonWithMenu;
class vtkKWMenu;
class vtkKWDirectoryExplorerInternals;

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

  virtual int OpenDirectory(const char* path);

  virtual int RenameDirectory(const char* currentname, const char* newname);
  
  virtual int DeleteDirectory(const char* dirname);


  virtual void SetSelectionMode(int);
  virtual void SetSelectionModeToSingle();
  virtual void SetSelectionModeToMultiple();
  
  virtual int HasSelection();


  virtual const char *GetSelectedDirectory()
    {return GetNthSelectedDirectory(0);}
  virtual int GetNumberOfSelectedDirectories();
  virtual const char *GetNthSelectedDirectory(int i);
  virtual void SelectDirectory(const char*);
  virtual void DeselectDirectory(const char*);
  virtual void ClearSelection();


  virtual void SetMaximumNumberOfDirectoriesInHistory(int);
  vtkGetMacro(MaximumNumberOfDirectoriesInHistory, int);


  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 SetTreeWidth(int);
  virtual int GetTreeWidth();
  virtual void SetTreeHeight(int);
  virtual int GetTreeHeight();


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


  virtual void SetDirectorySelectedCommand(vtkObject *obj, const char *method);
  virtual void SetDirectoryOpenedCommand(vtkObject *obj, const char *method);
  virtual void SetDirectoryClosedCommand(vtkObject *obj, const char *method);
  virtual void SetDirectoryCreatedCommand(vtkObject *obj, const char *method);
  virtual void SetDirectoryDeletedCommand(vtkObject *obj, const char *method);
  virtual void SetDirectoryRenamedCommand(vtkObject *obj, const char *method);


  enum
  {
    DirectorySelectedEvent = 10000,
    DirectoryOpenedEvent,
    DirectoryClosedEvent,
    DirectoryCreatedEvent,
    DirectoryDeletedEvent
  };
  //ETX


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


  vtkGetObjectMacro(Toolbar, vtkKWToolbar);


  vtkGetObjectMacro(CreateFolderButton, vtkKWPushButton);
  vtkGetObjectMacro(BackButton, vtkKWPushButtonWithMenu);
  vtkGetObjectMacro(ForwardButton, vtkKWPushButtonWithMenu);
  vtkGetObjectMacro(UpButton, vtkKWPushButton);


  virtual void AddBindingToInternalWidget(
    const char* event, vtkObject *obj, const char* method);


  virtual void OpenDirectoryNodeCallback(
    const char* node, int offsetFromCurrentIndex);
  
  virtual void SingleClickOnNodeCallback(const char* node);
   
  virtual void RightClickCallback( int x, int y, const char* node);
  
  virtual int RenameCallback();
  
  virtual void RightClickExploreCallback(const char*);

  virtual void TreeKeyNavigationCallback();
  
  virtual void DirectoryOpenedCallback(const char* node);

  virtual void DirectorySelectedCallback();

  virtual void DirectoryClosedCallback(const char* node);    
   
  virtual void CreateNewFolderCallback();
  
  virtual void BackToPreviousDirectoryCallback();
   
  virtual void ForwardToNextDirectoryCallback();
   
  virtual void GoUpDirectoryCallback();
  
  virtual int RemoveSelectedNodeCallback();

  virtual void LoadRootDirectoryCallback();


  virtual void UpdateEnableState();
  virtual void Update();

  virtual void ScrollToDirectory(const char* prefix);

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

  virtual void CreateWidget();
  
  virtual void LoadRootDirectory();
  
  virtual void BackToRoot();
  
  virtual void SelectDirectoryNode(const char* node, int opennode = 1);
     
  virtual const char* ReloadDirectory(const char* node, const char* path);
 

  virtual const char* ReloadDirectory(const char* parentnode, 
                                      const char* dirname,
                                      int select);
   

  virtual void OpenSubDirectory(const char* parentnode,
                                const char* fullname, 
                                int select = 1);
     

  virtual void OpenDirectoryNode(const char* node, 
                                 int select = 1,
                                 int opennode = 1);
  
  virtual void OpenWholeTree(const char* node);
  
  virtual void ReloadDirectoryNode(const char* node);
  
  virtual void UpdateDirectoryNode(const char* node);
  

  virtual void AddDirectoryNode(
    const char* parentnode, 
    const char* node, 
    const char* text, 
    const char* fullname, 
    vtkKWIcon *nodeicon);  
  
  const char *GetNthSelectedNode(int i);
  
  virtual void UpdateMostRecentDirectoryHistory(const char* node);
     
  virtual void PruneMostRecentDirectoriesInHistory();

  virtual void RemoveDirectoryFromHistory(const char* node);

  virtual void PopulateContextMenu(vtkKWMenu *menu, const char*);
  
  int IsNodeSelected(const char* node);

  const char* OpenDirectoryInternal(const char* dirname, int select);


  char *DirectorySelectedCommand;
  char *DirectoryOpenedCommand;
  char *DirectoryClosedCommand;
  char *DirectoryCreatedCommand;
  char *DirectoryDeletedCommand;
  char *DirectoryRenamedCommand;
  

  virtual void InvokeDirectorySelectedCommand(const char* path);
  virtual void InvokeDirectoryOpenedCommand(const char* path);
  virtual void InvokeDirectoryClosedCommand(const char* path);
  virtual void InvokeDirectoryCreatedCommand(const char* path);
  virtual void InvokeDirectoryDeletedCommand(const char* path);
  virtual void InvokeDirectoryRenamedCommand(
    const char* oldname, const char* newname);
                                          
  vtkKWDirectoryExplorerInternals *Internals;
  

  vtkKWToolbar            *Toolbar;
  vtkKWTreeWithScrollbars *DirectoryTree;
  vtkKWPushButton         *CreateFolderButton;
  vtkKWPushButtonWithMenu *BackButton;
  vtkKWPushButtonWithMenu *ForwardButton;
  vtkKWPushButton         *UpButton;
  vtkKWMenu               *ContextMenu;

  int  MaximumNumberOfDirectoriesInHistory;
  
// @endcond
// @cond section_private
private:

  static vtkIdType IdCounter;

  vtkKWDirectoryExplorer(const vtkKWDirectoryExplorer&); // Not implemented
  void operator=(const vtkKWDirectoryExplorer&); // Not implemented
};
#endif
// @endcond

---