CIP C++ documentation for class "pfcWindow"

Class pfcWindow

# include <pfcWindow.h> class pfcWindow : public virtual pfcChild { xaideclare(pfcWindow) ... };

Description

This class describes the attributes of a window.

The window position refers to the upper, left corner of the window from the upper, left corner of the screen.

See Also:: pfcSession, pfcBaseSession::ListWindows(), pfcBaseSession::GetWindow(xint)

Direct Known Subclasses:: wfcWWindow

Method Summary


`void`	`Activate ()`
	Activates the window.

`void`	`Clear ()`
	Clears the Creo Parametric window.

`void`	`Close ()`
	Closes the window.

`void`	`ExportRasterImage (xrstring ImageFileName, pfcRasterImageExportInstructions_ptr Instructions)`
	Outputs a standard Creo Parametric raster output file.

`xreal`	`GetBrowserSize ()`
	Returns the percentage of the graphics window covered by the embedded web browser.

`xreal`	`GetGraphicsAreaHeight ()`
	The height of the Creo Parametric graphics window without the border.

`xreal`	`GetGraphicsAreaWidth ()`
	The width of the Creo Parametric graphics window without the border

`xreal`	`GetHeight ()`
	The window height. The size is normalized to values from 0 to 1.

`xint`	`GetId ()`
	Retrieves the current window identifier.

`optional pfcModel_ptr`	`GetModel ()`
	The Creo Parametric model that owns the window. This attribute can be `null`, if there no model that currently owns the window.

`pfcScreenTransform_ptr`	`GetScreenTransform ()`
`void`	`SetScreenTransform (pfcScreenTransform_ptr value)`
	The pan and zoom matrix of the window. When you set a window's ScreenTransform, the window updates immediately. Currently, the Get() method only retreives the ScreenTransform object for the current Creo Parametric window.

`xstring`	`GetURL ()`
	Returns the URL displayed in the embedded web browser.

`xreal`	`GetWidth ()`
	The width of the window. The size is normalized to values from 0 to 1.

`xreal`	`GetXPos ()`
	The X position of the window. The position is normalized to values from0 to 1.

`xreal`	`GetYPos ()`
	The Y position of the window. The position is normalized to values from0 to 1.

`void`	`Refresh ()`
	Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.

`void`	`Repaint ()`
	Repaints the window. This function enables you to perform several operations and update the view when necessary.

`void`	`SetBrowserSize (xreal BrowserSize)`
	Sets the percentage of the graphics window covered by the embedded web browser.



`void`	`SetURL (xrstring URL)`
	Sets the URL displayed in the embedded web browser.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Method Detail

xreal GetHeight ()

The window height. The size is normalized to values from 0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

xreal GetWidth ()

The width of the window. The size is normalized to values from 0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

xreal GetXPos ()

The X position of the window. The position is normalized to values from0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

xreal GetYPos ()

The Y position of the window. The position is normalized to values from0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

xreal GetGraphicsAreaHeight ()

The height of the Creo Parametric graphics window without the border.

The height is normalized to a value from 0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

xreal GetGraphicsAreaWidth ()

The width of the Creo Parametric graphics window without the border

The width is normalized to a value from 0 to 1.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

`pfcScreenTransform_ptr`	`GetScreenTransform`	`()`
`void`	`SetScreenTransform`	`(pfcScreenTransform_ptr value)`

The pan and zoom matrix of the window. When you set a window's ScreenTransform, the window updates immediately.

Currently, the Get() method only retreives the ScreenTransform object for the current Creo Parametric window.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - There is no current window.

Manual References:: Windows and Views: Transformations, Windows and Views: Transformations

optional pfcModel_ptr GetModel ()

The Creo Parametric model that owns the window. This attribute can be null, if there no model that currently owns the window.

Manual References:: Models: Getting a Model Object, Models: Retrieving Models

void Clear ()

Clears the Creo Parametric window.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

Returns:

void Repaint ()

Repaints the window. This function enables you to perform several operations and update the view when necessary.

Manual References:: Selection: Controlling Selection Display, Windows and Views: Window Operations, Windows and Views: Window Operations, Drawings: Drawing Tables Operations, Drawings: Drawing Table Segments, External Objects: Display Data for External Objects

Returns:

void Refresh ()

Refreshes the screen. The function does not clear highlights. This is the most efficient function to use if you want to clear "temporary" graphics only.

Manual References:: Graphics: Display Lists and Graphics, Selection: Controlling Selection Display, Windows and Views: Window Operations, Windows and Views: Window Operations, Assembly: Kinematic Dragging and Creating Snapshots: Connecting to a Kinematic Drag Session

Returns:

void Close ()

Closes the window.

If the current window is the original window created when Creo Parametric started, the function clears the window. Otherwise, the function removes the window from the screen.
Any work done since the last save will be lost.
This function does not take effect until control returns to Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The window you are trying to delete is the current window.

pfcXToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

Returns:

void Activate ()

Activates the window.

This method only works in the asynchronous graphics mode. It will throw a pfcXToolkitBadContext exception, if called in the non-graphic mode.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function was called in RPC input (non-graphic) mode

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

Returns:

xint GetId ()

Retrieves the current window identifier.

Manual References:: Windows and Views: Window Operations, Windows and Views: Window Operations

Returns:: The current window identifier. If the current window is the message area, the method returns -1.

void ExportRasterImage (xrstring ImageFileName, pfcRasterImageExportInstructions_ptr Instructions)

Outputs a standard Creo Parametric raster output file.

Exceptions thrown (but not limited to):

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitBadContext - The function is not available in Design Test Mode.

Manual References:: Interface: Window Operations

Parameters:

ImageFileName: An output filename, including the extension
Instructions: An Raster-Export-Instructions object that controls the Raster-Image export operation. All of these objects inherit from pfcRasterImageExportInstructions .

Returns:

void SetURL (xrstring URL)

Sets the URL displayed in the embedded web browser.

See Also:: pfcWindow::GetBrowserSize(), pfcWindow::SetBrowserSize(xreal), pfcWindow::GetURL()

Manual References:: Windows and Views: Embedded Browser, Windows and Views: Embedded Browser

Parameters:

URL: The URL to display in the browser.

Returns:

xstring GetURL ()

Returns the URL displayed in the embedded web browser.

See Also:: pfcWindow::GetBrowserSize(), pfcWindow::SetBrowserSize(xreal), pfcWindow::SetURL(xrstring)

Manual References:: Windows and Views: Embedded Browser, Windows and Views: Embedded Browser

Returns:: The URL.

xreal GetBrowserSize ()

Returns the percentage of the graphics window covered by the embedded web browser.

Not applicable if browser is open in separate window.

See Also:: pfcWindow::SetBrowserSize(xreal), pfcWindow::GetURL(), pfcWindow::SetURL(xrstring)

Manual References:: Windows and Views: Embedded Browser, Windows and Views: Embedded Browser

Returns:: The percentage of the window covered, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).

void SetBrowserSize (xreal BrowserSize)

Sets the percentage of the graphics window covered by the embedded web browser.

Not applicable if browser is open in separate window.

See Also:: pfcWindow::GetBrowserSize(), pfcWindow::GetURL(), pfcWindow::SetURL(xrstring)

Manual References:: Windows and Views: Embedded Browser, Windows and Views: Embedded Browser

Parameters:

BrowserSize: The percentage of the window to cover, from 0.0 (the browser is minimized) to 100.0 (the browser covers the entire window).

Returns: