Class: Fox::FXTableItem

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

Overview

Represents a particular cell in an FXTable.

Direct Known Subclasses

FXComboTableItem

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from FXObject

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

Constructor Details

- (FXTableItem) initialize(text, icon = nil, data = nil)

Return an initialized FXTableItem instance.

Parameters:

text

the text for this table item [String]

icon

the icon, if any, for this table item Fox::FXIcon

data

the user data for this table item [Object]



88
# File 'rdoc-sources/FXTable.rb', line 88

def initialize(text, icon=nil, data=nil); end

Instance Attribute Details

- (Object) borders

Which borders will be drawn for this cell (some combination of LBORDER, RBORDER, TBORDER and BBORDER) [Integer]



74
75
76
# File 'rdoc-sources/FXTable.rb', line 74

def borders
  @borders
end

- (Object) data

User data associated with this cell [Object]



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

def data
  @data
end

- (Object) draggable=(value) (writeonly)

Indicates whether this item is draggable [Boolean]



58
59
60
# File 'rdoc-sources/FXTable.rb', line 58

def draggable=(value)
  @draggable = value
end

- (Object) enabled=(value) (writeonly)

Indicates whether this item is enabled [Boolean]



55
56
57
# File 'rdoc-sources/FXTable.rb', line 55

def enabled=(value)
  @enabled = value
end

- (Object) focus=(value) (writeonly)

Indicates whether this item has the focus [Boolean]



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

def focus=(value)
  @focus = value
end

- (Object) icon

Icon associated with this cell Fox::FXIcon



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

def icon
  @icon
end

- (Object) iconPosition

The icon's position in the cell, relative to the text (one of BEFORE, AFTER, ABOVE or BELOW) [Integer]



70
71
72
# File 'rdoc-sources/FXTable.rb', line 70

def iconPosition
  @iconPosition
end

- (Object) justify

Indicates how the text in the cell will be justified. This value is some combination of the horizontal justification flags LEFT, CENTER_X and RIGHT, and the vertical justification flags TOP, CENTER_Y and BOTTOM.



66
67
68
# File 'rdoc-sources/FXTable.rb', line 66

def justify
  @justify
end

- (Object) selected=(value) (writeonly)

Indicates whether this item is selected [Boolean]



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

def selected=(value)
  @selected = value
end

- (Object) stipple

The background stipple pattern for this cell [Integer]



77
78
79
# File 'rdoc-sources/FXTable.rb', line 77

def stipple
  @stipple
end

- (Object) text

Text associated with this cell [String]



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

def text
  @text
end

Instance Method Details

- (Object) create

Create the server-side resources associated with this table item



149
# File 'rdoc-sources/FXTable.rb', line 149

def create; end

- (Object) destroy

Destroy the server-side resources associated with this table item



155
# File 'rdoc-sources/FXTable.rb', line 155

def destroy; end

- (Object) detach

Detach the server-side resources associated with this table item



152
# File 'rdoc-sources/FXTable.rb', line 152

def detach; end

- (Boolean) draggable?

Return true if this item is draggable

Returns:

  • (Boolean)


106
# File 'rdoc-sources/FXTable.rb', line 106

def draggable?; end

- (Object) draw(table, dc, x, y, w, h)

Draw this table item



118
# File 'rdoc-sources/FXTable.rb', line 118

def draw(table, dc, x, y, w, h); end

- (Object) drawBackground(table, dc, x, y, w, h)

Draw background behind the cell



130
131
132
133
134
# File 'rdoc-sources/FXTable.rb', line 130

def drawBackground(table, dc, x, y, w, h)
  hg = table.horizontalGridShown? ? 1 : 0
  vg = table.verticalGridShown? ? 1 : 0
  dc.fillRectangle(x + vg, y + hg, w - vg, h - hg)
end

- (Object) drawBorders(table, dc, x, y, w, h)

Draw borders



121
# File 'rdoc-sources/FXTable.rb', line 121

def drawBorders(table, dc, x, y, w, h); end

- (Object) drawContent(table, dc, x, y, w, h)

Draw content



124
# File 'rdoc-sources/FXTable.rb', line 124

def drawContent(table, dc, x, y, w, h); end

- (Object) drawPattern(table, dc, x, y, w, h)

Draw hatch pattern



127
# File 'rdoc-sources/FXTable.rb', line 127

def drawPattern(table, dc, x, y, w, h); end

- (Boolean) enabled?

Return true if this item is enabled

Returns:

  • (Boolean)


103
# File 'rdoc-sources/FXTable.rb', line 103

def enabled?; end

- (Object) getControlFor(table)

Create input control for editing this item. Should return a new instance of some subclass of FXWindow.



140
# File 'rdoc-sources/FXTable.rb', line 140

def getControlFor(table); end

- (Object) getHeight(table)

Return the height of this item (in pixels)



94
# File 'rdoc-sources/FXTable.rb', line 94

def getHeight(table); end

- (Object) getWidth(table)

Return the width of this item (in pixels)



91
# File 'rdoc-sources/FXTable.rb', line 91

def getWidth(table); end

- (Boolean) hasFocus?

Return true if this item has the focus

Returns:

  • (Boolean)


97
# File 'rdoc-sources/FXTable.rb', line 97

def hasFocus?; end

- (Boolean) selected?

Return true if this item is selected

Returns:

  • (Boolean)


100
# File 'rdoc-sources/FXTable.rb', line 100

def selected?; end

- (Object) setFromControl(control)

Set item value from input control (an instance of some subclass of FXWindow).



146
# File 'rdoc-sources/FXTable.rb', line 146

def setFromControl(control); end

- (Object) setIcon(icn, owned = false)

Change item icon, deleting the previous item icon if it was owned by this table item.



115
# File 'rdoc-sources/FXTable.rb', line 115

def setIcon(icn, owned=false); end

- (Object) to_s

Return the text for this table item



109
110
111
# File 'rdoc-sources/FXTable.rb', line 109

def to_s
  text
end