vtkKWMostRecentFilesManager.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWMostRecentFilesManager.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 __vtkKWMostRecentFilesManager_h
#define __vtkKWMostRecentFilesManager_h

#include "vtkKWObject.h"

class vtkKWMostRecentFilesManagerInternals;
class vtkKWMenu;

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


  virtual void AddFile(
    const char *filename, 
    vtkObject *target_object = NULL, 
    const char *target_command = NULL,
    const char *label = NULL);
  

  virtual int GetNumberOfFiles();
  virtual const char* GetNthFileName(int idx);
  virtual vtkObject* GetNthTargetObject(int idx);
  virtual const char* GetNthTargetCommand(int idx);
  virtual const char* GetNthLabel(int idx);


  vtkGetObjectMacro(DefaultTargetObject, vtkObject);
  virtual void SetDefaultTargetObject(vtkObject *object);
  vtkGetStringMacro(DefaultTargetCommand);
  virtual void SetDefaultTargetCommand(const char *);


  virtual void RestoreFilesListFromRegistry();
  virtual void SaveFilesToRegistry();
  virtual void RestoreFilesListFromRegistry(
    const char *reg_key, int max_nb);
  virtual void SaveFilesToRegistry(
    const char *reg_key, int max_nb);


  vtkGetStringMacro(RegistryKey);
  vtkSetStringMacro(RegistryKey);


  vtkGetMacro(MaximumNumberOfFilesInRegistry, int);
  vtkSetMacro(MaximumNumberOfFilesInRegistry, int);

  vtkKWMenu* GetMenu();


  vtkGetMacro(MaximumNumberOfFilesInMenu, int);
  virtual void SetMaximumNumberOfFilesInMenu(int);

  virtual void SetFileLabel(const char *filename, const char *label);


  virtual void SetLabelVisibilityInMenu(int);
  vtkBooleanMacro(LabelVisibilityInMenu, int);
  vtkGetMacro(LabelVisibilityInMenu, int);


  virtual void SetBaseNameVisibilityInMenu(int);
  vtkBooleanMacro(BaseNameVisibilityInMenu, int);
  vtkGetMacro(BaseNameVisibilityInMenu, int);


  virtual void SetSeparatePathInMenu(int);
  vtkBooleanMacro(SeparatePathInMenu, int);
  vtkGetMacro(SeparatePathInMenu, int);

  virtual void UpdateMenuStateInParent();

  virtual void PopulateMenu(vtkKWMenu*, int max_nb);


  enum
  {
    MenuHasChangedEvent = 24000
  };
  //ETX

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

  char        *DefaultTargetCommand;
  vtkObject   *DefaultTargetObject;
  char        *RegistryKey;
  int         MaximumNumberOfFilesInRegistry;
  int         MaximumNumberOfFilesInMenu;
  int         LabelVisibilityInMenu;
  int         BaseNameVisibilityInMenu;
  int         SeparatePathInMenu;

  //BTX

  // PIMPL Encapsulation for STL containers

  vtkKWMostRecentFilesManagerInternals *Internals;
  friend class vtkKWMostRecentFilesManagerInternals;

  //ETX


  virtual void AddFileInternal(
    const char *filename, 
    vtkObject *target_object = NULL, 
    const char *target_command = NULL,
    const char *label = NULL);

  virtual void UpdateMenu();

// @endcond
// @cond section_private
private:
  
  // In private for lazy allocation using GetMenu()

  vtkKWMenu *Menu;

  vtkKWMostRecentFilesManager(const vtkKWMostRecentFilesManager&); // Not implemented
  void operator=(const vtkKWMostRecentFilesManager&); // Not implemented
};

#endif

// @endcond

---