vtkKWFavoriteDirectoriesFrame.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWFavoriteDirectoriesFrame.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 __vtkKWFavoriteDirectoriesFrame_h
#define __vtkKWFavoriteDirectoriesFrame_h

#include "vtkKWCompositeWidget.h"

class vtkKWPushButton;
class vtkKWToolbar;
class vtkKWFrameWithScrollbar;
class vtkKWFavoriteDirectoriesFrameInternals;
class vtkKWMenu;

class KWWidgets_EXPORT vtkKWFavoriteDirectoriesFrame : public vtkKWCompositeWidget
{
// @cond section_public
public:
  static vtkKWFavoriteDirectoriesFrame* New();
  vtkTypeRevisionMacro(vtkKWFavoriteDirectoriesFrame,vtkKWCompositeWidget);
  void PrintSelf(ostream& os, vtkIndent indent);
   
  virtual void AddFavoriteDirectory(const char *path, const char *name);


  virtual void SetFavoriteDirectoryPath(
    const char* oldpath, const char* newpath);
  virtual void SetFavoriteDirectoryName(
    const char* oldname, const char* newname);
  
  virtual void RemoveFavoriteDirectory(const char *path);
   

  virtual void SelectFavoriteDirectory(const char *path);
  virtual int IsFavoriteDirectorySelected(const char *path);
  
  virtual const char* GetSelectedFavoriteDirectory();

  virtual int HasFavoriteDirectory(const char* path);
  
  virtual int HasFavoriteDirectoryWithName(const char *name);


  virtual void SetMaximumNumberOfFavoriteDirectoriesInRegistry(int);
  vtkGetMacro(MaximumNumberOfFavoriteDirectoriesInRegistry, int);
  
  virtual void RestoreFavoriteDirectoriesFromRegistry();


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


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

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


  vtkGetObjectMacro(Toolbar, vtkKWToolbar);


  vtkSetMacro(UseSystemDefaultPlaces, int);
  vtkGetMacro(UseSystemDefaultPlaces, int);
  vtkBooleanMacro(UseSystemDefaultPlaces, int);
  //ETX


  vtkGetObjectMacro(AddFavoriteDirectoryButton, vtkKWPushButton);


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


  virtual void SelectFavoriteDirectoryCallback(
    const char* path, const char*name);
  virtual void PopupFavoriteDirectoryCallback(
    const char* path, int x, int y);
  
  virtual void RenameFavoriteDirectoryCallback(const char* path);
  
  virtual void ExploreFavoriteDirectoryCallback(const char* path);
  
  virtual void RemoveFavoriteDirectoryCallback(const char* path);

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

  virtual void CreateWidget();


  virtual const char* GetNameOfFavoriteDirectory(const char *path);
  virtual vtkKWPushButton* GetButtonOfFavoriteDirectoryWithName(
    const char *name);


  virtual void RestoreFavoriteDirectoriesFromSystemRegistry();
  virtual void RestoreFavoriteDirectoriesFromUserRegistry(
    const char *reg_key, int max_nb);
  virtual void WriteFavoriteDirectoriesToRegistry();
  virtual void WriteFavoriteDirectoriesToRegistry(
    const char *reg_key, int max_nb);
  virtual void WriteFavoriteDirectoriesToSystemRegistry();
  
  virtual void PruneFavoriteDirectoriesInRegistry();
  
  virtual int AddSpecialFavoriteFolder(int csidl);
      

  virtual void AddFavoriteDirectoryToFrame(
    const char *path,
    const char *name); 
  virtual void UpdateFavoriteDirectoryButton(
    vtkKWPushButton *button, const char *path, const char *name); 

  virtual void SelectFavoriteDirectoryWithName(const char* path);
  
  const char* GetSelectedFavoriteDirectoryWithName(const char* name);

  virtual void PopulateContextMenu(vtkKWMenu *menu, const char* path);

  virtual void ClearInternalList();

  virtual void ClearFavoriteDirectorySelection();


  vtkGetStringMacro(RegistryKey);
  vtkSetStringMacro(RegistryKey);
    

  char *AddFavoriteDirectoryCommand;
  char *FavoriteDirectorySelectedCommand;
  virtual void InvokeAddFavoriteDirectoryCommand();
  virtual void InvokeFavoriteDirectorySelectedCommand(
    const char* path, const char *name);
  
  vtkKWFavoriteDirectoriesFrameInternals *Internals;
  

  vtkKWToolbar            *Toolbar;
  vtkKWFrameWithScrollbar *ContainerFrame;
  vtkKWPushButton         *AddFavoriteDirectoryButton;
  vtkKWMenu               *ContextMenu;


  char *RegistryKey;
  int MaximumNumberOfFavoriteDirectoriesInRegistry;
  int UseSystemDefaultPlaces;
  
// @endcond
// @cond section_private
private:

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

---