Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkKWTkUtilities Class Reference

class that supports basic Tk functions More...

#include <vtkKWTkUtilities.h>

List of all members.

[NOHEADER]

enum  { UpdatePhotoOptionFlipVertical = 1 }
int UpdatePhoto (Tcl_Interp *interp, const char *photo_name, const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0, int update_options=0)
int UpdatePhoto (vtkKWApplication *app, const char *photo_name, const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0, int update_options=0)

Public Types


Public Member Functions

 vtkTypeRevisionMacro (vtkKWTkUtilities, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions

vtkKWTkUtilities * New ()
const char * GetTclNameFromPointer (Tcl_Interp *interp, vtkObject *obj)
const char * GetTclNameFromPointer (vtkKWApplication *app, vtkObject *obj)
const char * EvaluateString (Tcl_Interp *interp, const char *format,...)
const char * EvaluateString (vtkKWApplication *app, const char *format,...)
const char * EvaluateStringFromArgs (Tcl_Interp *interp, const char *format, va_list var_args1, va_list var_args2)
const char * EvaluateStringFromArgs (vtkKWApplication *app, const char *format, va_list var_args1, va_list var_args2)
const char * EvaluateSimpleString (Tcl_Interp *interp, const char *str)
const char * EvaluateSimpleString (vtkKWApplication *app, const char *str)
void GetRGBColor (Tcl_Interp *interp, const char *widget, const char *color, double *r, double *g, double *b)
void GetRGBColor (vtkKWWidget *widget, const char *color, double *r, double *g, double *b)
void GetOptionColor (Tcl_Interp *interp, const char *widget, const char *option, double *r, double *g, double *b)
void GetOptionColor (vtkKWWidget *widget, const char *option, double *r, double *g, double *b)
double * GetOptionColor (vtkKWWidget *widget, const char *option)
void SetOptionColor (Tcl_Interp *interp, const char *widget, const char *option, double r, double g, double b)
void SetOptionColor (vtkKWWidget *widget, const char *option, double r, double g, double b)
int QueryUserForColor (Tcl_Interp *interp, const char *dialog_parent, const char *dialog_title, double in_r, double in_g, double in_b, double *out_r, double *out_g, double *out_b)
int QueryUserForColor (vtkKWApplication *app, const char *dialog_parent, const char *dialog_title, double in_r, double in_g, double in_b, double *out_r, double *out_g, double *out_b)
int GetGeometry (Tcl_Interp *interp, const char *widget, int *width, int *height, int *x, int *y)
int GetGeometry (vtkKWWidget *widget, int *width, int *height, int *x, int *y)
int ContainsCoordinates (Tcl_Interp *interp, const char *widget, int x, int y)
int ContainsCoordinates (vtkKWWidget *widget, int x, int y)
int UpdatePhotoFromIcon (vtkKWApplication *app, const char *photo_name, vtkKWIcon *icon, int update_options=0)
int UpdatePhotoFromPredefinedIcon (vtkKWApplication *app, const char *photo_name, int icon_index, int update_options=0)
int UpdateOrLoadPhoto (Tcl_Interp *interp, const char *photo_name, const char *file_name, const char *directory, const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)
int UpdateOrLoadPhoto (vtkKWApplication *app, const char *photo_name, const char *file_name, const char *directory, const unsigned char *pixels, int width, int height, int pixel_size, unsigned long buffer_length=0)
void SetImageOptionToPixels (vtkKWCoreWidget *widget, const unsigned char *pixels, int width, int height, int pixel_size=4, unsigned long buffer_length=0, const char *image_option=0)
int FindPhoto (Tcl_Interp *interp, const char *photo_name)
int FindPhoto (vtkKWApplication *app, const char *photo_name)
int GetPhotoHeight (Tcl_Interp *interp, const char *photo_name)
int GetPhotoHeight (vtkKWApplication *app, const char *photo_name)
int GetPhotoHeight (vtkKWWidget *widget)
int GetPhotoWidth (Tcl_Interp *interp, const char *photo_name)
int GetPhotoWidth (vtkKWApplication *app, const char *photo_name)
int ChangeFontWeightToBold (Tcl_Interp *interp, const char *font, char *new_font)
int ChangeFontWeightToNormal (Tcl_Interp *interp, const char *font, char *new_font)
int ChangeFontWeightToBold (Tcl_Interp *interp, const char *widget)
int ChangeFontWeightToBold (vtkKWWidget *widget)
int ChangeFontWeightToNormal (Tcl_Interp *interp, const char *widget)
int ChangeFontWeightToNormal (vtkKWWidget *widget)
int ChangeFontSlantToItalic (Tcl_Interp *interp, const char *font, char *new_font)
int ChangeFontSlantToRoman (Tcl_Interp *interp, const char *font, char *new_font)
int ChangeFontSlantToItalic (Tcl_Interp *interp, const char *widget)
int ChangeFontSlantToItalic (vtkKWWidget *widget)
int ChangeFontSlantToRoman (Tcl_Interp *interp, const char *widget)
int ChangeFontSlantToRoman (vtkKWWidget *widget)
int GetGridSize (Tcl_Interp *interp, const char *widget, int *nb_of_cols, int *nb_of_rows)
int GetGridSize (vtkKWWidget *widget, int *nb_of_cols, int *nb_of_rows)
int GetWidgetPositionInGrid (Tcl_Interp *interp, const char *widget, int *col, int *row)
int GetWidgetPositionInGrid (vtkKWWidget *widget, int *col, int *row)
int GetSlavesBoundingBoxInPack (Tcl_Interp *interp, const char *widget, int *width, int *height)
int GetSlavesBoundingBoxInPack (vtkKWWidget *widget, int *width, int *height)
int GetSlaveHorizontalPositionInPack (Tcl_Interp *interp, const char *widget, const char *slave, int *x)
int GetSlaveHorizontalPositionInPack (vtkKWWidget *widget, vtkKWWidget *slave, int *x)
int GetWidgetPaddingInPack (Tcl_Interp *interp, const char *widget, int *ipadx, int *ipady, int *padx, int *pady)
int GetMasterInPack (Tcl_Interp *interp, const char *widget, ostream &in)
int GetMasterInPack (vtkKWWidget *widget, ostream &in)
int GetGridColumnWidths (Tcl_Interp *interp, const char *widget, int *nb_of_cols, int **col_widths, int allocate=0)
int SynchroniseGridsColumnMinimumSize (Tcl_Interp *interp, int nb_of_widgets, const char **widgets, const float *factors=0, const int *weights=0)
int SynchroniseLabelsMaximumWidth (Tcl_Interp *interp, int nb_of_widgets, const char **widgets, const char *options=0)
int SynchroniseLabelsMaximumWidth (vtkKWApplication *app, int nb_of_widgets, const char **widgets, const char *options=0)
int GetSlavesInPack (Tcl_Interp *interp, const char *widget, char ***slaves)
int GetSlavesInPack (vtkKWWidget *widget, char ***slaves)
int GetPreviousAndNextSlaveInPack (Tcl_Interp *interp, const char *widget, const char *slave, ostream &previous_slave, ostream &next_slave)
int GetPreviousAndNextSlaveInPack (vtkKWWidget *widget, vtkKWWidget *slave, ostream &previous_slave, ostream &next_slave)
int TakeScreenDump (Tcl_Interp *interp, const char *wname, const char *fname, int top=0, int bottom=0, int left=0, int right=0)
int TakeScreenDump (vtkKWWidget *widget, const char *fname, int top=0, int bottom=0, int left=0, int right=0)
int SetTopLevelMouseCursor (Tcl_Interp *interp, const char *widget, const char *cursor)
int SetTopLevelMouseCursor (vtkKWWidget *widget, const char *cursor)
int IsTopLevel (Tcl_Interp *interp, const char *widget)
int IsTopLevel (vtkKWWidget *widget)

Protected Member Functions

 vtkKWTkUtilities ()
 ~vtkKWTkUtilities ()

Static Protected Member Functions

int ChangeFontWeight (Tcl_Interp *interp, const char *widget, int)
int ChangeFontWeight (Tcl_Interp *interp, const char *font, char *new_font, int)
int ChangeFontSlant (Tcl_Interp *interp, const char *widget, int)
int ChangeFontSlant (Tcl_Interp *interp, const char *font, char *new_font, int)
const char * EvaluateStringFromArgsInternal (Tcl_Interp *interp, vtkObject *obj, const char *format, va_list var_args1, va_list var_args2)
const char * EvaluateSimpleStringInternal (Tcl_Interp *interp, vtkObject *obj, const char *str)

Detailed Description

class that supports basic Tk functions

vtkKWTkUtilities provides methods to perform common Tk operations.

Definition at line 42 of file vtkKWTkUtilities.h.

Member Enumeration Documentation

anonymous enum
 

Update a Tk photo given by its name 'photo_name' using pixels stored in 'pixels' and structured as a 'width' x 'height' x 'pixel_size' (number of bytes per pixel, 3 for RGB for example). If 'buffer_length' is 0, compute it automatically by multiplying 'pixel_size', 'width' and 'height' together. If UPDATE_PHOTO_OPTION_FLIP_V is set in 'update_option', flip the image buffer vertically. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. Return 1 on success, 0 otherwise. BTX

Enumeration values:
UpdatePhotoOptionFlipVertical 

Definition at line 176 of file vtkKWTkUtilities.h.

Constructor & Destructor Documentation

vtkKWTkUtilities::vtkKWTkUtilities (   )  [inline, protected]
 

Definition at line 519 of file vtkKWTkUtilities.h.

vtkKWTkUtilities::~vtkKWTkUtilities (   )  [inline, protected]
 

Definition at line 520 of file vtkKWTkUtilities.h.

Member Function Documentation

vtkKWTkUtilities* vtkKWTkUtilities::New (   )  [static]
 

vtkKWTkUtilities::vtkTypeRevisionMacro (  vtkKWTkUtilities  ,
vtkObject 
) 
 

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

const char* vtkKWTkUtilities::GetTclNameFromPointer (  Tcl_Interp *  interp,
vtkObject *  obj
)  [static]
 

Return the Tcl name of a VTK object

const char* vtkKWTkUtilities::GetTclNameFromPointer (  vtkKWApplication *  app,
vtkObject *  obj
)  [static]
 

Return the Tcl name of a VTK object

const char* vtkKWTkUtilities::EvaluateString (  Tcl_Interp *  interp,
const char *  format,
... 
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

const char* vtkKWTkUtilities::EvaluateString (  vtkKWApplication *  app,
const char *  format,
... 
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

const char* vtkKWTkUtilities::EvaluateStringFromArgs (  Tcl_Interp *  interp,
const char *  format,
va_list  var_args1,
va_list  var_args2
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

const char* vtkKWTkUtilities::EvaluateStringFromArgs (  vtkKWApplication *  app,
const char *  format,
va_list  var_args1,
va_list  var_args2
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

const char* vtkKWTkUtilities::EvaluateSimpleString (  Tcl_Interp *  interp,
const char *  str
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

const char* vtkKWTkUtilities::EvaluateSimpleString (  vtkKWApplication *  app,
const char *  str
)  [static]
 

Evaluate a Tcl string. The string is passed to printf() first (as format specifier) along with the remaining arguments. The second prototype can be used by similar variable arguments method: it needs to walk through the var_args list twice though. The only portable way to do this is to pass two copies of the list's start pointer. Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return a pointer to the Tcl interpreter result buffer. BTX

void vtkKWTkUtilities::GetRGBColor (  Tcl_Interp *  interp,
const char *  widget,
const char *  color,
double *  r,
double *  g,
double *  b
)  [static]
 

Get the RGB components that correspond to 'color' (say, #223344) in the widget given by 'widget' (say, .foo.bar). Color may be specified in any of the forms acceptable for a Tk color option. A convenience method is provided to query a vtkKWWidget directly.

void vtkKWTkUtilities::GetRGBColor (  vtkKWWidget *  widget,
const char *  color,
double *  r,
double *  g,
double *  b
)  [static]
 

Get the RGB components that correspond to 'color' (say, #223344) in the widget given by 'widget' (say, .foo.bar). Color may be specified in any of the forms acceptable for a Tk color option. A convenience method is provided to query a vtkKWWidget directly.

void vtkKWTkUtilities::GetOptionColor (  Tcl_Interp *  interp,
const char *  widget,
const char *  option,
double *  r,
double *  g,
double *  b
)  [static]
 

Get the RGB components that correspond to the color 'option' (say -bg, -fg, etc.) of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly.

void vtkKWTkUtilities::GetOptionColor (  vtkKWWidget *  widget,
const char *  option,
double *  r,
double *  g,
double *  b
)  [static]
 

Get the RGB components that correspond to the color 'option' (say -bg, -fg, etc.) of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly.

double* vtkKWTkUtilities::GetOptionColor (  vtkKWWidget *  widget,
const char *  option
)  [static]
 

Get the RGB components that correspond to the color 'option' (say -bg, -fg, etc.) of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly.

void vtkKWTkUtilities::SetOptionColor (  Tcl_Interp *  interp,
const char *  widget,
const char *  option,
double  r,
double  g,
double  b
)  [static]
 

Set the RGB components of the color 'option' (say -bg, -fg, etc.) of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly.

void vtkKWTkUtilities::SetOptionColor (  vtkKWWidget *  widget,
const char *  option,
double  r,
double  g,
double  b
)  [static]
 

Set the RGB components of the color 'option' (say -bg, -fg, etc.) of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly.

int vtkKWTkUtilities::QueryUserForColor (  Tcl_Interp *  interp,
const char *  dialog_parent,
const char *  dialog_title,
double  in_r,
double  in_g,
double  in_b,
double *  out_r,
double *  out_g,
double *  out_b
)  [static]
 

Query user for color using a Tk color dialog Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::QueryUserForColor (  vtkKWApplication *  app,
const char *  dialog_parent,
const char *  dialog_title,
double  in_r,
double  in_g,
double  in_b,
double *  out_r,
double *  out_g,
double *  out_b
)  [static]
 

Query user for color using a Tk color dialog Convenience methods are provided to specify a vtkKWApplication instead of the Tcl interpreter. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetGeometry (  Tcl_Interp *  interp,
const char *  widget,
int *  width,
int *  height,
int *  x,
int *  y
)  [static]
 

Get the geometry of a widget given by 'widget' (say, .foo.bar). The geometry is the width, height and position of the widget. Any of them can be a NULL pointer, they will be safely ignored. Return 1 on success, 0 otherwise. A convenience method is provided to query a vtkKWWidget directly.

int vtkKWTkUtilities::GetGeometry (  vtkKWWidget *  widget,
int *  width,
int *  height,
int *  x,
int *  y
)  [static]
 

Get the geometry of a widget given by 'widget' (say, .foo.bar). The geometry is the width, height and position of the widget. Any of them can be a NULL pointer, they will be safely ignored. Return 1 on success, 0 otherwise. A convenience method is provided to query a vtkKWWidget directly.

int vtkKWTkUtilities::ContainsCoordinates (  Tcl_Interp *  interp,
const char *  widget,
int  x,
int  y
)  [static]
 

Check if a pair of screen coordinates (x, y) are within the area defined by the widget given by 'widget' (say, .foo.bar). Return 1 if inside, 0 otherwise. A convenience method is provided to query a vtkKWWidget directly.

int vtkKWTkUtilities::ContainsCoordinates (  vtkKWWidget *  widget,
int  x,
int  y
)  [static]
 

Check if a pair of screen coordinates (x, y) are within the area defined by the widget given by 'widget' (say, .foo.bar). Return 1 if inside, 0 otherwise. A convenience method is provided to query a vtkKWWidget directly.

int vtkKWTkUtilities::UpdatePhoto (  Tcl_Interp *  interp,
const char *  photo_name,
const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0,
int  update_options = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in 'pixels' and structured as a 'width' x 'height' x 'pixel_size' (number of bytes per pixel, 3 for RGB for example). If 'buffer_length' is 0, compute it automatically by multiplying 'pixel_size', 'width' and 'height' together. If UPDATE_PHOTO_OPTION_FLIP_V is set in 'update_option', flip the image buffer vertically. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. Return 1 on success, 0 otherwise. BTX

int vtkKWTkUtilities::UpdatePhoto (  vtkKWApplication *  app,
const char *  photo_name,
const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0,
int  update_options = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in 'pixels' and structured as a 'width' x 'height' x 'pixel_size' (number of bytes per pixel, 3 for RGB for example). If 'buffer_length' is 0, compute it automatically by multiplying 'pixel_size', 'width' and 'height' together. If UPDATE_PHOTO_OPTION_FLIP_V is set in 'update_option', flip the image buffer vertically. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. Return 1 on success, 0 otherwise. BTX

int vtkKWTkUtilities::UpdatePhotoFromIcon (  vtkKWApplication *  app,
const char *  photo_name,
vtkKWIcon *  icon,
int  update_options = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in the icon 'icon'.

int vtkKWTkUtilities::UpdatePhotoFromPredefinedIcon (  vtkKWApplication *  app,
const char *  photo_name,
int  icon_index,
int  update_options = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in the icon 'icon'.

int vtkKWTkUtilities::UpdateOrLoadPhoto (  Tcl_Interp *  interp,
const char *  photo_name,
const char *  file_name,
const char *  directory,
const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in 'pixels' and structured as a 'width' x 'height' x 'pixel_size' (number of bytes per pixel, 3 for RGB for example). If a file 'file_name'.png is found in 'directory' or 'directory/Resources' then an attempt is made to update the photo using this file. If no file is found, the remaining parameters are used to update the photo by calling UpdatePhoto(). As a convenience, if 'photo_name' is NULL, 'file_name' is used instead. Note that only the PNG file format is supported so far (do not provide the .png extension to 'file_name'). Return 1 on success, 0 otherwise. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

int vtkKWTkUtilities::UpdateOrLoadPhoto (  vtkKWApplication *  app,
const char *  photo_name,
const char *  file_name,
const char *  directory,
const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size,
unsigned long  buffer_length = 0
)  [static]
 

Update a Tk photo given by its name 'photo_name' using pixels stored in 'pixels' and structured as a 'width' x 'height' x 'pixel_size' (number of bytes per pixel, 3 for RGB for example). If a file 'file_name'.png is found in 'directory' or 'directory/Resources' then an attempt is made to update the photo using this file. If no file is found, the remaining parameters are used to update the photo by calling UpdatePhoto(). As a convenience, if 'photo_name' is NULL, 'file_name' is used instead. Note that only the PNG file format is supported so far (do not provide the .png extension to 'file_name'). Return 1 on success, 0 otherwise. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

void vtkKWTkUtilities::SetImageOptionToPixels (  vtkKWCoreWidget *  widget,
const unsigned char *  pixels,
int  width,
int  height,
int  pixel_size = 4,
unsigned long  buffer_length = 0,
const char *  image_option = 0
)  [static]
 

Specifies an image to display in a widget. Typically, if the image is specified then it overrides other options that specify a bitmap or textual value to display in the widget. Set the image option using pixel data. The parameters are the same as the one used in UpdatePhoto(). An image is created and associated to the Tk -image option or image_option if not NULL (ex: -selectimage).

int vtkKWTkUtilities::FindPhoto (  Tcl_Interp *  interp,
const char *  photo_name
)  [static]
 

Query if a Tk photo given by its name 'photo_name' exists. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

int vtkKWTkUtilities::FindPhoto (  vtkKWApplication *  app,
const char *  photo_name
)  [static]
 

Query if a Tk photo given by its name 'photo_name' exists. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

int vtkKWTkUtilities::GetPhotoHeight (  Tcl_Interp *  interp,
const char *  photo_name
)  [static]
 

Get the height of a Tk photo given by its name 'photo_name'. If the photo does not exist, return 0 and issue a warning. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. A convenience method is provided to specify a vtkKWWidget this photo has been assigned to using the -image Tk option.

int vtkKWTkUtilities::GetPhotoHeight (  vtkKWApplication *  app,
const char *  photo_name
)  [static]
 

Get the height of a Tk photo given by its name 'photo_name'. If the photo does not exist, return 0 and issue a warning. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. A convenience method is provided to specify a vtkKWWidget this photo has been assigned to using the -image Tk option.

int vtkKWTkUtilities::GetPhotoHeight (  vtkKWWidget *  widget  )  [static]
 

Get the height of a Tk photo given by its name 'photo_name'. If the photo does not exist, return 0 and issue a warning. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter. A convenience method is provided to specify a vtkKWWidget this photo has been assigned to using the -image Tk option.

int vtkKWTkUtilities::GetPhotoWidth (  Tcl_Interp *  interp,
const char *  photo_name
)  [static]
 

Get the width of a Tk photo given by its name 'photo_name'. If the photo does not exist, return 0 and issue a warning. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

int vtkKWTkUtilities::GetPhotoWidth (  vtkKWApplication *  app,
const char *  photo_name
)  [static]
 

Get the width of a Tk photo given by its name 'photo_name'. If the photo does not exist, return 0 and issue a warning. A convenience method is provided to specify the vtkKWApplication this photo belongs to, instead of the Tcl interpreter.

int vtkKWTkUtilities::ChangeFontWeightToBold (  Tcl_Interp *  interp,
const char *  font,
char *  new_font
)  [static]
 

Change the weight attribute of a Tk font specification given by 'font'. The new font specification is copied to 'new_font'. It is up to the caller to allocate enough space in 'new_font'. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontWeightToNormal (  Tcl_Interp *  interp,
const char *  font,
char *  new_font
)  [static]
 

Change the weight attribute of a Tk font specification given by 'font'. The new font specification is copied to 'new_font'. It is up to the caller to allocate enough space in 'new_font'. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontWeightToBold (  Tcl_Interp *  interp,
const char *  widget
)  [static]
 

Change the weight attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontWeightToBold (  vtkKWWidget *  widget  )  [static]
 

Change the weight attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontWeightToNormal (  Tcl_Interp *  interp,
const char *  widget
)  [static]
 

Change the weight attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontWeightToNormal (  vtkKWWidget *  widget  )  [static]
 

Change the weight attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToItalic (  Tcl_Interp *  interp,
const char *  font,
char *  new_font
)  [static]
 

Change the slant attribute of a Tk font specification given by 'font'. The new font specification is copied to 'new_font'. It is up to the caller to allocate enough space in 'new_font'. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToRoman (  Tcl_Interp *  interp,
const char *  font,
char *  new_font
)  [static]
 

Change the slant attribute of a Tk font specification given by 'font'. The new font specification is copied to 'new_font'. It is up to the caller to allocate enough space in 'new_font'. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToItalic (  Tcl_Interp *  interp,
const char *  widget
)  [static]
 

Change the slant attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToItalic (  vtkKWWidget *  widget  )  [static]
 

Change the slant attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToRoman (  Tcl_Interp *  interp,
const char *  widget
)  [static]
 

Change the slant attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::ChangeFontSlantToRoman (  vtkKWWidget *  widget  )  [static]
 

Change the slant attribute of a 'widget' -font option. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetGridSize (  Tcl_Interp *  interp,
const char *  widget,
int *  nb_of_cols,
int *  nb_of_rows
)  [static]
 

Get the number of colums and rows defined in the grid layout of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetGridSize (  vtkKWWidget *  widget,
int *  nb_of_cols,
int *  nb_of_rows
)  [static]
 

Get the number of colums and rows defined in the grid layout of the widget given by 'widget' (say, .foo.bar). A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetWidgetPositionInGrid (  Tcl_Interp *  interp,
const char *  widget,
int *  col,
int *  row
)  [static]
 

Get the grid position (column, row) of the widget given by 'widget' (say, .foo.bar). We assume that the current widget layout is a Tk grid. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetWidgetPositionInGrid (  vtkKWWidget *  widget,
int *  col,
int *  row
)  [static]
 

Get the grid position (column, row) of the widget given by 'widget' (say, .foo.bar). We assume that the current widget layout is a Tk grid. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetSlavesBoundingBoxInPack (  Tcl_Interp *  interp,
const char *  widget,
int *  width,
int *  height
)  [static]
 

Get the bounding box size (width, height) of the slaves packed in the widget given by 'widget' (say, .foo.bar), i.e. the largest width and height of the slaves packed in the widget, including padding options. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetSlavesBoundingBoxInPack (  vtkKWWidget *  widget,
int *  width,
int *  height
)  [static]
 

Get the bounding box size (width, height) of the slaves packed in the widget given by 'widget' (say, .foo.bar), i.e. the largest width and height of the slaves packed in the widget, including padding options. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetSlaveHorizontalPositionInPack (  Tcl_Interp *  interp,
const char *  widget,
const char *  slave,
int *  x
)  [static]
 

Get the horizontal position 'x' in pixels of a slave widget given by 'slave' (say .foo.bar.sl) in the widget given by 'widget' (say .foo.bar). This can be used in case 'winfo x' does not work because the widget has not been mapped yet. We assume that the current widget layout is a Tk pack. A convenience method is provided to query vtkKWWidget(s) directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetSlaveHorizontalPositionInPack (  vtkKWWidget *  widget,
vtkKWWidget *  slave,
int *  x
)  [static]
 

Get the horizontal position 'x' in pixels of a slave widget given by 'slave' (say .foo.bar.sl) in the widget given by 'widget' (say .foo.bar). This can be used in case 'winfo x' does not work because the widget has not been mapped yet. We assume that the current widget layout is a Tk pack. A convenience method is provided to query vtkKWWidget(s) directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetWidgetPaddingInPack (  Tcl_Interp *  interp,
const char *  widget,
int *  ipadx,
int *  ipady,
int *  padx,
int *  pady
)  [static]
 

Get the padding values of the widget given by 'widget' (say .foo.bar) in its layout. We assume that the current widget layout is a Tk pack. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetMasterInPack (  Tcl_Interp *  interp,
const char *  widget,
ostream &  in
)  [static]
 

Get the container a widget given by 'widget' (say .foo.bar) is packed in. This is similar to the Tk -in pack option. Write the container widget name to the output stream 'in'. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetMasterInPack (  vtkKWWidget *  widget,
ostream &  in
)  [static]
 

Get the container a widget given by 'widget' (say .foo.bar) is packed in. This is similar to the Tk -in pack option. Write the container widget name to the output stream 'in'. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetGridColumnWidths (  Tcl_Interp *  interp,
const char *  widget,
int *  nb_of_cols,
int **  col_widths,
int  allocate = 0
)  [static]
 

Get the column widths of a grid (i.e. a master widget that has been grid). If 'allocate' is true, the resulting array (col_widths) is allocated by the function to match the number of columns. The function iterates over cells to request the width of each slave (winfo reqwidth).

int vtkKWTkUtilities::SynchroniseGridsColumnMinimumSize (  Tcl_Interp *  interp,
int  nb_of_widgets,
const char **  widgets,
const float *  factors = 0,
const int *  weights = 0
)  [static]
 

Synchronize the columns minimum size of different widgets that have been grid. If 'factors' is non-null, it is used as an array of multiplication factor to apply to each column minimum size. If 'weights' is non-null, it is used as an array of weight to apply to each column through columnconfigure -weight.

int vtkKWTkUtilities::SynchroniseLabelsMaximumWidth (  Tcl_Interp *  interp,
int  nb_of_widgets,
const char **  widgets,
const char *  options = 0
)  [static]
 

Synchronize the width of a set of labels given by an array of 'nb_of_widgets' widgets stored in 'widgets'. The maximum size of the labels is found and assigned to each label. Additionally it will apply the 'options' to/ each widget (if any). A convenience method is provided to specify the vtkKWApplication these widgets belongs to, instead of the Tcl interpreter. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::SynchroniseLabelsMaximumWidth (  vtkKWApplication *  app,
int  nb_of_widgets,
const char **  widgets,
const char *  options = 0
)  [static]
 

Synchronize the width of a set of labels given by an array of 'nb_of_widgets' widgets stored in 'widgets'. The maximum size of the labels is found and assigned to each label. Additionally it will apply the 'options' to/ each widget (if any). A convenience method is provided to specify the vtkKWApplication these widgets belongs to, instead of the Tcl interpreter. Return 1 on success, 0 otherwise.

int vtkKWTkUtilities::GetSlavesInPack (  Tcl_Interp *  interp,
const char *  widget,
char ***  slaves
)  [static]
 

Store the slaves packed in the widget given by 'widget' (say, .foo.bar) in the array 'slaves'. This array is allocated automatically. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return the number of slaves.

int vtkKWTkUtilities::GetSlavesInPack (  vtkKWWidget *  widget,
char ***  slaves
)  [static]
 

Store the slaves packed in the widget given by 'widget' (say, .foo.bar) in the array 'slaves'. This array is allocated automatically. We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return the number of slaves.

int vtkKWTkUtilities::GetPreviousAndNextSlaveInPack (  Tcl_Interp *  interp,
const char *  widget,
const char *  slave,
ostream &  previous_slave,
ostream &  next_slave
)  [static]
 

Browse all the slaves of the widget given by 'widget' (say, .foo.bar) and store the slave packed before 'slave' in 'previous_slave', and the slave packed after 'slave' in 'next_slave' We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 if 'slave' was found, 0 otherwise

int vtkKWTkUtilities::GetPreviousAndNextSlaveInPack (  vtkKWWidget *  widget,
vtkKWWidget *  slave,
ostream &  previous_slave,
ostream &  next_slave
)  [static]
 

Browse all the slaves of the widget given by 'widget' (say, .foo.bar) and store the slave packed before 'slave' in 'previous_slave', and the slave packed after 'slave' in 'next_slave' We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 if 'slave' was found, 0 otherwise

int vtkKWTkUtilities::TakeScreenDump (  Tcl_Interp *  interp,
const char *  wname,
const char *  fname,
int  top = 0,
int  bottom = 0,
int  left = 0,
int  right = 0
)  [static]
 

Browse all the slaves of the widget given by 'widget' (say, .foo.bar) and store the slave packed before 'slave' in 'previous_slave', and the slave packed after 'slave' in 'next_slave' We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 if 'slave' was found, 0 otherwise

int vtkKWTkUtilities::TakeScreenDump (  vtkKWWidget *  widget,
const char *  fname,
int  top = 0,
int  bottom = 0,
int  left = 0,
int  right = 0
)  [static]
 

Browse all the slaves of the widget given by 'widget' (say, .foo.bar) and store the slave packed before 'slave' in 'previous_slave', and the slave packed after 'slave' in 'next_slave' We assume that the current widget layout is a Tk pack. A convenience method is provided to query a vtkKWWidget directly. Return 1 if 'slave' was found, 0 otherwise

int vtkKWTkUtilities::SetTopLevelMouseCursor (  Tcl_Interp *  interp,
const char *  widget,
const char *  cursor
)  [static]
 

Set widget's toplevel mouse cursor. Provide a NULL or empty cursor to reset it to default.

int vtkKWTkUtilities::SetTopLevelMouseCursor (  vtkKWWidget *  widget,
const char *  cursor
)  [static]
 

Set widget's toplevel mouse cursor. Provide a NULL or empty cursor to reset it to default.

int vtkKWTkUtilities::IsTopLevel (  Tcl_Interp *  interp,
const char *  widget
)  [static]
 

Return 1 if window is a toplevel, 0 otherwise

int vtkKWTkUtilities::IsTopLevel (  vtkKWWidget *  widget  )  [static]
 

Return 1 if window is a toplevel, 0 otherwise

int vtkKWTkUtilities::ChangeFontWeight (  Tcl_Interp *  interp,
const char *  widget,
int 
)  [static, protected]
 

int vtkKWTkUtilities::ChangeFontWeight (  Tcl_Interp *  interp,
const char *  font,
char *  new_font,
int 
)  [static, protected]
 

int vtkKWTkUtilities::ChangeFontSlant (  Tcl_Interp *  interp,
const char *  widget,
int 
)  [static, protected]
 

int vtkKWTkUtilities::ChangeFontSlant (  Tcl_Interp *  interp,
const char *  font,
char *  new_font,
int 
)  [static, protected]
 

const char* vtkKWTkUtilities::EvaluateStringFromArgsInternal (  Tcl_Interp *  interp,
vtkObject *  obj,
const char *  format,
va_list  var_args1,
va_list  var_args2
)  [static, protected]
 

const char* vtkKWTkUtilities::EvaluateSimpleStringInternal (  Tcl_Interp *  interp,
vtkObject *  obj,
const char *  str
)  [static, protected]
 

The documentation for this class was generated from the following file:
Generated on Tue May 30 12:45:50 2006 for ParaView by doxygen 1.3.5