Class: Relisp::Overlay

Inherits:

Proxy

• Object
• Proxy
• Relisp::Overlay

Defined in:

lib/relisp/type_conversion/editing_types.rb

Overview

A proxy to an Emacs Overlay

Instance Attribute Summary

Attributes inherited from Proxy

#elisp_variable, #slave

Instance Method Summary

• #after_string ⇒ Object
• #after_string=(new_value) ⇒ Object
• #before_string ⇒ Object
• #before_string=(new_value) ⇒ Object
• #buffer ⇒ Object
• #category ⇒ Object
• #category=(new_value) ⇒ Object
• #delete ⇒ Object
• #display ⇒ Object
• #display=(new_value) ⇒ Object
• #end ⇒ Object
• #end=(new_end) ⇒ Object
• #evaporate ⇒ Object
• #evaporate=(new_value) ⇒ Object
• #face ⇒ Object
• #face=(new_value) ⇒ Object
• #help_echo ⇒ Object
• #help_echo=(new_value) ⇒ Object
• #initialize(*args) ⇒ Overlay constructor

  args can be any of these forms: * (symbol, slave = Relisp.default_slave) * (start, end, buffer = nil, front_advance = nil, rear_advance = nil, slave = Relisp.default_slave) * (start, end, buffer = nil, slave = Relisp.default_slave) * (start, end, slave = Relisp.default_slave).

• #insert_behind_hooks ⇒ Object
• #insert_behind_hooks=(new_value) ⇒ Object
• #insert_in_front_hooks ⇒ Object
• #insert_in_front_hooks=(new_value) ⇒ Object
• #intangible ⇒ Object
• #intangible=(new_value) ⇒ Object
• #invisible ⇒ Object
• #invisible=(new_value) ⇒ Object
• #keymap ⇒ Object
• #keymap=(new_value) ⇒ Object
• #local_map ⇒ Object
• #local_map=(new_value) ⇒ Object
• #modification_hooks ⇒ Object
• #modification_hooks=(new_value) ⇒ Object
• #mouse_face ⇒ Object
• #mouse_face=(new_value) ⇒ Object
• #move(new_start, new_end, new_buffer = nil) ⇒ Object
• #priority ⇒ Object
• #priority=(new_value) ⇒ Object
• #start ⇒ Object
• #start=(new_start) ⇒ Object
• #window ⇒ Object
• #window=(new_value) ⇒ Object

Methods inherited from Proxy

from_elisp, #to_elisp

Constructor Details

#initialize(*args) ⇒ Overlay

args can be any of these forms:

• (symbol, slave = Relisp.default_slave)

• (start, end, buffer = nil, front_advance = nil, rear_advance = nil, slave = Relisp.default_slave)

• (start, end, buffer = nil, slave = Relisp.default_slave)

• (start, end, slave = Relisp.default_slave)

When a symbol is given it is considered to be the name of a pre-existing overlay in the slave process. Otherwise a new overlay is created (make-overlay).

# File 'lib/relisp/type_conversion/editing_types.rb', line 993

def initialize(*args)
  super do |args|
    @slave.elisp_exec( "(setq #{@elisp_variable} (make-overlay #{args.join(' ')}))" )
  end
end

Instance Method Details

#after_string ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1143

def after_string
  get_property :after_string
end

#after_string=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1147

def after_string=(new_value)
  set_property :after_string, new_value
end

#before_string ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1135

def before_string
  get_property :before_string
end

#before_string=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1139

def before_string=(new_value)
  set_property :before_string, new_value
end

#buffer ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1007

def buffer
  call_on_self :overlay_buffer
end

#category ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1055

def category
  get_property :category
end

#category=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1059

def category=(new_value)
  set_property :category, new_value
end

#delete ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1011

def delete
  call_on_self :delete_overlay
end

#display ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1079

def display
  get_property :display
end

#display=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1083

def display=(new_value)
  set_property :display, new_value
end

#end ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1003

def end
  call_on_self :overlay_end
end

#end=(new_end) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1023

def end=(new_end)
  call_on_self :move_overlay, self.start, new_end
end

#evaporate ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1151

def evaporate
  get_property :evaporate
end

#evaporate=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1155

def evaporate=(new_value)
  set_property :evaporate, new_value
end

#face ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1063

def face
  get_property :face
end

#face=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1067

def face=(new_value)
  set_property :face, new_value
end

#help_echo ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1087

def help_echo
  get_property :help_echo
end

#help_echo=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1091

def help_echo=(new_value)
  set_property :help_echo, new_value
end

#insert_behind_hooks ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1111

def insert_behind_hooks
  get_property :insert_behind_hooks
end

#insert_behind_hooks=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1115

def insert_behind_hooks=(new_value)
  set_property :insert_behind_hooks, new_value
end

#insert_in_front_hooks ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1103

def insert_in_front_hooks
  get_property :insert_in_front_hooks
end

#insert_in_front_hooks=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1107

def insert_in_front_hooks=(new_value)
  set_property :insert_in_front_hooks, new_value
end

#intangible ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1127

def intangible
  get_property :intangible
end

#intangible=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1131

def intangible=(new_value)
  set_property :intangible, new_value
end

#invisible ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1119

def invisible
  get_property :invisible
end

#invisible=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1123

def invisible=(new_value)
  set_property :invisible, new_value
end

#keymap ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1167

def keymap
  get_property :keymap
end

#keymap=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1171

def keymap=(new_value)
  set_property :keymap, new_value
end

#local_map ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1159

def local_map
  get_property :local_map
end

#local_map=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1163

def local_map=(new_value)
  set_property :local_map, new_value
end

#modification_hooks ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1095

def modification_hooks
  get_property :help_echo
end

#modification_hooks=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1099

def modification_hooks=(new_value)
  set_property :help_echo, new_value
end

#mouse_face ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1071

def mouse_face
  get_property :mouse_face
end

#mouse_face=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1075

def mouse_face=(new_value)
  set_property :mouse_face, new_value
end

#move(new_start, new_end, new_buffer = nil) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1015

def move(new_start, new_end, new_buffer = nil)
  call_on_self :move_overlay, new_start, new_end, new_buffer
end

#priority ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1039

def priority
  get_property :priority
end

#priority=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1043

def priority=(new_value)
  set_property :priority, new_value
end

#start ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 999

def start
  call_on_self :overlay_start
end

#start=(new_start) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1019

def start=(new_start)
  call_on_self :move_overlay, new_start, self.end
end

#window ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1047

def window
  get_property :window
end

#window=(new_value) ⇒ Object

# File 'lib/relisp/type_conversion/editing_types.rb', line 1051

def window=(new_value)
  set_property :window, new_value
end