Module: Libxlsxwriter::FormatWrappers

Included in:
Format
Defined in:
lib/fast_excel/binding.rb

Overview

(Not documented)

Fields:

:file

(FFI::Pointer(*FILE))

:xf_format_indices

(HashTable)

:num_xf_formats

(FFI::Pointer(*Uint16T))

:xf_index

(Integer)

:dxf_index

(Integer)

:num_format

(Array<Integer>)

:font_name

(Array<Integer>)

:font_scheme

(Array<Integer>)

:num_format_index

(Integer)

:font_index

(Integer)

:has_font

(Integer)

:has_dxf_font

(Integer)

:font_size

(Integer)

:bold

(Integer)

:italic

(Integer)

:font_color

(Integer)

:underline

(Integer)

:font_strikeout

(Integer)

:font_outline

(Integer)

:font_shadow

(Integer)

:font_script

(Integer)

:font_family

(Integer)

:font_charset

(Integer)

:font_condense

(Integer)

:font_extend

(Integer)

:theme

(Integer)

:hyperlink

(Integer)

:hidden

(Integer)

:locked

(Integer)

:text_h_align

(Integer)

:text_wrap

(Integer)

:text_v_align

(Integer)

:text_justlast

(Integer)

:rotation

(Integer)

:fg_color

(Integer)

:bg_color

(Integer)

:pattern

(Integer)

:has_fill

(Integer)

:has_dxf_fill

(Integer)

:fill_index

(Integer)

:fill_count

(Integer)

:border_index

(Integer)

:has_border

(Integer)

:has_dxf_border

(Integer)

:border_count

(Integer)

:bottom

(Integer)

:diag_border

(Integer)

:diag_type

(Integer)

:left

(Integer)

:right

(Integer)

:top

(Integer)

:bottom_color

(Integer)

:diag_color

(Integer)

:left_color

(Integer)

:right_color

(Integer)

:top_color

(Integer)

:indent

(Integer)

:shrink

(Integer)

:merge_range

(Integer)

:reading_order

(Integer)

:just_distrib

(Integer)

:color_indexed

(Integer)

:font_only

(Integer)

:list_pointers

(FormatListPointers)

Instance Method Summary collapse

Instance Method Details

#free ⇒ nil

Returns:

  • (nil) 


1207
1208
1209
 
# File 'lib/fast_excel/binding.rb', line 1207

def free()
  Libxlsxwriter.format_free(self)
end

#get_border_key ⇒ Border

Returns:



1222
1223
1224
 
# File 'lib/fast_excel/binding.rb', line 1222

def get_border_key()
  Border.new Libxlsxwriter.format_get_border_key(self)
end

#get_fill_key ⇒ Fill

Returns:



1227
1228
1229
 
# File 'lib/fast_excel/binding.rb', line 1227

def get_fill_key()
  Fill.new Libxlsxwriter.format_get_fill_key(self)
end

#get_font_key ⇒ Font

Returns:



1217
1218
1219
 
# File 'lib/fast_excel/binding.rb', line 1217

def get_font_key()
  Font.new Libxlsxwriter.format_get_font_key(self)
end

#get_xf_index ⇒ Integer

Returns:

  • (Integer) 


1212
1213
1214
 
# File 'lib/fast_excel/binding.rb', line 1212

def get_xf_index()
  Libxlsxwriter.format_get_xf_index(self)
end

#set_align(alignment) ⇒ nil

Parameters:

  • alignment (Integer)

Returns:

  • (nil) 


1300
1301
1302
 
# File 'lib/fast_excel/binding.rb', line 1300

def set_align(alignment)
  Libxlsxwriter.format_set_align(self, alignment)
end

#set_bg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1334
1335
1336
 
# File 'lib/fast_excel/binding.rb', line 1334

def set_bg_color(color)
  Libxlsxwriter.format_set_bg_color(self, color)
end

#set_bold ⇒ nil

Returns:

  • (nil) 


1250
1251
1252
 
# File 'lib/fast_excel/binding.rb', line 1250

def set_bold()
  Libxlsxwriter.format_set_bold(self)
end

#set_border(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1346
1347
1348
 
# File 'lib/fast_excel/binding.rb', line 1346

def set_border(style)
  Libxlsxwriter.format_set_border(self, style)
end

#set_border_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1376
1377
1378
 
# File 'lib/fast_excel/binding.rb', line 1376

def set_border_color(color)
  Libxlsxwriter.format_set_border_color(self, color)
end

#set_bottom(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1352
1353
1354
 
# File 'lib/fast_excel/binding.rb', line 1352

def set_bottom(style)
  Libxlsxwriter.format_set_bottom(self, style)
end

#set_bottom_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1382
1383
1384
 
# File 'lib/fast_excel/binding.rb', line 1382

def set_bottom_color(color)
  Libxlsxwriter.format_set_bottom_color(self, color)
end

#set_diag_border(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1418
1419
1420
 
# File 'lib/fast_excel/binding.rb', line 1418

def set_diag_border(value)
  Libxlsxwriter.format_set_diag_border(self, value)
end

#set_diag_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1412
1413
1414
 
# File 'lib/fast_excel/binding.rb', line 1412

def set_diag_color(color)
  Libxlsxwriter.format_set_diag_color(self, color)
end

#set_diag_type(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1406
1407
1408
 
# File 'lib/fast_excel/binding.rb', line 1406

def set_diag_type(value)
  Libxlsxwriter.format_set_diag_type(self, value)
end

#set_fg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1340
1341
1342
 
# File 'lib/fast_excel/binding.rb', line 1340

def set_fg_color(color)
  Libxlsxwriter.format_set_fg_color(self, color)
end

#set_font_charset(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1440
1441
1442
 
# File 'lib/fast_excel/binding.rb', line 1440

def set_font_charset(value)
  Libxlsxwriter.format_set_font_charset(self, value)
end

#set_font_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1245
1246
1247
 
# File 'lib/fast_excel/binding.rb', line 1245

def set_font_color(color)
  Libxlsxwriter.format_set_font_color(self, color)
end

#set_font_condense ⇒ nil

Returns:

  • (nil) 


1451
1452
1453
 
# File 'lib/fast_excel/binding.rb', line 1451

def set_font_condense()
  Libxlsxwriter.format_set_font_condense(self)
end

#set_font_extend ⇒ nil

Returns:

  • (nil) 


1456
1457
1458
 
# File 'lib/fast_excel/binding.rb', line 1456

def set_font_extend()
  Libxlsxwriter.format_set_font_extend(self)
end

#set_font_family(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1434
1435
1436
 
# File 'lib/fast_excel/binding.rb', line 1434

def set_font_family(value)
  Libxlsxwriter.format_set_font_family(self, value)
end

#set_font_name(font_name) ⇒ nil

Parameters:

  • font_name (String)

Returns:

  • (nil) 


1233
1234
1235
 
# File 'lib/fast_excel/binding.rb', line 1233

def set_font_name(font_name)
  Libxlsxwriter.format_set_font_name(self, font_name)
end

#set_font_outline ⇒ nil

Returns:

  • (nil) 


1423
1424
1425
 
# File 'lib/fast_excel/binding.rb', line 1423

def set_font_outline()
  Libxlsxwriter.format_set_font_outline(self)
end

#set_font_scheme(font_scheme) ⇒ nil

Parameters:

  • font_scheme (String)

Returns:

  • (nil) 


1446
1447
1448
 
# File 'lib/fast_excel/binding.rb', line 1446

def set_font_scheme(font_scheme)
  Libxlsxwriter.format_set_font_scheme(self, font_scheme)
end

#set_font_script(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1272
1273
1274
 
# File 'lib/fast_excel/binding.rb', line 1272

def set_font_script(style)
  Libxlsxwriter.format_set_font_script(self, style)
end

#set_font_shadow ⇒ nil

Returns:

  • (nil) 


1428
1429
1430
 
# File 'lib/fast_excel/binding.rb', line 1428

def set_font_shadow()
  Libxlsxwriter.format_set_font_shadow(self)
end

#set_font_size(size) ⇒ nil

Parameters:

  • size (Integer)

Returns:

  • (nil) 


1239
1240
1241
 
# File 'lib/fast_excel/binding.rb', line 1239

def set_font_size(size)
  Libxlsxwriter.format_set_font_size(self, size)
end

#set_font_strikeout ⇒ nil

Returns:

  • (nil) 


1266
1267
1268
 
# File 'lib/fast_excel/binding.rb', line 1266

def set_font_strikeout()
  Libxlsxwriter.format_set_font_strikeout(self)
end

#set_hidden ⇒ nil

Returns:

  • (nil) 


1294
1295
1296
 
# File 'lib/fast_excel/binding.rb', line 1294

def set_hidden()
  Libxlsxwriter.format_set_hidden(self)
end

#set_indent(level) ⇒ nil

Parameters:

  • level (Integer)

Returns:

  • (nil) 


1317
1318
1319
 
# File 'lib/fast_excel/binding.rb', line 1317

def set_indent(level)
  Libxlsxwriter.format_set_indent(self, level)
end

#set_italic ⇒ nil

Returns:

  • (nil) 


1255
1256
1257
 
# File 'lib/fast_excel/binding.rb', line 1255

def set_italic()
  Libxlsxwriter.format_set_italic(self)
end

#set_left(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1364
1365
1366
 
# File 'lib/fast_excel/binding.rb', line 1364

def set_left(style)
  Libxlsxwriter.format_set_left(self, style)
end

#set_left_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1394
1395
1396
 
# File 'lib/fast_excel/binding.rb', line 1394

def set_left_color(color)
  Libxlsxwriter.format_set_left_color(self, color)
end

#set_num_format(num_format) ⇒ nil

Parameters:

  • num_format (String)

Returns:

  • (nil) 


1278
1279
1280
 
# File 'lib/fast_excel/binding.rb', line 1278

def set_num_format(num_format)
  Libxlsxwriter.format_set_num_format(self, num_format)
end

#set_num_format_index(index) ⇒ nil

Parameters:

  • index (Integer)

Returns:

  • (nil) 


1284
1285
1286
 
# File 'lib/fast_excel/binding.rb', line 1284

def set_num_format_index(index)
  Libxlsxwriter.format_set_num_format_index(self, index)
end

#set_pattern(index) ⇒ nil

Parameters:

  • index (Integer)

Returns:

  • (nil) 


1328
1329
1330
 
# File 'lib/fast_excel/binding.rb', line 1328

def set_pattern(index)
  Libxlsxwriter.format_set_pattern(self, index)
end

#set_reading_order(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1462
1463
1464
 
# File 'lib/fast_excel/binding.rb', line 1462

def set_reading_order(value)
  Libxlsxwriter.format_set_reading_order(self, value)
end

#set_right(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1370
1371
1372
 
# File 'lib/fast_excel/binding.rb', line 1370

def set_right(style)
  Libxlsxwriter.format_set_right(self, style)
end

#set_right_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1400
1401
1402
 
# File 'lib/fast_excel/binding.rb', line 1400

def set_right_color(color)
  Libxlsxwriter.format_set_right_color(self, color)
end

#set_rotation(angle) ⇒ nil

Parameters:

  • angle (Integer)

Returns:

  • (nil) 


1311
1312
1313
 
# File 'lib/fast_excel/binding.rb', line 1311

def set_rotation(angle)
  Libxlsxwriter.format_set_rotation(self, angle)
end

#set_shrink ⇒ nil

Returns:

  • (nil) 


1322
1323
1324
 
# File 'lib/fast_excel/binding.rb', line 1322

def set_shrink()
  Libxlsxwriter.format_set_shrink(self)
end

#set_text_wrap ⇒ nil

Returns:

  • (nil) 


1305
1306
1307
 
# File 'lib/fast_excel/binding.rb', line 1305

def set_text_wrap()
  Libxlsxwriter.format_set_text_wrap(self)
end

#set_theme(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1468
1469
1470
 
# File 'lib/fast_excel/binding.rb', line 1468

def set_theme(value)
  Libxlsxwriter.format_set_theme(self, value)
end

#set_top(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1358
1359
1360
 
# File 'lib/fast_excel/binding.rb', line 1358

def set_top(style)
  Libxlsxwriter.format_set_top(self, style)
end

#set_top_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1388
1389
1390
 
# File 'lib/fast_excel/binding.rb', line 1388

def set_top_color(color)
  Libxlsxwriter.format_set_top_color(self, color)
end

#set_underline(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1261
1262
1263
 
# File 'lib/fast_excel/binding.rb', line 1261

def set_underline(style)
  Libxlsxwriter.format_set_underline(self, style)
end

#set_unlocked ⇒ nil

Returns:

  • (nil) 


1289
1290
1291
 
# File 'lib/fast_excel/binding.rb', line 1289

def set_unlocked()
  Libxlsxwriter.format_set_unlocked(self)
end