GUI/Widgets/vtkKWPresetSelector.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWPresetSelector.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 __vtkKWPresetSelector_h
#define __vtkKWPresetSelector_h

#include "vtkKWCompositeWidget.h"

class vtkImageData;
class vtkKWIcon;
class vtkKWMultiColumnListWithScrollbars;
class vtkKWPresetSelectorInternals;
class vtkKWPushButtonSet;
class vtkKWSpinButtons;
class vtkRenderWindow;

class KWWIDGETS_EXPORT vtkKWPresetSelector : public vtkKWCompositeWidget
{
public:
  static vtkKWPresetSelector* New();
  vtkTypeRevisionMacro(vtkKWPresetSelector, vtkKWCompositeWidget);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual void Create(vtkKWApplication *app);
  
  virtual int AddPreset();

  virtual int HasPreset(int id);


  virtual int SetPresetGroup(int id, const char *group);
  virtual const char* GetPresetGroup(int id);


  virtual void SetGroupColumnVisibility(int);
  virtual int GetGroupColumnVisibility();
  vtkBooleanMacro(GroupColumnVisibility, int);


  virtual void SetGroupColumnTitle(const char *);
  virtual const char* GetGroupColumnTitle();


  virtual void SetGroupFilter(const char *group);
  vtkGetStringMacro(GroupFilter);


  virtual int SetPresetComment(int id, const char *comment);
  virtual const char* GetPresetComment(int id);


  virtual void SetCommentColumnVisibility(int);
  virtual int GetCommentColumnVisibility();
  vtkBooleanMacro(CommentColumnVisibility, int);


  virtual int SetPresetFileName(int id, const char *filename);
  virtual const char* GetPresetFileName(int id);

  virtual double GetPresetCreationTime(int id);


  virtual int SetPresetImage(int id, vtkImageData *image);
  virtual int SetPresetImageFromRenderWindow(int id, vtkRenderWindow *win);
  virtual vtkKWIcon* GetPresetThumbnail(int id);
  virtual vtkKWIcon* GetPresetScreenshot(int id);


  virtual void SetThumbnailColumnVisibility(int);
  virtual int GetThumbnailColumnVisibility();
  vtkBooleanMacro(ThumbnailColumnVisibility, int);


  vtkSetClampMacro(ThumbnailSize,int,8,512);
  vtkGetMacro(ThumbnailSize,int);


  vtkSetClampMacro(ScreenshotSize,int,8,2048);
  vtkGetMacro(ScreenshotSize,int);


  virtual int HasPresetUserSlot(
    int id, const char *slot_name);
  virtual int SetPresetUserSlotAsDouble(
    int id, const char *slot_name, double value);
  virtual double GetPresetUserSlotAsDouble(
    int id, const char *slot_name);
  virtual int SetPresetUserSlotAsInt(
    int id, const char *slot_name, int value);
  virtual int GetPresetUserSlotAsInt(
    int id, const char *slot_name);
  virtual int SetPresetUserSlotAsString(
    int id, const char *slot_name, const char *value);
  virtual const char* GetPresetUserSlotAsString(
    int id, const char *slot_name);
  virtual int SetPresetUserSlotAsPointer(
    int id, const char *slot_name, void *ptr);
  virtual void* GetPresetUserSlotAsPointer(
    int id, const char *slot_name);


  virtual int GetNumberOfPresets();
  virtual int GetNumberOfPresetsWithGroup(const char *group);
  virtual int GetNumberOfVisiblePresets();


  virtual int GetNthPresetId(int index);
  virtual int GetNthPresetWithGroupId(int index, const char *group);


  virtual int GetPresetAtRowId(int row_index);
  virtual int GetPresetRow(int id);

  virtual int GetNthPresetWithGroupRank(int index, const char *group);


  virtual int RemovePreset(int id);
  virtual int RemoveAllPresets();
  virtual int RemoveAllPresetsWithGroup(const char *group);


  virtual void SetListHeight(int);
  virtual int GetListHeight();


  virtual void SetSelectSpinButtonsVisibility(int);
  vtkGetMacro(SelectSpinButtonsVisibility,int);
  vtkBooleanMacro(SelectSpinButtonsVisibility,int);

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

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

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


  virtual void SetApplyPresetOnSelection(int);
  vtkGetMacro(ApplyPresetOnSelection,int);
  vtkBooleanMacro(ApplyPresetOnSelection,int);

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


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


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

  virtual void Update();

  virtual void UpdateEnableState();


  virtual void PresetAddCallback();
  virtual void PresetApplyCallback();
  virtual void PresetUpdateCallback();
  virtual void PresetRemoveCallback();
  virtual void PresetSelectionCallback();
  virtual void PresetSelectPreviousCallback();
  virtual void PresetSelectNextCallback();

  virtual void PresetCellThumbnailCallback(const char*, int, int, const char*);


  virtual const char* PresetCellEditStartCallback(
    int row, int col, const char *text);


  virtual const char* PresetCellEditEndCallback(
    int row, int col, const char *text);

  virtual void PresetCellUpdatedCallback(int row, int col, const char *text);


  static const char *IdColumnName;
  static const char *ThumbnailColumnName;
  static const char *GroupColumnName;
  static const char *CommentColumnName;
  //ETX

protected:
  vtkKWPresetSelector();
  ~vtkKWPresetSelector();

  virtual void CreateColumns();

  virtual void DeAllocatePreset(int vtkNotUsed(id)) {};

  virtual int UpdatePresetRow(int id);

  vtkKWMultiColumnListWithScrollbars *PresetList;
  vtkKWFrame                         *PresetControlFrame;
  vtkKWSpinButtons                   *PresetSelectSpinButtons;
  vtkKWPushButtonSet                 *PresetButtons;

  int ApplyPresetOnSelection;
  int SelectSpinButtonsVisibility;

  int ThumbnailSize;
  int ScreenshotSize;
  int PromptBeforeRemovePreset;

  char* GroupFilter;

  virtual void NumberOfPresetsHasChanged();

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

  virtual void UpdateRowsInPresetList();

  char *PresetAddCommand;
  virtual void InvokePresetAddCommand();

  char *PresetUpdateCommand;
  virtual void InvokePresetUpdateCommand(int id);

  char *PresetApplyCommand;
  virtual void InvokePresetApplyCommand(int id);

  char *PresetRemoveCommand;
  virtual int InvokePresetRemoveCommand(int id);

  char *PresetHasChangedCommand;
  virtual void InvokePresetHasChangedCommand(int id);


  virtual int GetIdColumnIndex();
  virtual int GetThumbnailColumnIndex();
  virtual int GetGroupColumnIndex();
  virtual int GetCommentColumnIndex();

  virtual void Pack();

  virtual void SetDefaultHelpStrings();


  static int AddButtonId;
  static int ApplyButtonId;
  static int RemoveButtonId;
  static int UpdateButtonId;
  //ETX

private:

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

#endif

---