Module: Libxlsxwriter::FormatWrappers

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

Overview

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) 


423
424
425
 
# File 'lib/fast_excel/binding/format.rb', line 423

def free()
  Libxlsxwriter.format_free(self)
end

#get_border_key ⇒ Border

Returns:



438
439
440
 
# File 'lib/fast_excel/binding/format.rb', line 438

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

#get_fill_key ⇒ Fill

Returns:



443
444
445
 
# File 'lib/fast_excel/binding/format.rb', line 443

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

#get_font_key ⇒ Font

Returns:



433
434
435
 
# File 'lib/fast_excel/binding/format.rb', line 433

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

#get_xf_index ⇒ Integer

Returns:

  • (Integer) 


428
429
430
 
# File 'lib/fast_excel/binding/format.rb', line 428

def get_xf_index()
  Libxlsxwriter.format_get_xf_index(self)
end

#set_align(alignment) ⇒ nil

Parameters:

  • alignment (Integer)

Returns:

  • (nil) 


516
517
518
 
# File 'lib/fast_excel/binding/format.rb', line 516

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

#set_bg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


550
551
552
 
# File 'lib/fast_excel/binding/format.rb', line 550

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

#set_bold ⇒ nil

Returns:

  • (nil) 


466
467
468
 
# File 'lib/fast_excel/binding/format.rb', line 466

def set_bold()
  Libxlsxwriter.format_set_bold(self)
end

#set_border(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


562
563
564
 
# File 'lib/fast_excel/binding/format.rb', line 562

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

#set_border_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


592
593
594
 
# File 'lib/fast_excel/binding/format.rb', line 592

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

#set_bottom(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


568
569
570
 
# File 'lib/fast_excel/binding/format.rb', line 568

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

#set_bottom_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


598
599
600
 
# File 'lib/fast_excel/binding/format.rb', line 598

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

#set_diag_border(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


634
635
636
 
# File 'lib/fast_excel/binding/format.rb', line 634

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

#set_diag_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


628
629
630
 
# File 'lib/fast_excel/binding/format.rb', line 628

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

#set_diag_type(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


622
623
624
 
# File 'lib/fast_excel/binding/format.rb', line 622

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

#set_fg_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


556
557
558
 
# File 'lib/fast_excel/binding/format.rb', line 556

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

#set_font_charset(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


656
657
658
 
# File 'lib/fast_excel/binding/format.rb', line 656

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

#set_font_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


461
462
463
 
# File 'lib/fast_excel/binding/format.rb', line 461

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

#set_font_condense ⇒ nil

Returns:

  • (nil) 


667
668
669
 
# File 'lib/fast_excel/binding/format.rb', line 667

def set_font_condense()
  Libxlsxwriter.format_set_font_condense(self)
end

#set_font_extend ⇒ nil

Returns:

  • (nil) 


672
673
674
 
# File 'lib/fast_excel/binding/format.rb', line 672

def set_font_extend()
  Libxlsxwriter.format_set_font_extend(self)
end

#set_font_family(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


650
651
652
 
# File 'lib/fast_excel/binding/format.rb', line 650

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) 


449
450
451
 
# File 'lib/fast_excel/binding/format.rb', line 449

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

#set_font_outline ⇒ nil

Returns:

  • (nil) 


639
640
641
 
# File 'lib/fast_excel/binding/format.rb', line 639

def set_font_outline()
  Libxlsxwriter.format_set_font_outline(self)
end

#set_font_scheme(font_scheme) ⇒ nil

Parameters:

  • font_scheme (String)

Returns:

  • (nil) 


662
663
664
 
# File 'lib/fast_excel/binding/format.rb', line 662

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) 


488
489
490
 
# File 'lib/fast_excel/binding/format.rb', line 488

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

#set_font_shadow ⇒ nil

Returns:

  • (nil) 


644
645
646
 
# File 'lib/fast_excel/binding/format.rb', line 644

def set_font_shadow()
  Libxlsxwriter.format_set_font_shadow(self)
end

#set_font_size(size) ⇒ nil

Parameters:

  • size (Integer)

Returns:

  • (nil) 


455
456
457
 
# File 'lib/fast_excel/binding/format.rb', line 455

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

#set_font_strikeout ⇒ nil

Returns:

  • (nil) 


482
483
484
 
# File 'lib/fast_excel/binding/format.rb', line 482

def set_font_strikeout()
  Libxlsxwriter.format_set_font_strikeout(self)
end

#set_hidden ⇒ nil

Returns:

  • (nil) 


510
511
512
 
# File 'lib/fast_excel/binding/format.rb', line 510

def set_hidden()
  Libxlsxwriter.format_set_hidden(self)
end

#set_indent(level) ⇒ nil

Parameters:

  • level (Integer)

Returns:

  • (nil) 


533
534
535
 
# File 'lib/fast_excel/binding/format.rb', line 533

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

#set_italic ⇒ nil

Returns:

  • (nil) 


471
472
473
 
# File 'lib/fast_excel/binding/format.rb', line 471

def set_italic()
  Libxlsxwriter.format_set_italic(self)
end

#set_left(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


580
581
582
 
# File 'lib/fast_excel/binding/format.rb', line 580

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

#set_left_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


610
611
612
 
# File 'lib/fast_excel/binding/format.rb', line 610

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) 


494
495
496
 
# File 'lib/fast_excel/binding/format.rb', line 494

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) 


500
501
502
 
# File 'lib/fast_excel/binding/format.rb', line 500

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

#set_pattern(index) ⇒ nil

Parameters:

  • index (Integer)

Returns:

  • (nil) 


544
545
546
 
# File 'lib/fast_excel/binding/format.rb', line 544

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

#set_reading_order(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


678
679
680
 
# File 'lib/fast_excel/binding/format.rb', line 678

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

#set_right(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


586
587
588
 
# File 'lib/fast_excel/binding/format.rb', line 586

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

#set_right_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


616
617
618
 
# File 'lib/fast_excel/binding/format.rb', line 616

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

#set_rotation(angle) ⇒ nil

Parameters:

  • angle (Integer)

Returns:

  • (nil) 


527
528
529
 
# File 'lib/fast_excel/binding/format.rb', line 527

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

#set_shrink ⇒ nil

Returns:

  • (nil) 


538
539
540
 
# File 'lib/fast_excel/binding/format.rb', line 538

def set_shrink()
  Libxlsxwriter.format_set_shrink(self)
end

#set_text_wrap ⇒ nil

Returns:

  • (nil) 


521
522
523
 
# File 'lib/fast_excel/binding/format.rb', line 521

def set_text_wrap()
  Libxlsxwriter.format_set_text_wrap(self)
end

#set_theme(value) ⇒ nil

Parameters:

  • value (Integer)

Returns:

  • (nil) 


684
685
686
 
# File 'lib/fast_excel/binding/format.rb', line 684

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

#set_top(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


574
575
576
 
# File 'lib/fast_excel/binding/format.rb', line 574

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

#set_top_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil) 


604
605
606
 
# File 'lib/fast_excel/binding/format.rb', line 604

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

#set_underline(style) ⇒ nil

Parameters:

  • style (Integer)

Returns:

  • (nil) 


477
478
479
 
# File 'lib/fast_excel/binding/format.rb', line 477

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

#set_unlocked ⇒ nil

Returns:

  • (nil) 


505
506
507
 
# File 'lib/fast_excel/binding/format.rb', line 505

def set_unlocked()
  Libxlsxwriter.format_set_unlocked(self)
end