vtkKWFileBrowserWidget.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWFileBrowserWidget.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 __vtkKWFileBrowserWidget_h
#define __vtkKWFileBrowserWidget_h

#include "vtkKWCompositeWidget.h"

class vtkKWFavoriteDirectoriesFrame;
class vtkKWDirectoryExplorer;
class vtkKWFileListTable;
class vtkKWFrame;
class vtkKWSplitFrame;
class vtkKWFileBrowserWidgetInternals;

class KWWidgets_EXPORT vtkKWFileBrowserWidget : public vtkKWCompositeWidget
{
// @cond section_public
public:
  static vtkKWFileBrowserWidget* New();
  vtkTypeRevisionMacro(vtkKWFileBrowserWidget,vtkKWCompositeWidget);
  void PrintSelf(ostream& os, vtkIndent indent);
  
  virtual int OpenDirectory(const char* path);
  
  virtual void FilterFilesByExtensions(const char* fileextensions);


  vtkGetObjectMacro(DirectoryExplorer, vtkKWDirectoryExplorer);
  vtkGetObjectMacro(FileListTable, vtkKWFileListTable);
  vtkGetObjectMacro(FavoriteDirectoriesFrame, vtkKWFavoriteDirectoriesFrame);
  vtkGetObjectMacro(MainFrame, vtkKWSplitFrame);
  vtkGetObjectMacro(DirFileFrame, vtkKWSplitFrame);


  virtual void SetDirectoryExplorerVisibility(int);
  vtkBooleanMacro(DirectoryExplorerVisibility, int); 
  vtkGetMacro(DirectoryExplorerVisibility, int); 
  

  virtual void SetFavoriteDirectoriesFrameVisibility(int);
  vtkBooleanMacro(FavoriteDirectoriesFrameVisibility, int); 
  vtkGetMacro(FavoriteDirectoriesFrameVisibility, int); 
  

  virtual void SetFileListTableVisibility(int);
  vtkBooleanMacro(FileListTableVisibility, int); 
  vtkGetMacro(FileListTableVisibility, int); 


  virtual void SetMultipleSelection(int);
  vtkBooleanMacro(MultipleSelection, int);
  vtkGetMacro(MultipleSelection, int);
  

  vtkGetVector3Macro(SelectionForegroundColor, double);
  virtual void SetSelectionForegroundColor(double r, double g, double b);
  virtual void SetSelectionForegroundColor(double rgb[3])
    { this->SetSelectionForegroundColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(SelectionBackgroundColor, double);
  virtual void SetSelectionBackgroundColor(double r, double g, double b);
  virtual void SetSelectionBackgroundColor(double rgb[3])
    { this->SetSelectionBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(OutOfFocusSelectionForegroundColor, double);
  virtual void SetOutOfFocusSelectionForegroundColor(
    double r, double g, double b);
  virtual void SetOutOfFocusSelectionForegroundColor(double rgb[3])
    { this->SetOutOfFocusSelectionForegroundColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(OutOfFocusSelectionBackgroundColor, double);
  virtual void SetOutOfFocusSelectionBackgroundColor(
    double r, double g, double b);
  virtual void SetOutOfFocusSelectionBackgroundColor(double rgb[3])
    { this->SetOutOfFocusSelectionBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void SetFocusToDirectoryExplorer();
  virtual void SetFocusToFileListTable();

  virtual void AddFavoriteDirectoryCallback();
 

  virtual void FavoriteDirectorySelectedCallback(
    const char* path, 
    const char* text);
  

  virtual void DirectoryCreatedCallback(const char* fullname);
  virtual void DirectorySelectedCallback(const char* fullname);
  virtual void DirectoryOpenedCallback(const char* fullname);
  virtual void DirectoryClosedCallback(const char* fullname);
  virtual void DirectoryDeletedCallback(const char* fullname);
  virtual void DirectoryRenamedCallback(
    const char* oldname, 
    const char* newname);
  

  virtual void FileSelectionChangedCallback(const char* fullname);
  virtual void FileDoubleClickedCallback(const char* fullname);
  virtual void FileRenamedCallback(
    const char* oldname, 
    const char* newname);
  virtual void FolderCreatedCallback(const char* filename);
  virtual void FileDeletedCallback(const char* fullname, int isDir);


  virtual void DirectoryTreeFocusInCallback();
  virtual void FileTableFocusInCallback();
  virtual void DirectoryTreeFocusOutCallback();
  virtual void FileTableFocusOutCallback();
  
  virtual void UpdateEnableState();


  virtual void SetWidth(int);
  virtual int GetWidth();
  virtual void SetHeight(int);
  virtual int GetHeight();
  
// @endcond
// @cond section_protected
protected:
  vtkKWFileBrowserWidget();
  ~vtkKWFileBrowserWidget();

  virtual void CreateWidget();
  
  virtual void Pack();
  

  virtual void CreateFavoriteDirectoriesFrame();
  virtual void CreateDirectoryExplorerAndFileListTableFrame();
  virtual void CreateDirectoryExplorer();
  virtual void CreateFileListTable();


  virtual void UpdateDirectorySelectionColor(int infocus = 0);
  virtual void UpdateFileSelectionColor(int infocus = 0);
  
  virtual void UpdateForCurrentDirectory();
  virtual void PropagateMultipleSelection();

  vtkKWFileBrowserWidgetInternals *Internals;
  

  vtkKWSplitFrame  *MainFrame;
  vtkKWSplitFrame  *DirFileFrame;
 

  vtkKWFavoriteDirectoriesFrame *FavoriteDirectoriesFrame;
  vtkKWDirectoryExplorer        *DirectoryExplorer;
  vtkKWFileListTable            *FileListTable;


  int DirectoryExplorerVisibility;
  int FavoriteDirectoriesFrameVisibility;
  int FileListTableVisibility;
  int MultipleSelection;


  double SelectionForegroundColor[3];
  double SelectionBackgroundColor[3];
  double OutOfFocusSelectionForegroundColor[3];
  double OutOfFocusSelectionBackgroundColor[3];

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

#endif
// @endcond

---