-------------------------------------------------------------------
--           RAPID - RAPID ADA PORTABLE INTERFACE DESIGNER         
--           MCC GUI PACKAGE LIBRARY                               
--           Copyright (C) 1999 Martin C. Carlisle.                
--                                                                 
-- RAPID is free software;  you can  redistribute it  and/or modify
-- it under terms of the  GNU General Public License as published  
-- by the Free Software  Foundation;  either version 2,  or (at your
-- option) any later version.  RAPID 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 General Public License for more details.  
-- You should have  received  a copy of the GNU General Public License
-- distributed with RAPID; see file COPYING.  If not, write to the 
-- Free Software Foundation,  59 Temple Place - Suite 330,  Boston, 
-- MA 02111-1307, USA.                                                 
--                                                                     
-- As a special exception, if other files instantiate generics from
-- this unit, or you link this unit with other files to produce an 
-- executable, this unit does not by itself cause the resulting 
-- executable to be covered by the GNU General Public License.  
-- This exception does not however invalidate any other reasons 
-- why the executable file might be covered by the GNU Public 
-- License.  This exception does not apply to executables which
-- are GUI design tools, or that could act as a replacement
-- for RAPID.
------------------------------------------------------------------------------
-- This file is by:
--    David Caswell
--    Michael Chiaramonte
--
-- A Text Window is a multi-line text entry box.
------------------------------------------------------------------------------
with Mcc.Gui.Container;
package Mcc.Gui.Widget.Text_Window is

   type Text_Window is new Widget with null record; 
   type Text_Window_Pointer is access all Text_Window'Class; 
   ------------------------------------------------
   -- procedure Create
   --
   -- create a text window at a location within a container
   ------------------------------------------------
   procedure Create (
         Obj                  : in out Text_Window;                       
         Parent               : in     Mcc.Gui.Container.Container'Class; 
         X                    : in     Integer;                           
         Y                    : in     Integer;                           
         Width                : in     Natural;                           
         Height               : in     Natural;                           
         Horizontal_Scrollbar : in     Boolean;                           
         Vertical_Scrollbar   : in     Boolean                            ); 

   ------------------------------------------------
   -- procedure Set_Text
   --
   -- Set text for a text entry
   ------------------------------------------------
   procedure Set_Text (
         Obj  : in out Text_Window; 
         Text : in     String       ); 

   ------------------------------------------------
   -- procedure Set_Text
   --
   -- Set text for a text entry using
   -- image of integer (w/o leading spaces)
   ------------------------------------------------
   procedure Set_Text (
         Obj  : in out Text_Window; 
         Text : in     Integer      ); 

   ------------------------------------------------
   -- procedure Clear
   --
   -- Clear text entry
   ------------------------------------------------
   procedure Clear (
         Obj : in out Text_Window ); 


   procedure Find (Obj: in out Text_Window; ToFind: in string);

   procedure Replace (
      Obj       : in out Text_Window; 
      ToFind    : in     string; 
      ToReplace : in     string; 
      ReplaceAll: in     boolean);

   ------------------------------------------------
   -- Procedure Select_All
   --
   -- Highlight the entire window
   ------------------------------------------------
   procedure Select_All(Obj: in out Text_Window);

   ------------------------------------------------
   -- Procedure Paste
   --
   -- Places whatever is on the clipoard to window
   ------------------------------------------------
   procedure Paste (
         Obj : in out Text_Window ); 

   ------------------------------------------------
   -- Procedure Copy_Cut
   --
   -- Places any selected text to clipboard
   -- If wanted deleted as well select cut-true
   ------------------------------------------------   
   procedure Copy_Cut (        
         Cut : in     Boolean     := False ); 

   ------------------------------------------------
   -- function Get_Text_Length
   --
   -- get length of text currently in entry
   ------------------------------------------------
   function Get_Text_Length (
         Obj : in     Text_Window ) 
     return Natural; 

   ------------------------------------------------
   -- procedure Highlight
   --
   -- Highlight text entry from start to stop
   -- start and end are positions between characters
   -- 0 is before the first character.  If start=stop
   -- then this procedure moves the cursor
   ------------------------------------------------
   procedure Highlight (
         Obj : in out Text_Window ); 
   procedure Highlight (
         Obj   : in out Text_Window; 
         Start : in     Natural;     
         Stop  : in     Natural      ); 

   ------------------------------------------------
   -- function(s) Get_Text 
   --
   -- return contents of text entry as integer, float 
   -- or string
   ------------------------------------------------
   function Get_Text (
         Obj : in     Text_Window ) 
     return String; 
   function Get_Text (
         Obj : in     Text_Window ) 
     return Integer; 
   function Get_Text (
         Obj : in     Text_Window ) 
     return Float; 

   ------------------------------------------------
   -- function get_line
   --
   -- Gets the line located on line
   -- number line.
   ------------------------------------------------

   function Get_Line (
         Obj  : in     Text_Window; 
         Line : in     Integer      ) 
     return String; 

   ------------------------------------------------
   -- function get_line
   --
   -- Gets the line located on the line
   -- that is marked with the insertion cursor.
   ------------------------------------------------

   function Get_Line (
         Obj : in     Text_Window ) 
     return String; 

   ------------------------------------------------
   -- function get_line
   --
   -- Gets the line located on the line
   -- that is marked with the insertion cursor.
   ------------------------------------------------

   function Last_line(Obj : in Text_Window ) return integer;
   
   ------------------------------------------------
   -- function get_line
   --
   -- Gets the line located on the line
   -- that is marked with the insertion cursor.
   ------------------------------------------------

   ------------------------------------------------
   -- procedure put_line
   --
   -- puts line to the line located on line
   -- number line.
   ------------------------------------------------
   procedure change_insert(Obj: in out Text_window; change: in integer);

   ------------------------------------------------
   -- procedure put_line
   --
   -- puts line to the line located on line
   -- number line.
   ------------------------------------------------

   procedure Put_Line (
         Obj  : in out Text_Window; 
         Line : in     Integer;     
         Str  : in     String       ); 
   ------------------------------------------------
   -- procedure put_line
   --
   -- puts line to the line
   -- that is marked with the insertion cursor.
   ------------------------------------------------

   procedure Put_Line (
         Obj : in out Text_Window; 
         Str : in     String       ); 

   ------------------------------------------------
   -- procedure del_line
   --
   -- deletes the line
   -- that is marked with the insertion cursor.
   ------------------------------------------------

   procedure Del_Line (
         Obj : in out Text_Window ); 

   ------------------------------------------------
   -- procedure(s) import_Text 
   --
   -- Imports text from file into edit 
   -- window. Needs opened file_type.
   ------------------------------------------------

   procedure Import_Text (
         Obj  : in out Text_Window; 
         File : in     String       ); 

   ------------------------------------------------
   -- procedure(s) Export_Text 
   --
   -- Imports text from file into edit 
   -- window. Needs opened file_type.
   ------------------------------------------------

   procedure Export_Text (
         Obj  : in out Text_Window; 
         File : in     String       ); 
         
   procedure Goto_Line (Obj: in out Text_Window;num: in integer);
   procedure Goto_Line_Col (Obj: in out Text_Window;num,col: in integer);
   function Line_Number(Obj : in Text_Window) return Integer; 
   function Column_Number(Obj: in Text_Window) return Integer;
   procedure foc(Obj: in Text_Window);
   procedure update;
   procedure put_screen(Obj: in out Text_Window);
   procedure get_screen(Obj: in out Text_Window);
   procedure init_screen(Obj: in out Text_Window);
   procedure remove_next(Obj: in out Text_Window);
   
   function color_box return string;

   procedure Update_Line (
         S   : in     String;      
         Obj : in out Text_Window; 
         L   : in     Integer      ); 

   Window : Text_Window;  
   

end Mcc.Gui.Widget.Text_Window;