Blame doc/classes/posix.curses.chstr.html

Packit 437b5e
Packit 437b5e
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
Packit 437b5e
<html>
Packit 437b5e
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit 437b5e
<head>
Packit 437b5e
    <title>luaposix 33.3.0 Reference</title>
Packit 437b5e
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
Packit 437b5e
</head>
Packit 437b5e
<body>
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
	
Packit 437b5e
	
<big></big>
Packit 437b5e
	
Packit 437b5e
 
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e

Packit 437b5e

luaposix 33.3.0

Packit 437b5e
Packit 437b5e
    Packit 437b5e
      
  • Index
  • Packit 437b5e
    Packit 437b5e
    Packit 437b5e

    Contents

    Packit 437b5e
      Packit 437b5e
    • Methods
    • Packit 437b5e
    • Metamethods
    • Packit 437b5e
      Packit 437b5e
      Packit 437b5e
      Packit 437b5e

      Classes

      Packit 437b5e
        Packit 437b5e
          
      • posix.curses.chstr
      • Packit 437b5e
          
      • posix.curses.window
      • Packit 437b5e
        Packit 437b5e

        Modules

        Packit 437b5e
          Packit 437b5e
            
        • posix
        • Packit 437b5e
            
        • posix.ctype
        • Packit 437b5e
            
        • posix.curses
        • Packit 437b5e
            
        • posix.dirent
        • Packit 437b5e
            
        • posix.errno
        • Packit 437b5e
            
        • posix.fcntl
        • Packit 437b5e
            
        • posix.fnmatch
        • Packit 437b5e
            
        • posix.getopt
        • Packit 437b5e
            
        • posix.glob
        • Packit 437b5e
            
        • posix.grp
        • Packit 437b5e
            
        • posix.libgen
        • Packit 437b5e
            
        • posix.poll
        • Packit 437b5e
            
        • posix.pwd
        • Packit 437b5e
            
        • posix.sched
        • Packit 437b5e
            
        • posix.signal
        • Packit 437b5e
            
        • posix.stdio
        • Packit 437b5e
            
        • posix.stdlib
        • Packit 437b5e
            
        • posix.sys.msg
        • Packit 437b5e
            
        • posix.sys.resource
        • Packit 437b5e
            
        • posix.sys.socket
        • Packit 437b5e
            
        • posix.sys.stat
        • Packit 437b5e
            
        • posix.sys.statvfs
        • Packit 437b5e
            
        • posix.sys.time
        • Packit 437b5e
            
        • posix.sys.times
        • Packit 437b5e
            
        • posix.sys.utsname
        • Packit 437b5e
            
        • posix.sys.wait
        • Packit 437b5e
            
        • posix.syslog
        • Packit 437b5e
            
        • posix.termio
        • Packit 437b5e
            
        • posix.time
        • Packit 437b5e
            
        • posix.unistd
        • Packit 437b5e
            
        • posix.utime
        • Packit 437b5e
          Packit 437b5e

          Examples

          Packit 437b5e
            Packit 437b5e
              
          • curses.lua
          • Packit 437b5e
              
          • dir.lua
          • Packit 437b5e
              
          • fork.lua
          • Packit 437b5e
              
          • fork2.lua
          • Packit 437b5e
              
          • getopt.lua
          • Packit 437b5e
              
          • glob.lua
          • Packit 437b5e
              
          • limit.lua
          • Packit 437b5e
              
          • lock.lua
          • Packit 437b5e
              
          • netlink-uevent.lua
          • Packit 437b5e
              
          • ping.lua
          • Packit 437b5e
              
          • poll.lua
          • Packit 437b5e
              
          • rt_sched.lua
          • Packit 437b5e
              
          • signal.lua
          • Packit 437b5e
              
          • socket.lua
          • Packit 437b5e
              
          • termios.lua
          • Packit 437b5e
              
          • tree.lua
          • Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Class posix.curses.chstr

            Packit 437b5e

            Curses attributed string buffers.

            Packit 437b5e

            An array of characters, plus associated curses attributes and

            Packit 437b5e
            colors at each position.

            Packit 437b5e
            Packit 437b5e

            Although marginally useful alone, the constants used to set colors

            Packit 437b5e
            and attributes in chstr buffers are not defined until after
            Packit 437b5e
            curses.initscr () has been called.

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Methods

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:dup ()
            Packit 437b5e
            	Duplicate chstr.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:get (o)
            Packit 437b5e
            	Get information from the chstr.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:len (cs)
            Packit 437b5e
            	Retrieve chstr length.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:set_ch (o, int[, attr=A_NORMAL[, rep=1]])
            Packit 437b5e
            	Set a character in the buffer.
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:set_str (o, s[, attr=A_NORMAL[, rep=1]])
            Packit 437b5e
            	Change the contents of the chstr.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e

            Metamethods

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	posix.curses.chstr:__call (len)
            Packit 437b5e
            	Initialise a new chstr.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Packit 437b5e

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Methods

            Packit 437b5e
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                posix.curses.chstr:dup ()
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                Duplicate chstr.
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Returns:

            Packit 437b5e
                
              Packit 437b5e
              Packit 437b5e
                         chstr
              Packit 437b5e
                      duplicate of cs
              Packit 437b5e
                  
              Packit 437b5e
              Packit 437b5e
              Packit 437b5e
              Packit 437b5e
                  

              Usage:

              Packit 437b5e
                  
                Packit 437b5e
                        
                dup = cs:dup ()
                Packit 437b5e
                    
                Packit 437b5e
                Packit 437b5e
                Packit 437b5e
                    
                Packit 437b5e
                    
                Packit 437b5e
                    posix.curses.chstr:get (o)
                Packit 437b5e
                    
                Packit 437b5e
                    
                Packit 437b5e
                    Get information from the chstr.
                Packit 437b5e
                Packit 437b5e
                Packit 437b5e
                    

                Parameters:

                Packit 437b5e
                    
                  Packit 437b5e
                          
                • o
                • Packit 437b5e
                              int
                  Packit 437b5e
                           offset from start of cs
                  Packit 437b5e
                          
                  Packit 437b5e
                      
                  Packit 437b5e
                  Packit 437b5e
                      

                  Returns:

                  Packit 437b5e
                      
                    Packit 437b5e
                            
                  1. Packit 437b5e
                               int
                    Packit 437b5e
                            character at offset o in cs
                    Packit 437b5e
                            
                  2. Packit 437b5e
                               int
                    Packit 437b5e
                            bitwise-OR of attributes at offset o in cs
                    Packit 437b5e
                            
                  3. Packit 437b5e
                               int
                    Packit 437b5e
                            colorpair at offset o in cs
                    Packit 437b5e
                        
                    Packit 437b5e
                    Packit 437b5e
                    Packit 437b5e
                    Packit 437b5e
                        

                    Usage:

                    Packit 437b5e
                        
                      Packit 437b5e
                              
                      Packit 437b5e
                        cs = curses.chstr (10)
                      Packit 437b5e
                        cs:set_ch(0, 'A', curses.A_BOLD, 10)
                      Packit 437b5e
                        --> 65 2097152 0
                      Packit 437b5e
                        print (cs:get (9))
                      Packit 437b5e
                          
                      Packit 437b5e
                      Packit 437b5e
                      Packit 437b5e
                          
                      Packit 437b5e
                          
                      Packit 437b5e
                          posix.curses.chstr:len (cs)
                      Packit 437b5e
                          
                      Packit 437b5e
                          
                      Packit 437b5e
                          Retrieve chstr length.
                      Packit 437b5e
                      Packit 437b5e
                      Packit 437b5e
                          

                      Parameters:

                      Packit 437b5e
                          
                        Packit 437b5e
                                
                      • cs
                      • Packit 437b5e
                                    chstr
                        Packit 437b5e
                                 buffer to act on
                        Packit 437b5e
                                
                        Packit 437b5e
                            
                        Packit 437b5e
                        Packit 437b5e
                            

                        Returns:

                        Packit 437b5e
                            
                          Packit 437b5e
                          Packit 437b5e
                                     int
                          Packit 437b5e
                                  length of cs
                          Packit 437b5e
                              
                          Packit 437b5e
                          Packit 437b5e
                          Packit 437b5e
                          Packit 437b5e
                              

                          Usage:

                          Packit 437b5e
                              
                            Packit 437b5e
                                    
                            Packit 437b5e
                              cs = curses.chstr (123)
                            Packit 437b5e
                              --> 123
                            Packit 437b5e
                              print (cs:len ())
                            Packit 437b5e
                                
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                                
                            Packit 437b5e
                                
                            Packit 437b5e
                                posix.curses.chstr:set_ch (o, int[, attr=A_NORMAL[, rep=1]])
                            Packit 437b5e
                                
                            Packit 437b5e
                                
                            Packit 437b5e
                                Set a character in the buffer.
                            Packit 437b5e
                            ch* can be a one-character string, or an integer from string.byte
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                                

                            Parameters:

                            Packit 437b5e
                                
                              Packit 437b5e
                                      
                            • o
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       offset to start of change
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • int
                            • Packit 437b5e
                                      |string ch character to insert
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • attr
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       attributes for changed elements
                              Packit 437b5e
                                       (default A_NORMAL)
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • rep
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       repeat count
                              Packit 437b5e
                                       (default 1)
                              Packit 437b5e
                                      
                              Packit 437b5e
                                  
                              Packit 437b5e
                              Packit 437b5e
                              Packit 437b5e
                              Packit 437b5e
                              Packit 437b5e
                                  

                              Usage:

                              Packit 437b5e
                                  
                                Packit 437b5e
                                        
                                Packit 437b5e
                                  -- Write a bold 'A' followed by normal 'a' chars to a new buffer
                                Packit 437b5e
                                  size = 10
                                Packit 437b5e
                                  cs = curses.chstr (size)
                                Packit 437b5e
                                  cs:set_ch(0, 'A', curses.A_BOLD)
                                Packit 437b5e
                                  cs:set_ch(1, 'a', curses.A_NORMAL, size - 1)
                                Packit 437b5e
                                    
                                Packit 437b5e
                                Packit 437b5e
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    posix.curses.chstr:set_str (o, s[, attr=A_NORMAL[, rep=1]])
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    
                                Packit 437b5e
                                    Change the contents of the chstr.
                                Packit 437b5e
                                Packit 437b5e
                                Packit 437b5e
                                    

                                Parameters:

                                Packit 437b5e
                                    
                                  Packit 437b5e
                                          
                                • o
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           offset to start of change
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • s
                                • Packit 437b5e
                                              string
                                  Packit 437b5e
                                           characters to insert into cs at o
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • attr
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           attributes for changed elements
                                  Packit 437b5e
                                           (default A_NORMAL)
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                          
                                • rep
                                • Packit 437b5e
                                              int
                                  Packit 437b5e
                                           repeat count
                                  Packit 437b5e
                                           (default 1)
                                  Packit 437b5e
                                          
                                  Packit 437b5e
                                      
                                  Packit 437b5e
                                  Packit 437b5e
                                  Packit 437b5e
                                  Packit 437b5e
                                  Packit 437b5e
                                      

                                  Usage:

                                  Packit 437b5e
                                      
                                    Packit 437b5e
                                            
                                    Packit 437b5e
                                      cs = curses.chstr (10)
                                    Packit 437b5e
                                      cs:set_str(0, "0123456789", curses.A_BOLD)
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                        

                                    Metamethods

                                    Packit 437b5e
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        posix.curses.chstr:__call (len)
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        Initialise a new chstr.
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                        

                                    Parameters:

                                    Packit 437b5e
                                        
                                      Packit 437b5e
                                              
                                    • len
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               buffer length
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                          
                                      Packit 437b5e
                                      Packit 437b5e
                                          

                                      Returns:

                                      Packit 437b5e
                                          
                                        Packit 437b5e
                                        Packit 437b5e
                                                   chstr
                                        Packit 437b5e
                                                a new chstr filled with spaces
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                            

                                        Usage:

                                        Packit 437b5e
                                            
                                          Packit 437b5e
                                                  
                                          cs = curses.chstr (10)
                                          Packit 437b5e
                                              
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                          Packit 437b5e
                                           
                                          Packit 437b5e
                                           
                                          Packit 437b5e
                                          Packit 437b5e
                                          generated by LDoc 1.4.3
                                          Packit 437b5e
                                          Last updated 2015-03-01 09:06:02 
                                          Packit 437b5e
                                           
                                          Packit 437b5e
                                           
                                          Packit 437b5e
                                          </body>
                                          Packit 437b5e
                                          </html>