Class: Fox::FXIconItem

Inherits:
FXObject show all
Defined in:
rdoc-sources/FXIconList.rb,
lib/fox16/core.rb

Overview

Icon list item

Direct Known Subclasses

FXFileItem

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from FXObject

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

Constructor Details

#initialize(text, bigIcon = nil, miniIcon = nil, data = nil) ⇒ FXIconItem

Constructor



29
30
# File 'rdoc-sources/FXIconList.rb', line 29

def initialize(text, bigIcon=nil, miniIcon=nil, data=nil) # :yields: theIconItem
end

Instance Attribute Details

#bigIconObject

Big icon Fox::FXIcon



11
12
13
# File 'rdoc-sources/FXIconList.rb', line 11

def bigIcon
  @bigIcon
end

#dataObject

Item user data [Object]



17
18
19
# File 'rdoc-sources/FXIconList.rb', line 17

def data
  @data
end

#draggable=(value) ⇒ Object (writeonly)

Indicates whether this item is draggable or not [Boolean]



26
27
28
# File 'rdoc-sources/FXIconList.rb', line 26

def draggable=(value)
  @draggable = value
end

#enabled=(value) ⇒ Object (writeonly)

Indicates whether this item is enabled or not [Boolean]



23
24
25
# File 'rdoc-sources/FXIconList.rb', line 23

def enabled=(value)
  @enabled = value
end

#miniIconObject

Mini icon Fox::FXIcon



14
15
16
# File 'rdoc-sources/FXIconList.rb', line 14

def miniIcon
  @miniIcon
end

#selected=(value) ⇒ Object (writeonly)

Indicates whether this item is selected or not [Boolean]



20
21
22
# File 'rdoc-sources/FXIconList.rb', line 20

def selected=(value)
  @selected = value
end

#textObject

Item text [String]



8
9
10
# File 'rdoc-sources/FXIconList.rb', line 8

def text
  @text
end

Instance Method Details

#<=>(otherItem) ⇒ Object



4
5
6
# File 'lib/fox16/core.rb', line 4

def <=>(otherItem)
  text <=> otherItem.text
end

#createObject

Create this item



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

def create; end

#destroyObject

Destroy this item



63
# File 'rdoc-sources/FXIconList.rb', line 63

def destroy; end

#detachObject

Detach this item



60
# File 'rdoc-sources/FXIconList.rb', line 60

def detach; end

#draggable?Boolean

Return true if this item is draggable

Returns:

  • (Boolean)


48
# File 'rdoc-sources/FXIconList.rb', line 48

def draggable? ; end

#enabled?Boolean

Return true if this item is enabled

Returns:

  • (Boolean)


45
# File 'rdoc-sources/FXIconList.rb', line 45

def enabled? ; end

#getHeight(iconList) ⇒ Object

Return the height of this item



54
# File 'rdoc-sources/FXIconList.rb', line 54

def getHeight(iconList); end

#getWidth(iconList) ⇒ Object

Return the width of this item



51
# File 'rdoc-sources/FXIconList.rb', line 51

def getWidth(iconList); end

#hasFocus?Boolean

Returns true if this item has the focus

Returns:

  • (Boolean)


39
# File 'rdoc-sources/FXIconList.rb', line 39

def hasFocus? ; end

#selected?Boolean

Return true if this item is selected

Returns:

  • (Boolean)


42
# File 'rdoc-sources/FXIconList.rb', line 42

def selected? ; end

#setFocus(focus) ⇒ Object

Set the focused state for this item (where focus is either true or false)



36
# File 'rdoc-sources/FXIconList.rb', line 36

def setFocus(focus); end

#to_sObject

Return the icon item’s text



33
# File 'rdoc-sources/FXIconList.rb', line 33

def to_s; text; end