BaseWindow

Search for usage in LXR

BaseWindow Class Reference
Inheritance diagram for BaseWindow:

Properties

alias content
 
bool isDialog
 
bool isFullScreen
 
bool isMaximized
 
bool isPortrait
 
bool isWide
 
- Properties inherited from ApplicationWindow
alias pageStack
 

Public Member Functions

void notify (icon, title, body, callback, buttonText)
 
void toggleFullscreen ()
 
void toggleMaximized ()
 
- Public Member Functions inherited from QtQuick.Window
 afterAnimating ()
 
 alert (int msec)
 
 close ()
 
 closing (CloseEvent close)
 
 frameSwapped ()
 
 hide ()
 
 lower ()
 
 raise ()
 
 requestActivate ()
 
 sceneGraphError (SceneGraphError error, QString message)
 
 show ()
 
 showFullScreen ()
 
 showMaximized ()
 
 showMinimized ()
 
 showNormal ()
 
- Public Member Functions inherited from ApplicationWindow
void about ()
 
void setAndroidStatusBarColor ()
 

Detailed Description

A base window implementation for window dialogs and the main application window.

For using a detached dialog window use the WindowDialog control.

Definition at line 29 of file BaseWindow.qml.

Property Documentation

◆ content

alias BaseWindow::content
read

Items to be placed inside the ApplicationWindow.

Remarks
This is the default property

This is used as the default container, and it helps to correctly mask the contents when using CSD with rounded border corners.

Definition at line 46 of file BaseWindow.qml.

◆ isDialog

bool BaseWindow::isDialog
read

Definition at line 48 of file BaseWindow.qml.

◆ isFullScreen

bool BaseWindow::isFullScreen
read

Convenient property to check if the application window is in a full screen mode.

Remarks
This property is read-only

Definition at line 67 of file BaseWindow.qml.

◆ isMaximized

bool BaseWindow::isMaximized
read

Convenient property to check if the application window surface is maximized.

Remarks
This property is read-only

Definition at line 62 of file BaseWindow.qml.

◆ isPortrait

bool BaseWindow::isPortrait
read

Convenient property to check if the application window is in portrait mode, otherwise it means it is in landscape mode.

Remarks
This property is read-only

Definition at line 72 of file BaseWindow.qml.

◆ isWide

bool BaseWindow::isWide
read

Determines when the application window size is wide enough.

This property can be changed to any arbitrary condition. This will affect how some controls are positioned and displayed - as for a true wide value, it will assume there is more space to place contents, or for a false value it will work in the opposite way. Keep in mind this property is widely used in other MauiKit components to determined if items should be hidden, collapsed, or expanded, etc.

Definition at line 57 of file BaseWindow.qml.

Member Function Documentation

◆ notify()

void BaseWindow::notify ( icon ,
title ,
body ,
callback ,
buttonText  )

Send an inline notification.

Parameters
iconicon name to be used
titlethe notification title
bodythe message body of the notification
callbacka callback function to be triggered when the action button is pressed, this is represented as a button
buttonTextthe text associated to the previous callback function, to be used in the button

◆ toggleFullscreen()

void BaseWindow::toggleFullscreen ( )

Switch between full-screen mode and normal mode.

◆ toggleMaximized()

void BaseWindow::toggleMaximized ( )

Switch between maximized and normal state.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 12:00:22 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.