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) 


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

def free()
  Libxlsxwriter.format_free(self)
end

#get_border_key ⇒ Border

Returns:



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

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

#get_fill_key ⇒ Fill

Returns:



1231
1232
1233
 
# File 'lib/fast_excel/binding.rb', line 1231

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

#get_font_key ⇒ Font

Returns:



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

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

#get_xf_index ⇒ Integer

Returns:

  • (Integer) 


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

def get_xf_index()
  Libxlsxwriter.format_get_xf_index(self)
end

#set_align(alignment) ⇒ nil

Parameters:

  • alignment (Integer)

Returns:

  • (nil) 


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

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

#set_bg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1338
1339
1340
 
# File 'lib/fast_excel/binding.rb', line 1338

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

#set_bold ⇒ nil

Returns:

  • (nil) 


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

def set_bold()
  Libxlsxwriter.format_set_bold(self)
end

#set_border(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1350
1351
1352
 
# File 'lib/fast_excel/binding.rb', line 1350

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

#set_border_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1380
1381
1382
 
# File 'lib/fast_excel/binding.rb', line 1380

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

#set_bottom(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1356
1357
1358
 
# File 'lib/fast_excel/binding.rb', line 1356

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

#set_bottom_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1386
1387
1388
 
# File 'lib/fast_excel/binding.rb', line 1386

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

#set_diag_border(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


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

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

#set_diag_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1416
1417
1418
 
# File 'lib/fast_excel/binding.rb', line 1416

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

#set_diag_type(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1410
1411
1412
 
# File 'lib/fast_excel/binding.rb', line 1410

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

#set_fg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1344
1345
1346
 
# File 'lib/fast_excel/binding.rb', line 1344

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

#set_font_charset(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1444
1445
1446
 
# File 'lib/fast_excel/binding.rb', line 1444

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

#set_font_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


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

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

#set_font_condense ⇒ nil

Returns:

  • (nil) 


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

def set_font_condense()
  Libxlsxwriter.format_set_font_condense(self)
end

#set_font_extend ⇒ nil

Returns:

  • (nil) 


1460
1461
1462
 
# File 'lib/fast_excel/binding.rb', line 1460

def set_font_extend()
  Libxlsxwriter.format_set_font_extend(self)
end

#set_font_family(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1438
1439
1440
 
# File 'lib/fast_excel/binding.rb', line 1438

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) 


1237
1238
1239
 
# File 'lib/fast_excel/binding.rb', line 1237

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

#set_font_outline ⇒ nil

Returns:

  • (nil) 


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

def set_font_outline()
  Libxlsxwriter.format_set_font_outline(self)
end

#set_font_scheme(font_scheme) ⇒ nil

Parameters:

  • font_scheme (String)

Returns:

  • (nil) 


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

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) 


1276
1277
1278
 
# File 'lib/fast_excel/binding.rb', line 1276

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

#set_font_shadow ⇒ nil

Returns:

  • (nil) 


1432
1433
1434
 
# File 'lib/fast_excel/binding.rb', line 1432

def set_font_shadow()
  Libxlsxwriter.format_set_font_shadow(self)
end

#set_font_size(size) ⇒ nil

Parameters:

  • size (Integer)

Returns:

  • (nil) 


1243
1244
1245
 
# File 'lib/fast_excel/binding.rb', line 1243

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

#set_font_strikeout ⇒ nil

Returns:

  • (nil) 


1270
1271
1272
 
# File 'lib/fast_excel/binding.rb', line 1270

def set_font_strikeout()
  Libxlsxwriter.format_set_font_strikeout(self)
end

#set_hidden ⇒ nil

Returns:

  • (nil) 


1298
1299
1300
 
# File 'lib/fast_excel/binding.rb', line 1298

def set_hidden()
  Libxlsxwriter.format_set_hidden(self)
end

#set_indent(level) ⇒ nil

Parameters:

  • level (Integer)

Returns:

  • (nil) 


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

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

#set_italic ⇒ nil

Returns:

  • (nil) 


1259
1260
1261
 
# File 'lib/fast_excel/binding.rb', line 1259

def set_italic()
  Libxlsxwriter.format_set_italic(self)
end

#set_left(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1368
1369
1370
 
# File 'lib/fast_excel/binding.rb', line 1368

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

#set_left_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1398
1399
1400
 
# File 'lib/fast_excel/binding.rb', line 1398

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) 


1282
1283
1284
 
# File 'lib/fast_excel/binding.rb', line 1282

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) 


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

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

#set_pattern(index) ⇒ nil

Parameters:

  • index (Integer)

Returns:

  • (nil) 


1332
1333
1334
 
# File 'lib/fast_excel/binding.rb', line 1332

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

#set_reading_order(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1466
1467
1468
 
# File 'lib/fast_excel/binding.rb', line 1466

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

#set_right(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1374
1375
1376
 
# File 'lib/fast_excel/binding.rb', line 1374

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

#set_right_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1404
1405
1406
 
# File 'lib/fast_excel/binding.rb', line 1404

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

#set_rotation(angle) ⇒ nil

Parameters:

  • angle (Integer)

Returns:

  • (nil) 


1315
1316
1317
 
# File 'lib/fast_excel/binding.rb', line 1315

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

#set_shrink ⇒ nil

Returns:

  • (nil) 


1326
1327
1328
 
# File 'lib/fast_excel/binding.rb', line 1326

def set_shrink()
  Libxlsxwriter.format_set_shrink(self)
end

#set_text_wrap ⇒ nil

Returns:

  • (nil) 


1309
1310
1311
 
# File 'lib/fast_excel/binding.rb', line 1309

def set_text_wrap()
  Libxlsxwriter.format_set_text_wrap(self)
end

#set_theme(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


1472
1473
1474
 
# File 'lib/fast_excel/binding.rb', line 1472

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

#set_top(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


1362
1363
1364
 
# File 'lib/fast_excel/binding.rb', line 1362

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

#set_top_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


1392
1393
1394
 
# File 'lib/fast_excel/binding.rb', line 1392

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

#set_underline(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


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

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

#set_unlocked ⇒ nil

Returns:

  • (nil) 


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

def set_unlocked()
  Libxlsxwriter.format_set_unlocked(self)
end