vtkKWIcon Class Reference

simple wrapper for icons More...

#include <vtkKWIcon.h>

List of all members.

[NOHEADER]
enum	{ ImageOptionFlipVertical = 1 }
void	SetImage (const unsigned char *data, int width, int height, int pixel_size, unsigned long buffer_length=0, int options=0)
Public Types
enum	{   IconNoIcon = 0, IconBoundingBox = 13, IconColorBarAnnotation = 12, IconConnection = 1,   IconCornerAnnotation = 11, IconDocument = 9, IconEmpty16x16 = 6, IconEmpty1x1 = 10,   IconError = 2, IconErrorMini = 3, IconErrorRedMini = 4, IconExpand = 5,   IconFileOpen = 8, IconFloppy = 7, IconFolder = 20, IconFolderOpen = 21,   IconGridLinear = 40, IconGridLog = 41, IconHeaderAnnotation = 50, IconHelpBubble = 60,   IconInfoMini = 61, IconLock = 62, IconMagGlass = 63, IconMinus = 64,   IconMove = 80, IconMoveH = 81, IconMoveV = 82, IconOrientationCubeAnnotation = 83,   IconPanHand = 99, IconPlus = 100, IconPointFinger = 90, IconPresetAdd = 94,   IconPresetApply = 95, IconPresetDelete = 96, IconPresetUpdate = 97, IconQuestion = 101,   IconReload = 102, IconRotate = 105, IconScaleBarAnnotation = 106, IconSideAnnotation = 110,   IconShrink = 103, IconStopwatch = 104, IconTransportBeginning = 120, IconTransportEnd = 121,   IconTransportFastForward = 122, IconTransportFastForwardToKey = 123, IconTransportLoop = 124, IconTransportPause = 125,   IconTransportPlay = 126, IconTransportPlayToKey = 127, IconTransportRewind = 128, IconTransportRewindToKey = 129,   IconTransportStop = 130, IconTrashcan = 131, IconTreeClose = 150, IconTreeOpen = 151,   IconWarning = 170, IconWarningMini = 171, IconWindowLevel = 172, LastIcon }
Public Member Functions
	vtkTypeRevisionMacro (vtkKWIcon, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetImage (int image)
void	SetImage (vtkKWIcon *)
const unsigned char *	GetData ()
virtual void	Fade (double factor)
virtual void	Flatten (double r, double g, double b)
virtual int	GetWidth ()
virtual int	GetHeight ()
virtual int	GetPixelSize ()
Static Public Member Functions
vtkKWIcon *	New ()
Protected Member Functions
	vtkKWIcon ()
	~vtkKWIcon ()
void	SetData (const unsigned char *data, int width, int height, int pixel_size, int options=0)
Protected Attributes
unsigned char *	Data
int	Width
int	Height
int	PixelSize

---

Detailed Description

simple wrapper for icons

A simple icon wrapper. It can either be used with file KWIcons.h to provide a unified interface for internal icons or a wrapper for custom icons. The icons are defined with width, height, pixel_size, and array of unsigned char values.

Definition at line 32 of file vtkKWIcon.h.

---

Member Enumeration Documentation

anonymous enum

There are several predefined icons in the Resources/KWIcons.h. Since we want to save space, we only include that file to vtkKWIcons.cxx. These constants specify different icons. Enumeration values: IconNoIcon  IconBoundingBox  IconColorBarAnnotation  IconConnection  IconCornerAnnotation  IconDocument  IconEmpty16x16  IconEmpty1x1  IconError  IconErrorMini  IconErrorRedMini  IconExpand  IconFileOpen  IconFloppy  IconFolder  IconFolderOpen  IconGridLinear  IconGridLog  IconHeaderAnnotation  IconHelpBubble  IconInfoMini  IconLock  IconMagGlass  IconMinus  IconMove  IconMoveH  IconMoveV  IconOrientationCubeAnnotation  IconPanHand  IconPlus  IconPointFinger  IconPresetAdd  IconPresetApply  IconPresetDelete  IconPresetUpdate  IconQuestion  IconReload  IconRotate  IconScaleBarAnnotation  IconSideAnnotation  IconShrink  IconStopwatch  IconTransportBeginning  IconTransportEnd  IconTransportFastForward  IconTransportFastForwardToKey  IconTransportLoop  IconTransportPause  IconTransportPlay  IconTransportPlayToKey  IconTransportRewind  IconTransportRewindToKey  IconTransportStop  IconTrashcan  IconTreeClose  IconTreeOpen  IconWarning  IconWarningMini  IconWindowLevel  LastIcon  Definition at line 44 of file vtkKWIcon.h.

anonymous enum

Set image data from pixel data, eventually zlib and base64. If 'buffer_length' is 0, compute it automatically by multiplying 'pixel_size', 'width' and 'height' together. If ImageOptionFlipVertical is set in 'option', flip the image vertically BTX Enumeration values: ImageOptionFlipVertical  Definition at line 121 of file vtkKWIcon.h.

---

Constructor & Destructor Documentation

vtkKWIcon::vtkKWIcon (   )  [protected]

vtkKWIcon::~vtkKWIcon (   )  [protected]

---

Member Function Documentation

vtkKWIcon* vtkKWIcon::New (   )  [static]

vtkKWIcon::vtkTypeRevisionMacro (  vtkKWIcon  , vtkObject  )

void vtkKWIcon::PrintSelf (  ostream &  os, vtkIndent  indent )

void vtkKWIcon::SetImage (  int  image  )

Select an icon based on the icon name.

void vtkKWIcon::SetImage (  vtkKWIcon *   )

Set image data from another vtkKWIcon.

void vtkKWIcon::SetImage (  const unsigned char *  data, int  width, int  height, int  pixel_size, unsigned long  buffer_length = 0, int  options = 0 )

Set image data from pixel data, eventually zlib and base64. If 'buffer_length' is 0, compute it automatically by multiplying 'pixel_size', 'width' and 'height' together. If ImageOptionFlipVertical is set in 'option', flip the image vertically BTX

const unsigned char* vtkKWIcon::GetData (   )

Get the raw image data.

virtual int vtkKWIcon::GetWidth (   )  [virtual]

Get the width of the image.

virtual int vtkKWIcon::GetHeight (   )  [virtual]

Get the height of the image.

virtual int vtkKWIcon::GetPixelSize (   )  [virtual]

Get the pixel size of the image.

virtual void vtkKWIcon::Fade (  double  factor  )  [virtual]

Fade the icon by a factor. If the icon has an alpha channel, this multiplies each element in the alpha channel by 'factor'.

virtual void vtkKWIcon::Flatten (  double  r, double  g, double  b )  [virtual]

Flatten the image against a color. If the icon has an alpha channel, this blends the image against a 'r', 'g', 'b' background and discards the alpha channel.

void vtkKWIcon::SetData (  const unsigned char *  data, int  width, int  height, int  pixel_size, int  options = 0 )  [protected]

Set icon to the custom data.

---

Member Data Documentation

unsigned char* vtkKWIcon::Data [protected]

Definition at line 172 of file vtkKWIcon.h.

int vtkKWIcon::Width [protected]

Definition at line 173 of file vtkKWIcon.h.

int vtkKWIcon::Height [protected]

Definition at line 174 of file vtkKWIcon.h.

int vtkKWIcon::PixelSize [protected]

Definition at line 175 of file vtkKWIcon.h.

---

The documentation for this class was generated from the following file:

• GUI/Widgets/vtkKWIcon.h

---