Class: GrabzItWaterMark

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

Overview

This class represents the custom watermarks stored in GrabzIt

Author:

Version:

Instance Method Summary (collapse)

Constructor Details

- (GrabzItWaterMark) initialize(identifier = '', xPosition = 0, yPosition = 0, format = '')

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A new instance of GrabzItWaterMark



6
7
8
9
10
11
# File 'lib/grabzitwatermark.rb', line 6

def initialize(identifier = '', xPosition = 0, yPosition = 0, format = '')
	@Identifier = identifier
	@XPosition = xPosition
	@YPosition = yPosition
	@Format = format
end

Instance Method Details

- (String) format

The format of the watermark

Returns:

  • (String)

    the format of the watermark



25
26
27
# File 'lib/grabzitwatermark.rb', line 25

def format
	@Format
end

- (String) identifier

The identifier of the watermark

Returns:

  • (String)

    the identifier of the watermark



13
14
15
# File 'lib/grabzitwatermark.rb', line 13

def identifier
	@Identifier
end

- (Integer) xPosition

The horizontal postion of the watermark. 0 = Left, 1 = Center, 2 = Right

Returns:

  • (Integer)

    the horizontal postion of the watermark. 0 = Left, 1 = Center, 2 = Right



17
18
19
# File 'lib/grabzitwatermark.rb', line 17

def xPosition
	@XPosition
end

- (Integer) yPosition

The vertical postion of the watermark. 0 = Top, 1 = Middle, 2 = Bottom

Returns:

  • (Integer)

    the vertical postion of the watermark. 0 = Top, 1 = Middle, 2 = Bottom



21
22
23
# File 'lib/grabzitwatermark.rb', line 21

def yPosition
	@YPosition
end