Class: Weechat::Modifier

Inherits:

Hook

• Object
• Hook
• Weechat::Modifier

Defined in:

lib/weechat/modifier.rb

Direct Known Subclasses

Weechat::Modifiers::Print

Instance Attribute Summary

• #modifier ⇒ Object readonly

  Returns the value of attribute modifier.

Attributes inherited from Hook

#callback, #id

Attributes included from Pointer

#ptr

Class Method Summary

• .call(modifier, data, string) ⇒ Object (also: exec)
• .inherited(by) ⇒ Object

Instance Method Summary

• #exec ⇒ Object
• #initialize(modifier, &callback) ⇒ Modifier constructor

  A new instance of Modifier.

Methods inherited from Hook

#call, compute_free_id, find_by_id, #hooked?, hooks, init, register, #unhook, unhook, unhook_all, unregister

Methods included from Pointer

#==, #hash, #inspect, #to_s

Constructor Details

#initialize(modifier, &callback) ⇒ Modifier

Returns a new instance of Modifier.

# File 'lib/weechat/modifier.rb', line 8

def initialize(modifier, &callback)
  super
  @modifier = modifier.to_s
  @callback         = Callback.new(callback)
  @ptr              = Weechat.hook_modifier(modifier, "modifier_callback", id.to_s)
end

Instance Attribute Details

#modifier ⇒ Object (readonly)

Returns the value of attribute modifier.

# File 'lib/weechat/modifier.rb', line 7

def modifier
  @modifier
end

Class Method Details

.call(modifier, data, string) ⇒ Object Also known as: exec

# File 'lib/weechat/modifier.rb', line 18

def call(modifier, data, string)
  Weechat.hook_modifier_exec(modifier.to_s, data.to_s, string.to_s)
end

.inherited(by) ⇒ Object

# File 'lib/weechat/modifier.rb', line 3

def self.inherited(by)
  Hook.inherited(by)
end

Instance Method Details

#exec ⇒ Object

# File 'lib/weechat/modifier.rb', line 15

alias_method :exec, :call