Class: Neovim::Window::Cursor

Inherits:
Object
  • Object
show all
Defined in:
lib/neovim/window.rb

Instance Method Summary collapse

Constructor Details

#initialize(window) ⇒ Cursor

Returns a new instance of Cursor.



14
15
16
 
# File 'lib/neovim/window.rb', line 14

def initialize(window)
  @window = window
end

Instance Method Details

#column ⇒ Fixnum

Note:

Column numbers are 1-indexed

Get the cursor’s column number.

Returns:

  • (Fixnum) 


59
60
61
 
# File 'lib/neovim/window.rb', line 59

def column
  coordinates[1]
end

#column=(n) ⇒ Fixnum

Note:

Column numbers are 1-indexed

Set the cursor’s column number.

Parameters:

  • n (Fixnum)

Returns:

  • (Fixnum) 


68
69
70
71
 
# File 'lib/neovim/window.rb', line 68

def column=(n)
  self.coordinates = [line, n]
  n
end

#coordinates ⇒ Array<Fixnum>

Note:

coordinates are 1-indexed

Get the current coordinates of the cursor.

Returns:

  • (Array<Fixnum>) 


22
23
24
 
# File 'lib/neovim/window.rb', line 22

def coordinates
  @window.get_cursor
end

#coordinates=(coords) ⇒ Array<Fixnum>

Note:

coordinates are 1-indexed

Set the coordinates of the cursor.

Examples:

Move the cursor to line 1, column 2

window.cursor.coordinates = [1, 2]

Parameters:

  • coords (Array<Fixnum>) —

    The coordinates as a pair of integers

Returns:

  • (Array<Fixnum>) 


33
34
35
 
# File 'lib/neovim/window.rb', line 33

def coordinates=(coords)
  @window.set_cursor(coords)
end

#line ⇒ Fixnum

Note:

Line numbers are 1-indexed

Get the cursor’s line number.

Returns:

  • (Fixnum) 


41
42
43
 
# File 'lib/neovim/window.rb', line 41

def line
  coordinates[0]
end

#line=(n) ⇒ Fixnum

Note:

Line numbers are 1-indexed

Set the cursor’s line number.

Parameters:

  • n (Fixnum)

Returns:

  • (Fixnum) 


50
51
52
53
 
# File 'lib/neovim/window.rb', line 50

def line=(n)
  self.coordinates = [n, column]
  n
end