• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Solid

  • Solid
  • SerialInterface
Public Types | Public Member Functions | Static Public Member Functions | Properties | List of all members
Solid::SerialInterface Class Reference

#include <serialinterface.h>

Inheritance diagram for Solid::SerialInterface:
Solid::DeviceInterface QObject

Public Types

enum  SerialType { Unknown = 0 , Platform , Usb }
 
- Public Types inherited from Solid::DeviceInterface
enum  Type {
  Unknown = 0 , GenericInterface = 1 , Processor = 2 , Block = 3 ,
  StorageAccess = 4 , StorageDrive = 5 , OpticalDrive = 6 , StorageVolume = 7 ,
  OpticalDisc = 8 , Camera = 9 , PortableMediaPlayer = 10 , NetworkInterface = 11 ,
  AcAdapter = 12 , Battery = 13 , Button = 14 , AudioInterface = 15 ,
  DvbInterface = 16 , Video = 17 , SerialInterface = 18 , SmartCardReader = 19 ,
  InternetGateway = 20 , NetworkShare = 21 , Last = 0xffff
}
 

Public Member Functions

virtual ~SerialInterface ()
 
virtual QVariant driverHandle () const
 
virtual int port () const
 
virtual SerialType serialType () const
 
- Public Member Functions inherited from Solid::DeviceInterface
virtual ~DeviceInterface ()
 
bool isValid () const
 

Static Public Member Functions

static Type deviceInterfaceType ()
 
- Static Public Member Functions inherited from Solid::DeviceInterface
static Type stringToType (const QString &type)
 
static QString typeDescription (Type type)
 
static QString typeToString (Type type)
 

Properties

QVariant driverHandle
 
int port
 
QString serialType
 

Additional Inherited Members

- Protected Member Functions inherited from Solid::DeviceInterface
 DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)
 
- Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate * d_ptr
 

Detailed Description

This device interface is available on serial interfaces.

Since
4.3

Definition at line 37 of file serialinterface.h.

Member Enumeration Documentation

◆ SerialType

enum Solid::SerialInterface::SerialType

This enum type defines the type of a serial interface.

  • Unknown : The type could not be determined
  • Platform : A built-in serial port
  • USB : A USB serial port
Since
4.3
Enumerator
Unknown 
Platform 
Usb 

Definition at line 96 of file serialinterface.h.

Constructor & Destructor Documentation

◆ ~SerialInterface()

Solid::SerialInterface::~SerialInterface ( )
virtual

Destroys a SerialInterface object.

Since
4.3

Definition at line 34 of file serialinterface.cpp.

Member Function Documentation

◆ deviceInterfaceType()

static Type Solid::SerialInterface::deviceInterfaceType ( )
inlinestatic

Get the Solid::DeviceInterface::Type of the SerialInterface device interface.

Returns
the SerialInterface device interface type
See also
Solid::Ifaces::Enums::DeviceInterface::Type
Since
4.3

Definition at line 74 of file serialinterface.h.

◆ driverHandle()

QVariant Solid::SerialInterface::driverHandle ( ) const
virtual

Retrieves the name of the interface in the system.

This name is system dependent, it allows to identify the interface in the system. For example it can be of the form "/dev/ttyS0" under Linux.

Returns
the interface name
Since
4.3

Definition at line 39 of file serialinterface.cpp.

◆ port()

int Solid::SerialInterface::port ( ) const
virtual

Retrieves the port number, e.g.

0 for the first COM port.

Returns
The port number of the serial device, or -1 if unknown.
Since
4.3

Definition at line 51 of file serialinterface.cpp.

◆ serialType()

Solid::SerialInterface::SerialType Solid::SerialInterface::serialType ( ) const
virtual

Retrieves the type of the serial device.

Examples for Linux are "usb" for USB based serial devices, or "platform" for built-in serial ports.

Returns
the type of the serial device
Since
4.3

Definition at line 45 of file serialinterface.cpp.

Property Documentation

◆ driverHandle

QVariant Solid::SerialInterface::driverHandle
read

Definition at line 37 of file serialinterface.h.

◆ port

int Solid::SerialInterface::port
read

Definition at line 37 of file serialinterface.h.

◆ serialType

QString Solid::SerialInterface::serialType
read

Definition at line 37 of file serialinterface.h.


The documentation for this class was generated from the following files:
  • serialinterface.h
  • serialinterface.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal