wxNonOwnedWindow Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/nonownedwnd.h>

Inheritance diagram for wxNonOwnedWindow:

---

Detailed Description

Common base class for all non-child windows.

This is the common base class of wxTopLevelWindow and wxPopupWindow and is not used directly.

Currently the only additional functionality it provides, compared to base wxWindow class, is the ability to set the window shape.

Since:

2.9.3

Public Member Functions
bool	SetShape (const wxRegion &region)
	If the platform supports it, sets the shape of the window to that depicted by region.
bool	SetShape (const wxGraphicsPath &path)
	Set the window shape to the given path.

List of all members.

---

Member Function Documentation

bool wxNonOwnedWindow::SetShape

(

const wxRegion &

region

)

If the platform supports it, sets the shape of the window to that depicted by region.

The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call SetShape() again with an empty wxRegion. Returns true if the operation is successful.

This method is available in this class only since wxWidgets 2.9.3, previous versions only provided it in wxTopLevelWindow.

bool wxNonOwnedWindow::SetShape

(

const wxGraphicsPath &

path

)

Set the window shape to the given path.

Set the window shape to the interior of the given path and also draw the window border along the specified path.

For example, to make a clock-like circular window you could use

            wxSize size = GetSize();
            wxGraphicsPath
                path = wxGraphicsRenderer::GetDefaultRenderer()->CreatePath();
            path.AddCircle(size.x/2, size.y/2, 30);
            SetShape(path);

As the overload above, this method is not guaranteed to work on all platforms but currently does work in wxMSW, wxOSX/Cocoa and wxGTK (with the appropriate but almost always present X11 extensions) ports.

Since:

2.9.3