Terminal Class Reference

Properties
alias	findBar
alias	fontMetrics
alias	kterminal
alias	menu
alias	readOnly
alias	session
alias	terminalSize
size	virtualResolution

Signals
void	clicked ()
void	keyPressed (var event)
void	urlsDropped (var urls)

Public Member Functions
void	forceActiveFocus ()
void	toggleSearchBar ()

Detailed Description

A terminal emulator console with built-in support for touch and keyboard inputs, and many other features.

Demo of the Terminal control

Features

This control has a pack of built-in functionality making it ready for embedding it into any other application. A quick overview includes support for touch gestures for navigation, scrollbar, search and find, contextual menu actions and keyboard shortcuts.

Note

For creating your own implementation you can look into using the exposed classes QMLTermWidget and QMLTermSession.

import QtQuick
import QtQuick.Controls
 
import org.mauikit.controls as Maui
 
import org.mauikit.terminal as Term
 
Maui.ApplicationWindow
{
   id: root
 
   Maui.Page
   {
       Maui.Controls.showCSD: true
       anchors.fill: parent
 
       Term.Terminal
       {
           anchors.fill: parent
       }
   }
}

Definition at line 43 of file Terminal.qml.

Property Documentation

findBar

alias Terminal::findBar

read

Alias to the TextField used for handling the search queries.

Remarks

This property is read-only

It is exposed to allow appending action entries, for example.

Definition at line 78 of file Terminal.qml.

fontMetrics

alias Terminal::fontMetrics

read

See also

TerminalDisplay::fontMetricts

Remarks

This property is read-only

Definition at line 99 of file Terminal.qml.

kterminal

alias Terminal::kterminal

read

Alias to the terminal display object.

Remarks

This property is read-only

Definition at line 66 of file Terminal.qml.

menu

alias Terminal::menu

read

The content of the contextual menu.

A set of default actions is already added, to append more actions use this property.

menu: [
Action { text: "Action1" },
MenuItem {text: "Action2"}
]

Definition at line 89 of file Terminal.qml.

readOnly

alias Terminal::readOnly

read

See also

Konsole::TerminalDisplay::readOnly

Definition at line 55 of file Terminal.qml.

session

alias Terminal::session

read

Alias to the emulated terminal session.

Remarks

This property is read-only

Definition at line 72 of file Terminal.qml.

terminalSize

alias Terminal::terminalSize

read

See also

TerminalDisplay::terminalSize

Remarks

This property is read-only

Definition at line 94 of file Terminal.qml.

virtualResolution

size Terminal::virtualResolution

read

The resolution size of the emulated terminal display.

Remarks

This property is read-only

Definition at line 60 of file Terminal.qml.

Member Function Documentation

clicked

void Terminal::clicked ( )

signal

Emitted when the terminal control area has been clicked.

forceActiveFocus()

void Terminal::forceActiveFocus

(

)

Force to focus the terminal display for entering input.

keyPressed

void Terminal::keyPressed ( var event )

signal

Emitted when a keyboard shortcut has been triggered and it is not one of the default ones that are recognized.

Parameters

event

Object with the event information

toggleSearchBar()

void Terminal::toggleSearchBar

(

)

Toggle the search text field bar.

urlsDropped

void Terminal::urlsDropped ( var urls )

signal

Emitted when a drag&drop action has been performed and the drop contains valid URLs.

Parameters

urls	The list of URLs dropped

---

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

• Terminal.qml