Generic Function

Summary

Sets the sorting type of a sorted-object.

Package

capi

Signature

sorted-object-sort-by pane new-sort-type &key allow-reverse

Arguments

pane

An instance of sorted-object or a subclass.

new-sort-type

The sort type to set.

allow-reverse

A boolean.

Description

The generic function sorted-object-sort-by sets the sort type of pane to new-sort-type .

new-sort-type must match the type of one of the sort descriptions of pane .

If allow-reverse is non-nil and the sort type already matches new-sort-type , then the sort reverses the order of the items . The default value of allow-reverse is t .

If pane is a list-panel, then sorted-object-sort-by also calls sort-object-items-by to sort the items with the new sort type. For your own subclasses of sorted-object which are not subclasses of list-panel, if you need this behavior define an :after method that calls sort-object-items-by. You can also define :after methods on subclasses of list-panel to perform other tasks each time the items are sorted.

See also

sort-object-items-by
sorted-object