vtkKWStartupPageWidget.h

Go to the documentation of this file.

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

  Module:    vtkKWStartupPageWidget.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 __vtkKWStartupPageWidget_h
#define __vtkKWStartupPageWidget_h

#include "vtkKWCompositeWidget.h"

class vtkKWCanvas;
class vtkKWLabel;
class vtkKWIcon;
class vtkKWStartupPageWidgetInternals;
class vtkKWMostRecentFilesManager;

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


  vtkGetVector3Macro(GradientColor1, double);
  virtual void SetGradientColor1(double r, double g, double b);
  virtual void SetGradientColor1(double rgb[3])
    { this->SetGradientColor1(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(GradientColor2, double);
  virtual void SetGradientColor2(double r, double g, double b);
  virtual void SetGradientColor2(double rgb[3])
    { this->SetGradientColor2(rgb[0], rgb[1], rgb[2]); };


  vtkGetVector3Macro(TextColor, double);
  virtual void SetTextColor(double r, double g, double b);
  virtual void SetTextColor(double rgb[3])
    { this->SetTextColor(rgb[0], rgb[1], rgb[2]); };


  vtkGetMacro(TextSize, int);
  virtual void SetTextSize(int);


  vtkGetVector3Macro(SelectedTextColor, double);
  virtual void SetSelectedTextColor(double r, double g, double b);
  virtual void SetSelectedTextColor(double rgb[3])
    { this->SetSelectedTextColor(rgb[0], rgb[1], rgb[2]); };


  vtkGetVector3Macro(HintColor, double);
  virtual void SetHintColor(double r, double g, double b);
  virtual void SetHintColor(double rgb[3])
    { this->SetHintColor(rgb[0], rgb[1], rgb[2]); };


  vtkGetMacro(HintSize, int);
  virtual void SetHintSize(int);


  virtual void SetAddShadowToHint(int);
  vtkGetMacro(AddShadowToHint, int);
  vtkBooleanMacro(AddShadowToHint, int);
  

  virtual void SetSupportOpen(int);
  vtkGetMacro(SupportOpen, int);
  vtkBooleanMacro(SupportOpen, int);


  vtkGetObjectMacro(OpenIcon, vtkKWIcon);
  virtual void SetOpenIcon(vtkKWIcon*);
  virtual void SetOpenIconToPredefinedIcon(int icon_index);


  virtual void SetSupportDoubleClick(int);
  vtkGetMacro(SupportDoubleClick, int);
  vtkBooleanMacro(SupportDoubleClick, int);
  

  vtkGetObjectMacro(DoubleClickIcon, vtkKWIcon);
  virtual void SetDoubleClickIcon(vtkKWIcon*);
  virtual void SetDoubleClickIconToPredefinedIcon(int icon_index);


  virtual void SetSupportDrop(int);
  vtkGetMacro(SupportDrop, int);
  vtkBooleanMacro(SupportDrop, int);
  

  vtkGetObjectMacro(DropIcon, vtkKWIcon);
  virtual void SetDropIcon(vtkKWIcon*);
  virtual void SetDropIconToPredefinedIcon(int icon_index);


  virtual void SetSupportMostRecentFiles(int);
  vtkGetMacro(SupportMostRecentFiles, int);
  vtkBooleanMacro(SupportMostRecentFiles, int);
  

  vtkGetObjectMacro(MostRecentFilesIcon, vtkKWIcon);
  virtual void SetMostRecentFilesIcon(vtkKWIcon*);
  virtual void SetMostRecentFilesIconToPredefinedIcon(int icon_index);


  vtkGetObjectMacro(MostRecentFileIcon, vtkKWIcon);
  virtual void SetMostRecentFileIcon(vtkKWIcon*);
  virtual void SetMostRecentFileIconToPredefinedIcon(int icon_index);


  vtkGetMacro(MostRecentFileSize, int);
  virtual void SetMostRecentFileSize(int);


  vtkGetObjectMacro(MostRecentFilesManager, vtkKWMostRecentFilesManager);
  virtual void SetMostRecentFilesManager(vtkKWMostRecentFilesManager *mgr);


  vtkGetMacro(MaximumNumberOfMostRecentFiles, int);
  virtual void SetMaximumNumberOfMostRecentFiles(int);


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


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


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


  vtkGetObjectMacro(StartupPageCanvas, vtkKWCanvas);

  virtual void Update();

  virtual void UpdateEnableState();


  virtual void ConfigureCallback();
  virtual void RedrawCallback();
  virtual void HighlightSectionCallback(const char *tag, int flag);
  virtual void OpenCallback();
  virtual void DoubleClickCallback();


  virtual void AddCallbackCommandObservers();
  virtual void RemoveCallbackCommandObservers();

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

  virtual void CreateWidget();

  double GradientColor1[3];
  double GradientColor2[3];
  double TextColor[3];
  double SelectedTextColor[3];
  double HintColor[3];

  int TextSize;
  int HintSize;
  int MostRecentFileSize;

  int    SupportOpen;
  int    SupportDoubleClick;
  int    SupportDrop;
  int    SupportMostRecentFiles;

  int    MaximumNumberOfMostRecentFiles;
  int    AddShadowToHint;

  vtkKWIcon *OpenIcon;
  vtkKWIcon *DoubleClickIcon;
  vtkKWIcon *DropIcon;
  vtkKWIcon *MostRecentFilesIcon;
  vtkKWIcon *MostRecentFileIcon;

  // Recent files manager

  vtkKWMostRecentFilesManager *MostRecentFilesManager;

  // Commands

  char *OpenCommand;
  char *DropCommand;
  char *DoubleClickCommand;

  // GUI

  vtkKWCanvas *StartupPageCanvas;


  virtual void Bind();
  virtual void UnBind();


  virtual void Redraw();
  virtual void ScheduleRedraw();


  virtual void UpdateInternalCanvasBindings();
  virtual void UpdateInternalCanvasColors();
  virtual void UpdateInternalCanvasFonts();
  virtual void UpdateInternalCanvasIcons();


  virtual void AddSectionToCanvas(
    ostream &tk_cmd, 
    int x, int y, 
    vtkKWIcon *icon,
    const char *text, const char *text_font, 
    const char *hint, const char *hint_font, 
    vtkObject *object, const char *method,
    const char *tag, const char *extra_tag = NULL);

  virtual void AddMostRecentFilesSectionToCanvas(
    ostream &tk_cmd, 
    int x, int y);


  virtual void InvokeOpenCommand();
  virtual void InvokeDoubleClickCommand();

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


  virtual void ProcessCallbackCommandEvents(
    vtkObject *caller, unsigned long event, void *calldata);

  virtual int GetHorizontalIncrementFromIcon(vtkKWIcon *icon);
  
// @endcond
// @cond section_private
private:
  vtkKWStartupPageWidget(const vtkKWStartupPageWidget&); // Not implemented
  void operator=(const vtkKWStartupPageWidget&); // Not implemented
};

#endif

// @endcond

---