kpty.h

Go to the documentation of this file.

/* This file is part of the KDE libraries

    Copyright (C) 2003,2007 Oswald Buddenhagen <ossi@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef kpty_h
#define kpty_h

#include "kpty_export.h"

struct KPtyPrivate;
struct termios;

class KPTY_EXPORT KPty {
    Q_DECLARE_PRIVATE(KPty)

public:

  KPty();

  ~KPty();

  bool open();

  bool open(int fd);

  void close();

  void closeSlave();

  bool openSlave();

  void setCTty();

  void login(const char *user = 0, const char *remotehost = 0);

  void logout();

  bool tcGetAttr(struct ::termios *ttmode) const;

  bool tcSetAttr(struct ::termios *ttmode);

  bool setWinSize(int lines, int columns);

  bool setEcho(bool echo);

  const char *ttyName() const;

  int masterFd() const;

  int slaveFd() const;

protected:
  KPty(KPtyPrivate *d);

  KPtyPrivate * const d_ptr;
};

#endif