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

KPty

  • kpty
kptydevice.h
Go to the documentation of this file.
1/* This file is part of the KDE libraries
2
3 Copyright (C) 2007 Oswald Buddenhagen <ossi@kde.org>
4
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
9
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to
17 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
19*/
20
21#ifndef kptydev_h
22#define kptydev_h
23
24#include "kpty.h"
25
26#include <QtCore/QIODevice>
27
28struct KPtyDevicePrivate;
29
30#define Q_DECLARE_PRIVATE_MI(Class, SuperClass) \
31 inline Class##Private* d_func() { return reinterpret_cast<Class##Private *>(SuperClass::d_ptr); } \
32 inline const Class##Private* d_func() const { return reinterpret_cast<const Class##Private *>(SuperClass::d_ptr); } \
33 friend class Class##Private;
34
38class KPTY_EXPORT KPtyDevice : public QIODevice, public KPty { //krazy:exclude=dpointer (via macro)
39 Q_OBJECT
40 Q_DECLARE_PRIVATE_MI(KPtyDevice, KPty)
41
42public:
43
47 KPtyDevice(QObject *parent = 0);
48
55 virtual ~KPtyDevice();
56
62 virtual bool open(OpenMode mode = ReadWrite | Unbuffered);
63
77 bool open(int fd, OpenMode mode = ReadWrite | Unbuffered);
78
82 virtual void close();
83
96 void setSuspended(bool suspended);
97
106 bool isSuspended() const;
107
111 virtual bool isSequential() const;
112
116 bool canReadLine() const;
117
121 bool atEnd() const;
122
126 qint64 bytesAvailable() const;
127
131 qint64 bytesToWrite() const;
132
133 bool waitForBytesWritten(int msecs = -1);
134 bool waitForReadyRead(int msecs = -1);
135
136
137Q_SIGNALS:
143 void readEof();
144
145protected:
146 virtual qint64 readData(char *data, qint64 maxSize);
147 virtual qint64 readLineData(char *data, qint64 maxSize);
148 virtual qint64 writeData(const char *data, qint64 maxSize);
149
150private:
151 Q_PRIVATE_SLOT(d_func(), bool _k_canRead())
152 Q_PRIVATE_SLOT(d_func(), bool _k_canWrite())
153};
154
155#endif
156
KPtyDevice::readEof
void readEof()
Emitted when EOF is read from the PTY.
KPtyDevice::canReadLine
bool canReadLine() const
Definition kptydevice.cpp:540
KPtyDevice::setSuspended
void setSuspended(bool suspended)
Sets whether the KPtyDevice monitors the pty for incoming data.
Definition kptydevice.cpp:576
KPtyDevice::isSequential
virtual bool isSequential() const
Definition kptydevice.cpp:535
KPtyDevice::bytesToWrite
qint64 bytesToWrite() const
Definition kptydevice.cpp:558
KPtyDevice::waitForReadyRead
bool waitForReadyRead(int msecs=-1)
Definition kptydevice.cpp:564
KPtyDevice::writeData
virtual qint64 writeData(const char *data, qint64 maxSize)
Definition kptydevice.cpp:603
KPtyDevice::isSuspended
bool isSuspended() const
Returns true if the KPtyDevice is not monitoring the pty for incoming data.
Definition kptydevice.cpp:582
KPtyDevice::readLineData
virtual qint64 readLineData(char *data, qint64 maxSize)
Definition kptydevice.cpp:596
KPtyDevice::readData
virtual qint64 readData(char *data, qint64 maxSize)
Definition kptydevice.cpp:589
KPtyDevice::waitForBytesWritten
bool waitForBytesWritten(int msecs=-1)
Definition kptydevice.cpp:570
KPtyDevice::bytesAvailable
qint64 bytesAvailable() const
Definition kptydevice.cpp:552
KPtyDevice::atEnd
bool atEnd() const
Definition kptydevice.cpp:546
KPtyDevice::KPtyDevice
KPtyDevice(QObject *parent=0)
Constructor.
Definition kptydevice.cpp:478
KPty::open
bool open()
Create a pty master/slave pair.
Definition kpty.cpp:194
KPty::KPty
KPty()
Constructor.
Definition kpty.cpp:177
KPty::close
void close()
Close the pty master/slave pair.
Definition kpty.cpp:446
QIODevice
QObject
kpty.h
Q_DECLARE_PRIVATE_MI
#define Q_DECLARE_PRIVATE_MI(Class, SuperClass)
Definition kptydevice.h:30
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KPty

Skip menu "KPty"
  • Main Page
  • 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