conchan.h

Go to the documentation of this file.

/*
 * conchan.h
 *
 * Console I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 31101 $
 * $Author: rjongbloed $
 * $Date: 2013-12-18 12:36:42 +1100 (Wed, 18 Dec 2013) $
 */

#ifndef PTLIB_CONSOLECHANNEL_H
#define PTLIB_CONSOLECHANNEL_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

P_PUSH_MSVC_WARNINGS(4250)


// Console Channel


class PConsoleChannel : public PChannel
{
  PCLASSINFO(PConsoleChannel, PChannel);

  public:
    enum ConsoleType {
      StandardInput,
      StandardOutput,
      StandardError
    };

    enum {
      KeyLeft = 0x10000, // Larger than possible Unicode character return
      KeyRight,
      KeyUp,
      KeyDown,
      KeyPageUp,
      KeyPageDown,
      KeyHome,
      KeyEnd,
      KeyBackSpace,
      KeyDelete,
      KeyInsert,

      KeyFuncBase = 0x10100,
      KeyF1 = KeyFuncBase+1,
      KeyF2,
      KeyF3,
      KeyF4,
      KeyF5,
      KeyF6,
      KeyF7,
      KeyF8,
      KeyF9,
      KeyF10,
      KeyF11,
      KeyF12,
      // Additional function keys have codes from here

      MouseEvent = 0x40000000,
      MouseButton1 = 1,         
      MouseButton2 = 2,         
      MouseButton3 = 4,         
      MouseButton4 = 8,         
      MouseClickShift = 4,      
      MouseDoubleClick = 0x80,  
      MouseShiftKey = 0x100,    
      MouseCtrlKey = 0x100,     
      MouseAltKey = 0x200,      
      MouseRowShift = 20,       
      MouseColShift = 12,       
    };


    PConsoleChannel();

    PConsoleChannel(
      ConsoleType type  
    );

    virtual PString GetName() const;

    virtual PBoolean Close();

    virtual int ReadChar();

    virtual bool SetLocalEcho(
      bool localEcho
    );

    virtual bool SetLineBuffered(
      bool lineBuffered
    );

    virtual PBoolean Open(
      ConsoleType type  
    );


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/conchan.h"
#else
#include "unix/ptlib/conchan.h"
#endif

};


#endif // PTLIB_CONSOLECHANNEL_H


// End Of File ///////////////////////////////////////////////////////////////