Class: Fox::FXHeaderItem

Inherits:
FXObject show all
Defined in:
rdoc-sources/FXHeader.rb

Overview

Header item

Alignment hints

RIGHT

Align on right

LEFT

Align on left

CENTER_X

Align centered horizontally (default)

TOP

Align on top

BOTTOM

Align on bottom

CENTER_Y

Align centered vertically (default)

Icon position

BEFORE

Icon before the text

AFTER

Icon after the text

ABOVE

Icon above the text

BELOW

Icon below the text

Arrow

ARROW_NONE

No arrow

ARROW_UP

Arrow pointing up

ARROW_DOWN

Arrow pointing down

PRESSED

Pressed down

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from FXObject

#bind, #handle, #load, #save, subclasses

Constructor Details

#initialize(text, ic = nil, s = 0, ptr = nil) ⇒ FXHeaderItem

Construct new item with given text, icon, size, and user-data


57
58
# File 'rdoc-sources/FXHeader.rb', line 57

def initialize(text, ic=nil, s=0, ptr=nil) # :yields: theHeaderItem
end

Instance Attribute Details

#arrowDirObject

Sort direction (FALSE, TRUE or MAYBE) [Integer]


43
44
45
# File 'rdoc-sources/FXHeader.rb', line 43

def arrowDir
  @arrowDir
end

#dataObject

Item's user data [Object]


37
38
39
# File 'rdoc-sources/FXHeader.rb', line 37

def data
  @data
end

#iconObject

Item's icon Fox::FXIcon


34
35
36
# File 'rdoc-sources/FXHeader.rb', line 34

def icon
  @icon
end

#iconPositionObject

Icon position (one of BEFORE, AFTER, ABOVE or BELOW) [Integer]


52
53
54
# File 'rdoc-sources/FXHeader.rb', line 52

def iconPosition
  @iconPosition
end

#justificationObject

Content justification (one of LEFT, RIGHT, CENTER_X, TOP, BOTTOM or CENTER_Y) [Integer]


49
50
51
# File 'rdoc-sources/FXHeader.rb', line 49

def justification
  @justification
end

#posObject

Current position [Integer]


46
47
48
# File 'rdoc-sources/FXHeader.rb', line 46

def pos
  @pos
end

#sizeObject

Size [Integer]


40
41
42
# File 'rdoc-sources/FXHeader.rb', line 40

def size
  @size
end

#textObject

Item's text label [String]


31
32
33
# File 'rdoc-sources/FXHeader.rb', line 31

def text
  @text
end

Instance Method Details

#createObject

Create server-side resources


70
# File 'rdoc-sources/FXHeader.rb', line 70

def create; end

#destroyObject

Destroy server-side resources


76
# File 'rdoc-sources/FXHeader.rb', line 76

def destroy; end

#detachObject

Detach from server-side resources


73
# File 'rdoc-sources/FXHeader.rb', line 73

def detach; end

#getHeight(header) ⇒ Object

Return the item's content height in the header.


67
# File 'rdoc-sources/FXHeader.rb', line 67

def getHeight(header); end

#getWidth(header) ⇒ Object

Return the item's content width in the header.


64
# File 'rdoc-sources/FXHeader.rb', line 64

def getWidth(header); end

#pressed=(p) ⇒ Object

Set pressed state to true or false.


79
# File 'rdoc-sources/FXHeader.rb', line 79

def pressed=(p); end

#pressed?Boolean

Return true if in pressed state.

Returns:

  • (Boolean)

82
# File 'rdoc-sources/FXHeader.rb', line 82

def pressed?; end

#to_sObject

Return the header item's text label


61
# File 'rdoc-sources/FXHeader.rb', line 61

def to_s; text; end