Class: Wx::SettableHeaderColumn

Inherits:
HeaderColumn show all
Defined in:
lib/wx/doc/gen/header_ctrl.rb

Overview

Adds methods to set the column attributes to HeaderColumn.

This class adds setters for the column attributes defined by HeaderColumn. It is still an abstract base class and needs to be implemented before using it with HeaderCtrl.

Category: Controls

Direct Known Subclasses

HeaderColumnSimple

Instance Method Summary collapse

Methods inherited from HeaderColumn

#get_alignment, #get_bitmap, #get_bitmap_bundle, #get_flags, #get_min_width, #get_title, #get_width, #has_flag, #is_hidden, #is_reorderable, #is_resizeable, #is_shown, #is_sort_key, #is_sort_order_ascending, #is_sortable

Instance Method Details

#change_flag(flag, set) ⇒ void

This method returns an undefined value.

Set or clear the given flag.

Parameters:

  • flag (Integer) —

    The flag to set or clear.

  • set (Boolean) —

    If true, set the flag, i.e. equivalent to calling #set_flag, otherwise clear it, as #clear_flag.

See Also:



668
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 668

def change_flag(flag, set) end

#clear_flag(flag) ⇒ void

This method returns an undefined value.

Clear the specified flag for the column.

Parameters:

  • flag (Integer)

See Also:



685
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 685

def clear_flag(flag) end

#set_alignment(align) ⇒ void Also known as: alignment=

This method returns an undefined value.

Set the alignment of the column header.

Parameters:



650
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 650

def set_alignment(align) end

#set_bitmap(bitmap) ⇒ void Also known as: bitmap=

This method returns an undefined value.

Set the bitmap to be displayed in the column header.

Notice that the bitmaps displayed in different columns of the same control must all be of the same size.

Parameters:



630
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 630

def set_bitmap(bitmap) end

#set_flag(flag) ⇒ void Also known as: flag=

This method returns an undefined value.

Set the specified flag for the column.

Parameters:

  • flag (Integer)

See Also:



676
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 676

def set_flag(flag) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Set the column flags.

This method allows setting all flags at once, see also generic #change_flag, #set_flag, #clear_flag and #toggle_flag methods below as well as specific #set_resizeable, #set_sortable, #set_reorderable and #set_hidden ones.

Parameters:



658
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 658

def set_flags(flags) end

#set_hidden(hidden) ⇒ void Also known as: hidden=

This method returns an undefined value.

Hide or show the column.

By default all columns are shown but some of them can be completely hidden from view by calling this function. Equivalent to ChangeFlag(COL_HIDDEN, hidden).

Parameters:

  • hidden (Boolean) 


727
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 727

def set_hidden(hidden) end

#set_min_width(minWidth) ⇒ void Also known as: min_width=

This method returns an undefined value.

Set the minimal column width.

This method can be used with resizable columns (i.e. those for which COL_RESIZABLE flag is set in HeaderColumn#get_flags or, alternatively, HeaderColumn#is_resizeable returns true) to prevent the user from making them narrower than the given width.

Parameters:

  • minWidth (Integer) —

    The minimal column width in pixels, may be 0 to remove any previously set restrictions.



644
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 644

def set_min_width(minWidth) end

#set_reorderable(reorderable) ⇒ void Also known as: reorderable=

This method returns an undefined value.

Allow changing the column order by dragging it.

Equivalent to ChangeFlag(COL_REORDERABLE, reorderable).

Parameters:

  • reorderable (Boolean) 


718
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 718

def set_reorderable(reorderable) end

#set_resizeable(resizable) ⇒ void Also known as: resizeable=

This method returns an undefined value.

Call this to enable or disable interactive resizing of the column by the user.

By default, the columns are resizable. Equivalent to ChangeFlag(COL_RESIZABLE, resizable).

Parameters:

  • resizable (Boolean) 


701
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 701

def set_resizeable(resizable) end

#set_sort_order(ascending) ⇒ void Also known as: sort_order=

This method returns an undefined value.

Sets this column as the sort key for the associated control.

This function indicates that this column is currently used for sorting the control and also sets the sorting direction. Notice that actual sorting is only done in the control associated with the header, this function doesn’t do any sorting on its own. Don’t confuse this function with #set_sortable which should be used to indicate that the column may be used for sorting while this one is used to indicate that it currently is used for sorting. Of course, #set_sort_order can be only called for sortable columns.

Parameters:

  • ascending (Boolean) —

    If true, sort in ascending order, otherwise in descending order.



742
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 742

def set_sort_order(ascending) end

#set_sortable(sortable) ⇒ void Also known as: sortable=

This method returns an undefined value.

Allow clicking the column to sort the control contents by the field in this column.

By default, the columns are not sortable so you need to explicitly call this function to allow sorting by the field corresponding to this column. Equivalent to ChangeFlag(COL_SORTABLE, sortable).

Parameters:

  • sortable (Boolean) 


710
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 710

def set_sortable(sortable) end

#set_title(title) ⇒ void Also known as: title=

This method returns an undefined value.

Set the text to display in the column header.

Parameters:

  • title (String) 


622
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 622

def set_title(title) end

#set_width(width) ⇒ void Also known as: width=

This method returns an undefined value.

Set the column width.

Parameters:



636
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 636

def set_width(width) end

#toggle_flag(flag) ⇒ void

This method returns an undefined value.

Toggle the specified flag for the column.

If the flag is currently set, equivalent to #clear_flag, otherwise to #set_flag.

Parameters:

  • flag (Integer)

See Also:



693
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 693

def toggle_flag(flag) end

#toggle_sort_order ⇒ void

This method returns an undefined value.

Inverses the sort order.

This function is typically called when the user clicks on a column used for sorting to change sort order from ascending to descending or vice versa.

See Also:



751
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 751

def toggle_sort_order; end

#unset_as_sort_key ⇒ void

This method returns an undefined value.

Don’t use this column for sorting.

This is the reverse of #set_sort_order and is called to indicate that this column is not used for sorting any longer.



734
 
# File 'lib/wx/doc/gen/header_ctrl.rb', line 734

def unset_as_sort_key; end