VISU.View Interface Reference

View interface More...

import "VISU_Gen.idl";

Inheritance diagram for VISU.View:

Public Types
enum	ViewRepresentation { OBJECTBROWSER, VIEWER, PYTHON, MESSAGES }
enum	ViewPosition {   TOP, CENTER, BOTTOM, RIGHT,   LEFT }
Public Member Functions
void	ShowPart (in ViewRepresentation ViewRepr, in boolean state)
boolean	IsPartShown (in ViewRepresentation ViewRepr)
void	SetViewWidth (in long Width)
void	SetViewHeight (in long Height)
long	GetViewWidth ()
long	GetViewHeight ()
void	SetViewPositionHorizontal (in ViewPosition ViewPosHor)
void	SetViewPositionVertical (in ViewPosition ViewPosVer)
void	SetRelativePosition (in double x, in double y)
void	SetRelativeSize (in double x, in double y)
void	SetTitle (in string theTitle)
string	GetTitle ()
void	SetBackground (in SALOMEDS::Color theColor)
SALOMEDS::Color	GetBackground ()
void	Minimize ()
void	Restore ()
void	Maximize ()
void	EraseAll ()
void	DisplayAll ()
void	Erase (in PrsObject thePrsObj)
void	Display (in PrsObject thePrsObj)
void	DisplayOnly (in PrsObject thePrsObj)
void	Update ()
boolean	SavePicture (in string theFileName)
IdType	GetID ()
VISUType	GetType ()

---

Detailed Description

Contains a set of methods used by the View frame, which can be one of the following types: 3d, Table, XY plot. View interface is a base for all types of view interfaces.

---

Member Enumeration Documentation

enum VISU::View::ViewRepresentation

Enumeration values: OBJECTBROWSER  VIEWER  PYTHON  MESSAGES

enum VISU::View::ViewPosition

Enumeration values: TOP  CENTER  BOTTOM  RIGHT  LEFT

---

Member Function Documentation

void VISU.View.ShowPart (  in ViewRepresentation  ViewRepr, in boolean  state )

boolean VISU.View.IsPartShown (  in ViewRepresentation  ViewRepr  )

void VISU.View.SetViewWidth (  in long  Width  )

void VISU.View.SetViewHeight (  in long  Height  )

long VISU.View.GetViewWidth (   )

long VISU.View.GetViewHeight (   )

void VISU.View.SetViewPositionHorizontal (  in ViewPosition  ViewPosHor  )

void VISU.View.SetViewPositionVertical (  in ViewPosition  ViewPosVer  )

void VISU.View.SetRelativePosition (  in double  x, in double  y )

void VISU.View.SetRelativeSize (  in double  x, in double  y )

void VISU.View.SetTitle (  in string  theTitle  )

Sets the title of the View frame. Parameters: theTitle  String parameter defining the title of the View frame.

string VISU.View.GetTitle (   )

Gets the title of the View frame.

void VISU.View.SetBackground (  in SALOMEDS::Color  theColor  )

Sets background color of the View frame. Parameters: theColor  Background color defined in SALOMEDS::Color enumeration.

SALOMEDS::Color VISU.View.GetBackground (   )

Gets background color of the View frame.

void VISU.View.Minimize (   )

Minimizes to the task bar or to the bottom of the Desktop the View frame.

void VISU.View.Restore (   )

Restores the View frame.

void VISU.View.Maximize (   )

Maximizes the View frame.

void VISU.View.EraseAll (   )

Removes all presentations (presentable objects) from the view.

void VISU.View.DisplayAll (   )

Displays all presentations (presentable objects) in the view.

void VISU.View.Erase (  in PrsObject  thePrsObj  )

Removes a definite presentation (presentable object) from the view. Parameters: thePrsObj  The presentation (presentable object) which should be deleted.

void VISU.View.Display (  in PrsObject  thePrsObj  )

Displays a definite presentation (presentable object) in the view. Parameters: thePrsObj  The presentation (presentable object) which should be displayed.

void VISU.View.DisplayOnly (  in PrsObject  thePrsObj  )

Allows to display only a definite presentation (presentable object) in the view. All other presentations are removed from the view. Parameters: thePrsObj  The presentation (presentable object) which should be displayed.

void VISU.View.Update (   )

Updates the view.

boolean VISU.View.SavePicture (  in string  theFileName  )

Saves the view. Parameters: theFileName  The name of the file where the view will be saved. Returns: True, if the view have been saved successfully.

IdType VISU.Base.GetID (   )  [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType (   )  [inherited]

Returns the type of the presentable object

---