summaryrefslogblamecommitdiff
path: root/src/lib/evas/canvas/efl_input_key.eo
blob: f75d2b166658080fb96c7272daa94173ae119152 (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                                  

                                                                     




                                                                
                                                                        




                                    
                                     

          
                         




                                      
                                             






                                                                              
                                                                  

          
                                





                                                                              
                                                        




                                         
                                       



               
                       
                             
                            
                            
                              







                                                                            





                                               

    
class Efl.Input.Key extends Efl.Object implements Efl.Input.Event, Efl.Input.State
{
   [[Represents a single key event from a keyboard or similar device.
   ]]
   methods {
      @property pressed {
         [[$true if the key is down, $false if it is released.]]
         values {
            val: bool; [[$true if the key is pressed, $false otherwise]]
         }
      }
      @property key_name {
         [[Name string of the key.]]
         values {
            val: string; [[Key name]]
         }
      }
      @property key_sym {
         [[Logical key.

           Eg. Shift + 1 = exclamation
         ]]
         values {
            val: string; [[Logical key name]]
         }
      }
      @property string {
         [[A UTF8 string if this keystroke has produced a visible string to be
           added.
         ]]
         values {
            val: string; [[Visible string from key press in UTF8]]
         }
      }
      @property compose_string {
         [[A UTF8 string if this keystroke has modified a string in the middle
           of being composed.

           Note: This string replaces the previous one
         ]]
         values {
            val: string; [[Composed key string in UTF8]]
         }
      }
      @property key_code {
         [[Key scan code numeric value.]]
         values {
            val: int; [[Key scan code]]
         }
      }
   }
   implements {
      class.destructor;
      Efl.Object.constructor;
      Efl.Object.destructor;
      Efl.Input.Event.reset;
      Efl.Duplicate.duplicate;
         [[Creates a copy of this event. @Efl.Input.Event.fake is $true.

           The returned event object is similar to the given object in most
           ways except that @Efl.Input.Event.fake will be $true.

           Note: A reference is given to the caller. In order to avoid leaks
           the C API users should call $efl_unref() after use.
         ]]
      Efl.Input.Event.timestamp { get; set; }
      Efl.Input.Event.fake { get; }
      Efl.Input.Event.event_flags { get; set; }
      Efl.Input.Event.device { get; set; }
      Efl.Input.State.modifier_enabled { get; }
      Efl.Input.State.lock_enabled { get; }
   }
}