ASPiK SDK
VSTGUI::Standalone::IWindow Class Referenceabstract

#include <iwindow.h>

Inheritance diagram for VSTGUI::Standalone::IWindow:
VSTGUI::Interface VSTGUI::Standalone::Detail::IPlatformWindowAccess VSTGUI::Standalone::Detail::Window

Public Member Functions

virtual const WindowControllerPtr & getController () const =0
 
virtual CPoint getSize () const =0
 
virtual CPoint getPosition () const =0
 
virtual double getScaleFactor () const =0
 
virtual CRect getFocusViewRect () const =0
 
virtual const UTF8StringgetTitle () const =0
 
virtual WindowType getType () const =0
 
virtual WindowStyle getStyle () const =0
 
virtual const UTF8StringgetAutoSaveFrameName () const =0
 
virtual void setSize (const CPoint &newSize)=0
 
virtual void setPosition (const CPoint &newPosition)=0
 
virtual void setTitle (const UTF8String &newTitle)=0
 
virtual void setContentView (const SharedPointer< CFrame > &frame)=0
 
virtual void show ()=0
 
virtual void hide ()=0
 
virtual void close ()=0
 
virtual void activate ()=0
 
virtual void registerWindowListener (IWindowListener *listener)=0
 
virtual void unregisterWindowListener (IWindowListener *listener)=0
 
- Public Member Functions inherited from VSTGUI::Interface
 Interface (const Interface &)=delete
 
 Interface (Interface &&)=delete
 
Interfaceoperator= (const Interface &)=delete
 
Interfaceoperator= (Interface &&)=delete
 
template<typename T >
const auto dynamicCast () const
 
template<typename T >
auto dynamicCast ()
 

Detailed Description

Window interface

Windows are created via IApplication::instance ().createWindow ()

Windows are automatically destroyed when they are closed.

Member Function Documentation

◆ activate()

virtual void VSTGUI::Standalone::IWindow::activate ( )
pure virtual

Activate the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ close()

virtual void VSTGUI::Standalone::IWindow::close ( )
pure virtual

Close the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getAutoSaveFrameName()

virtual const UTF8String& VSTGUI::Standalone::IWindow::getAutoSaveFrameName ( ) const
pure virtual

Get the auto save frame name of the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getController()

virtual const WindowControllerPtr& VSTGUI::Standalone::IWindow::getController ( ) const
pure virtual

Get the window controller. Can be nullptr.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getFocusViewRect()

virtual CRect VSTGUI::Standalone::IWindow::getFocusViewRect ( ) const
pure virtual

Get the rect of the current focus view in frame relative coordinates.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getPosition()

virtual CPoint VSTGUI::Standalone::IWindow::getPosition ( ) const
pure virtual

Get the position in global coordinates.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getScaleFactor()

virtual double VSTGUI::Standalone::IWindow::getScaleFactor ( ) const
pure virtual

Get the content scale factor.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getSize()

virtual CPoint VSTGUI::Standalone::IWindow::getSize ( ) const
pure virtual

Get the size of the client area.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getStyle()

virtual WindowStyle VSTGUI::Standalone::IWindow::getStyle ( ) const
pure virtual

Get the style of the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getTitle()

virtual const UTF8String& VSTGUI::Standalone::IWindow::getTitle ( ) const
pure virtual

Get the title of the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ getType()

virtual WindowType VSTGUI::Standalone::IWindow::getType ( ) const
pure virtual

Get the type of the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ hide()

virtual void VSTGUI::Standalone::IWindow::hide ( )
pure virtual

Hide the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ registerWindowListener()

virtual void VSTGUI::Standalone::IWindow::registerWindowListener ( IWindowListener listener)
pure virtual

Register a window listener.

There is no ownership involved here, so you have to make sure the listener is alive as long as the window lives. Listeners are automatically removed when the window is closed.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ setContentView()

virtual void VSTGUI::Standalone::IWindow::setContentView ( const SharedPointer< CFrame > &  frame)
pure virtual

Set content view.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ setPosition()

virtual void VSTGUI::Standalone::IWindow::setPosition ( const CPoint newPosition)
pure virtual

Set the position in global coordinates.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ setSize()

virtual void VSTGUI::Standalone::IWindow::setSize ( const CPoint newSize)
pure virtual

Set the size of the client area.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ setTitle()

virtual void VSTGUI::Standalone::IWindow::setTitle ( const UTF8String newTitle)
pure virtual

Set the window title.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ show()

virtual void VSTGUI::Standalone::IWindow::show ( )
pure virtual

Show the window.

Implemented in VSTGUI::Standalone::Detail::Window.

◆ unregisterWindowListener()

virtual void VSTGUI::Standalone::IWindow::unregisterWindowListener ( IWindowListener listener)
pure virtual

Unregister a window listener.

Implemented in VSTGUI::Standalone::Detail::Window.


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