ASPiK SDK
VSTGUI::Standalone::Detail::Window Class Reference
Inheritance diagram for VSTGUI::Standalone::Detail::Window:
VSTGUI::Standalone::Detail::IPlatformWindowAccess VSTGUI::Standalone::Platform::IWindowDelegate VSTGUI::IMouseObserver VSTGUI::Standalone::IWindow VSTGUI::Standalone::ICommandHandler VSTGUI::Interface VSTGUI::Interface

Public Member Functions

bool init (const WindowConfiguration &config, const WindowControllerPtr &controller)
 
const WindowControllerPtr & getController () const override
 
CPoint getSize () const override
 
CPoint getPosition () const override
 
double getScaleFactor () const override
 
CRect getFocusViewRect () const override
 
const UTF8StringgetTitle () const override
 
WindowType getType () const override
 
WindowStyle getStyle () const override
 
const UTF8StringgetAutoSaveFrameName () const override
 
void setSize (const CPoint &newSize) override
 
void setPosition (const CPoint &newPosition) override
 
void setTitle (const UTF8String &newTitle) override
 
void setContentView (const SharedPointer< CFrame > &newFrame) override
 
void show () override
 
void hide () override
 
void close () override
 
void activate () override
 
void registerWindowListener (IWindowListener *listener) override
 
void unregisterWindowListener (IWindowListener *listener) override
 
InterfacePtr getPlatformWindow () const override
 
CPoint constraintSize (const CPoint &newSize) override
 
void onSizeChanged (const CPoint &newSize) override
 
void onPositionChanged (const CPoint &newPosition) override
 
void onShow () override
 
void onHide () override
 
void onClosed () override
 
bool canClose () override
 
void onActivated () override
 
void onDeactivated () override
 
bool canHandleCommand (const Command &command) override
 
bool handleCommand (const Command &command) override
 
void onMouseEntered (CView *view, CFrame *frame) override
 
void onMouseExited (CView *view, CFrame *frame) override
 
CMouseEventResult onMouseMoved (CFrame *frame, const CPoint &where, const CButtonState &buttons) override
 a mouse move event happend on the frame at position where. If the observer handles this, the event won't be propagated further
 
CMouseEventResult onMouseDown (CFrame *frame, const CPoint &where, const CButtonState &buttons) override
 a mouse down event happend on the frame at position where. If the observer handles this, the event won't be propagated further
 
- 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 ()
 

Member Function Documentation

◆ activate()

void VSTGUI::Standalone::Detail::Window::activate ( )
inlineoverridevirtual

Activate the window.

Implements VSTGUI::Standalone::IWindow.

◆ canHandleCommand()

bool VSTGUI::Standalone::Detail::Window::canHandleCommand ( const Command command)
overridevirtual

Check if command can be handled.

Implements VSTGUI::Standalone::ICommandHandler.

◆ close()

void VSTGUI::Standalone::Detail::Window::close ( )
inlineoverridevirtual

Close the window.

Implements VSTGUI::Standalone::IWindow.

◆ getAutoSaveFrameName()

const UTF8String& VSTGUI::Standalone::Detail::Window::getAutoSaveFrameName ( ) const
inlineoverridevirtual

Get the auto save frame name of the window.

Implements VSTGUI::Standalone::IWindow.

◆ getController()

const WindowControllerPtr& VSTGUI::Standalone::Detail::Window::getController ( ) const
inlineoverridevirtual

Get the window controller. Can be nullptr.

Implements VSTGUI::Standalone::IWindow.

◆ getFocusViewRect()

CRect VSTGUI::Standalone::Detail::Window::getFocusViewRect ( ) const
overridevirtual

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

Implements VSTGUI::Standalone::IWindow.

◆ getPosition()

CPoint VSTGUI::Standalone::Detail::Window::getPosition ( ) const
inlineoverridevirtual

Get the position in global coordinates.

Implements VSTGUI::Standalone::IWindow.

◆ getScaleFactor()

double VSTGUI::Standalone::Detail::Window::getScaleFactor ( ) const
inlineoverridevirtual

Get the content scale factor.

Implements VSTGUI::Standalone::IWindow.

◆ getSize()

CPoint VSTGUI::Standalone::Detail::Window::getSize ( ) const
inlineoverridevirtual

Get the size of the client area.

Implements VSTGUI::Standalone::IWindow.

◆ getStyle()

WindowStyle VSTGUI::Standalone::Detail::Window::getStyle ( ) const
inlineoverridevirtual

Get the style of the window.

Implements VSTGUI::Standalone::IWindow.

◆ getTitle()

const UTF8String& VSTGUI::Standalone::Detail::Window::getTitle ( ) const
inlineoverridevirtual

Get the title of the window.

Implements VSTGUI::Standalone::IWindow.

◆ getType()

WindowType VSTGUI::Standalone::Detail::Window::getType ( ) const
inlineoverridevirtual

Get the type of the window.

Implements VSTGUI::Standalone::IWindow.

◆ handleCommand()

bool VSTGUI::Standalone::Detail::Window::handleCommand ( const Command command)
overridevirtual

Handle command.

Implements VSTGUI::Standalone::ICommandHandler.

◆ hide()

void VSTGUI::Standalone::Detail::Window::hide ( )
inlineoverridevirtual

Hide the window.

Implements VSTGUI::Standalone::IWindow.

◆ registerWindowListener()

void VSTGUI::Standalone::Detail::Window::registerWindowListener ( IWindowListener listener)
overridevirtual

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.

Implements VSTGUI::Standalone::IWindow.

◆ setContentView()

void VSTGUI::Standalone::Detail::Window::setContentView ( const SharedPointer< CFrame > &  frame)
overridevirtual

Set content view.

Implements VSTGUI::Standalone::IWindow.

◆ setPosition()

void VSTGUI::Standalone::Detail::Window::setPosition ( const CPoint newPosition)
inlineoverridevirtual

Set the position in global coordinates.

Implements VSTGUI::Standalone::IWindow.

◆ setSize()

void VSTGUI::Standalone::Detail::Window::setSize ( const CPoint newSize)
overridevirtual

Set the size of the client area.

Implements VSTGUI::Standalone::IWindow.

◆ setTitle()

void VSTGUI::Standalone::Detail::Window::setTitle ( const UTF8String newTitle)
inlineoverridevirtual

Set the window title.

Implements VSTGUI::Standalone::IWindow.

◆ show()

void VSTGUI::Standalone::Detail::Window::show ( )
overridevirtual

Show the window.

Implements VSTGUI::Standalone::IWindow.

◆ unregisterWindowListener()

void VSTGUI::Standalone::Detail::Window::unregisterWindowListener ( IWindowListener listener)
overridevirtual

Unregister a window listener.

Implements VSTGUI::Standalone::IWindow.


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