vtkKWSelectionFrame.h

Go to the documentation of this file.

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

  Module:    $RCSfile: vtkKWSelectionFrame.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 __vtkKWSelectionFrame_h
#define __vtkKWSelectionFrame_h

#include "vtkKWCompositeWidget.h"

class vtkKWFrame;
class vtkKWLabel;
class vtkKWMenuButton;
class vtkKWPushButton;
class vtkKWSelectionFrameInternals;
class vtkKWToolbarSet;
class vtkStringArray;

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

  virtual void SetTitle(const char *title);
  virtual const char* GetTitle();


  virtual void SetSelected(int);
  vtkGetMacro(Selected, int);
  vtkBooleanMacro(Selected, int);


  virtual void SetSelectionList(int num, const char **list);
  virtual void SetSelectionList(vtkStringArray *list);
  vtkGetObjectMacro(SelectionListMenuButton, vtkKWMenuButton);

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


  virtual void SetSelectionListVisibility(int);
  vtkGetMacro(SelectionListVisibility, int);
  vtkBooleanMacro(SelectionListVisibility, int);


  virtual void SetAllowClose(int);
  vtkGetMacro(AllowClose, int);
  vtkBooleanMacro(AllowClose, int);
  vtkGetObjectMacro(CloseButton, vtkKWPushButton);

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

  virtual void Close();


  virtual void SetAllowChangeTitle(int);
  vtkGetMacro(AllowChangeTitle, int);
  vtkBooleanMacro(AllowChangeTitle, int);

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

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

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

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


  vtkGetVector3Macro(TitleColor, double);
  virtual void SetTitleColor(double r, double g, double b);
  virtual void SetTitleColor(double rgb[3])
    { this->SetTitleColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(TitleSelectedColor, double);
  virtual void SetTitleSelectedColor(double r, double g, double b);
  virtual void SetTitleSelectedColor(double rgb[3])
    { this->SetTitleSelectedColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(TitleBackgroundColor, double);
  virtual void SetTitleBackgroundColor(double r, double g, double b);
  virtual void SetTitleBackgroundColor(double rgb[3])
    { this->SetTitleBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(TitleSelectedBackgroundColor, double);
  virtual void SetTitleSelectedBackgroundColor(double r, double g, double b);
  virtual void SetTitleSelectedBackgroundColor(double rgb[3])
    { this->SetTitleSelectedBackgroundColor(rgb[0], rgb[1], rgb[2]); };
  

  virtual void SetTitleBarVisibility(int);
  vtkGetMacro(TitleBarVisibility, int);
  vtkBooleanMacro(TitleBarVisibility, int);


  virtual vtkKWToolbarSet* GetToolbarSet();
  virtual void SetToolbarSetVisibility(int);
  vtkGetMacro(ToolbarSetVisibility, int);
  vtkBooleanMacro(ToolbarSetVisibility, int);

  virtual vtkKWFrame* GetTitleBarUserFrame();


  vtkGetObjectMacro(BodyFrame, vtkKWFrame);
  

  virtual vtkKWFrame* GetLeftUserFrame();
  virtual void SetLeftUserFrameVisibility(int);
  vtkGetMacro(LeftUserFrameVisibility, int);
  vtkBooleanMacro(LeftUserFrameVisibility, int);


  virtual vtkKWFrame* GetRightUserFrame();
  virtual void SetRightUserFrameVisibility(int);
  vtkGetMacro(RightUserFrameVisibility, int);
  vtkBooleanMacro(RightUserFrameVisibility, int);


  virtual void SetOuterSelectionFrameWidth(int);
  vtkGetMacro(OuterSelectionFrameWidth, int);
  vtkGetVector3Macro(OuterSelectionFrameColor, double);
  virtual void SetOuterSelectionFrameColor(double r, double g, double b);
  virtual void SetOuterSelectionFrameColor(double rgb[3])
    { this->SetOuterSelectionFrameColor(rgb[0], rgb[1], rgb[2]); };
  vtkGetVector3Macro(OuterSelectionFrameSelectedColor, double);
  virtual void SetOuterSelectionFrameSelectedColor(
    double r, double g, double b);
  virtual void SetOuterSelectionFrameSelectedColor(double rgb[3])
    { this->SetOuterSelectionFrameSelectedColor(rgb[0], rgb[1], rgb[2]); };


  virtual void SetOuterSelectionFrameBlinking(int);
  vtkGetMacro(OuterSelectionFrameBlinking, int);
  vtkBooleanMacro(OuterSelectionFrameBlinking, int);
  
  virtual void UpdateEnableState();


  virtual void CloseCallback();
  virtual void SelectionListCallback(const char *menuItem);
  virtual void SelectCallback();
  virtual void DoubleClickCallback();
  virtual void ChangeTitleCallback();
  virtual void OuterSelectionFrameBlinkingCallback();
  
// @endcond
// @cond section_protected
protected:
  vtkKWSelectionFrame();
  ~vtkKWSelectionFrame();
  
  virtual void CreateWidget();
  
  vtkKWFrame      *OuterSelectionFrame;
  vtkKWFrame      *TitleBarFrame;
  vtkKWMenuButton *SelectionListMenuButton;
  vtkKWPushButton *CloseButton;
  vtkKWLabel      *TitleLabel;
  vtkKWFrame      *BodyFrame;

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

  virtual int SetColor(double *color, double r, double g, double b);
  virtual void UpdateSelectedAspect();
  virtual void UpdateOuterSelectionFrameColor();
  virtual void UpdateSelectionListMenuButton();

  double TitleColor[3];
  double TitleSelectedColor[3];
  double TitleBackgroundColor[3];
  double TitleSelectedBackgroundColor[3];

  double OuterSelectionFrameColor[3];
  double OuterSelectionFrameSelectedColor[3];

  char *SelectionListCommand;
  char *CloseCommand;
  char *SelectCommand;
  char *DoubleClickCommand;
  char *ChangeTitleCommand;
  char *TitleChangedCommand;
  virtual void InvokeSelectionListCommand(const char*, vtkKWSelectionFrame*);
  virtual void InvokeCloseCommand(vtkKWSelectionFrame *obj);
  virtual void InvokeSelectCommand(vtkKWSelectionFrame *obj);
  virtual void InvokeDoubleClickCommand(vtkKWSelectionFrame *obj);
  virtual void InvokeChangeTitleCommand(vtkKWSelectionFrame *obj);
  virtual void InvokeTitleChangedCommand(vtkKWSelectionFrame *obj);

  int Selected;
  int SelectionListVisibility;
  int AllowClose;
  int AllowChangeTitle;
  int ToolbarSetVisibility;
  int LeftUserFrameVisibility;
  int RightUserFrameVisibility;
  int TitleBarVisibility;
  int OuterSelectionFrameWidth;
  int OuterSelectionFrameBlinking;

  virtual void CreateOuterSelectionFrameBlinkingTimer();
  virtual void CancelOuterSelectionFrameBlinkingTimer();

  // PIMPL Encapsulation for STL containers

  vtkKWSelectionFrameInternals *Internals;

// @endcond
// @cond section_private
private:

  vtkKWToolbarSet *ToolbarSet;
  vtkKWFrame      *LeftUserFrame;
  vtkKWFrame      *RightUserFrame;
  vtkKWFrame      *TitleBarUserFrame;

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

#endif

// @endcond

---