tiens ma traduction terminée ce matin…

ListCtrl, 122

ListCtrl(
    parent,
    id=ID_ANY,
    pos=DefaultPosition,
    size=DefaultSize,
    style=LC_ICON,
    validator=DefaultValidator,
    name=ListCtrlNameStr
)

Un contrôle de liste présente des listes dans un certain nombre de formats:

• vue de liste
• vue de rapport
• vue d’icône
• vue de petite icône.

Dans tous les cas, les éléments sont numérotés à partir de zéro.

Pour tous ces modes, les éléments sont stockés dans le contrôle et doivent y être ajoutés à l’aide de la méthode wx.ListCtrl.InsertItem.

Un cas particulier d’affichage de rapport très différent des autres modes de contrôle de liste est un contrôle virtuel dans lequel les données des éléments

(y compris le texte, les images et les attributs)

sont gérées par le programme principal et ne sont demandées par le contrôle lui-même qu’en cas de besoin,

ce qui permet d’avoir des contrôles avec des millions d’éléments sans consommer beaucoup de mémoire.

Pour utiliser le contrôle de liste virtuelle, vous devez d’abord utiliser wx.ListCtrl.SetItemCount et surcharger au moins wx.ListCtrl.OnGetItemText

(et éventuellement wx.ListCtrl.OnGetItemImage ou wx.ListCtrl.OnGetItemColumnImage et wx.ListCtrl.OnGetItemAttr )

afin de renvoyer les informations sur les éléments lorsque le contrôle le demande.

Le contrôle de liste virtuelle peut être utilisé comme un contrôle normal,

à ceci près qu’aucune opération pouvant prendre un temps proportionnel au nombre d’éléments dans le contrôle n’a lieu - ceci est nécessaire pour permettre d’avoir un nombre pratiquement infini d’éléments.

Par exemple, dans un contrôle de liste virtuelle à sélection multiple,

les sélections ne seront pas envoyées lorsque plusieurs éléments sont sélectionnés en même temps, car cela impliquerait d’itérer sur tous les éléments.

L’utilisation de nombreuses fonctionnalités de wx.ListCtrl est illustrée dans l’exemple correspondant.

Pour intercepter les événements d’un contrôle de liste, utilisez les macros de table d’événements décrites dans wx.ListEvent.

Ordre des colonnes.

Par défaut, les colonnes d’un contrôle de liste apparaissent à l’écran dans l’ordre de leurs indices,

c’est-à-dire que la colonne 0 apparaît en premier, puis la colonne 1, et ainsi de suite.

Il est toutefois possible de modifier cet ordre en utilisant la fonction SetColumnsOrder pour réorganiser arbitrairement l’ordre visuel des colonnes.

L’utilisateur peut également réorganiser les colonnes de manière interactive en les faisant glisser.

Dans ce cas, l’index de la colonne n’est pas le même que son ordre et les fonctions GetColumnOrder et GetColumnIndexFromOrder doivent être utilisées pour faire la conversion entre les deux.

Exemple de réorganisation des colonnes:

listctrl = wx.ListCtrl(...)
for i in range(3):
    listctrl.InsertColumn(i, "colonne %i" % i)

order = [ 2, 0, 1]
listctrl.SetColumnsOrder(order)

#Maintenant listctrl.GetColumnsOrder() renverra order et
#listctrl.GetColumnIndexFromOrder(n) renverra order[n] 

# et

#listctrl.GetColumnOrder() renverra 1, 2 et 0 pour les colonnes 0, 1 et 2 respectivement.

##Styles de fenêtre

Cette classe prend en charge les styles suivants:

• wx.LC_LIST: Vue en liste à plusieurs colonnes, avec de petites icônes optionnelles.

  Les colonnes sont calculées automatiquement, c’est-à-dire qu’il n’est pas nécessaire de définir des colonnes comme dans LC_REPORT

  En d’autres termes, la liste s’enroule, contrairement à une wx.ListBox.

• wx.LC_REPORT: Vue d’un rapport à une ou plusieurs colonnes, avec un en-tête optionnel.

• wx.LC_VIRTUAL: L’application fournit des éléments de texte à la demande.

  Ne peut être utilisé qu’avec LC_REPORT .

• wx.LC_ICON: Vue d’une grande icône, avec des étiquettes optionnelles.

• wx.LC_SMALL_ICON: Vue d’une petite icône, avec des étiquettes optionnelles.

• wx.LC_ALIGN_TOP: Les icônes sont alignées en haut.

  Valeur par défaut pour Win32, uniquement pour Win32.

• wx.LC_ALIGN_LEFT: Les icônes sont alignées à gauche.

• wx.LC_AUTOARRANGE: Les icônes s’organisent d’elles-mêmes.

  Win32 uniquement.

• wx.LC_EDIT_LABELS: Les étiquettes sont modifiables: l’application sera informée du début de la modification.

• wx.LC_NO_HEADER: Pas d’en-tête en mode rapport.

• wx.LC_SINGLE_SEL: Sélection unique (multiple par défaut).

• wx.LC_SORT_ASCENDING: Tri par ordre croissant.

    (Vous devez toujours fournir un rappel de comparaison dans wx.ListCtrl.SortItems .)
  

• wx.LC_SORT_DESCENDING: Trier dans l’ordre décroissant.

    (Vous devez toujours fournir un rappel de comparaison dans wx.ListCtrl.SortItems .)
  

• wx.LC_HRULES: Dessine de légères règles horizontales entre les lignes en mode rapport.

• wx.LC_VRULES: Dessine des règles verticales légères entre les colonnes en mode rapport.

Événements émis par cette classe

Les gestionnaires liés aux types d’événements suivants recevront l’un des paramètres wx.ListEvent.

• EVT_LIST_BEGIN_DRAG: Commence à faire glisser la liste avec le bouton gauche de la souris.

  Traite un événement de type wxEVT_LIST_BEGIN_DRAG.

• EVT_LIST_BEGIN_RDRAG: Commence à faire glisser la souris avec le bouton droit.

  Traite un événement de type wxEVT_LIST_BEGIN_RDRAG.

• EVT_LIST_BEGIN_LABEL_EDIT: Début de l’édition d’une étiquette.

  Ceci peut être évité en appelant Veto()

  Traite un événement de type wxEVT_LIST_BEGIN_LABEL_EDIT.

• EVT_LIST_END_LABEL_EDIT: Fin de l’édition d’une étiquette.

  Ceci peut être évité en appelant Veto()

  Traite un événement de type wxEVT_LIST_END_LABEL_EDIT.

• EVT_LIST_DELETE_ITEM: Un élément a été supprimé.

  Traite un événement de type wxEVT_LIST_DELETE_ITEM.

• EVT_LIST_DELETE_ALL_ITEMS: Tous les éléments ont été supprimés.

  Traite un événement de type wxEVT_LIST_DELETE_ALL_ITEMS.

• EVT_LIST_ITEM_SELECTED: L’élément a été sélectionné.

  Notez que la souris est capturée par le contrôle lui-même lorsque cet événement est généré, voir l’aperçu de la gestion des événements.

  Traite un événement de type wxEVT_LIST_ITEM_SELECTED.

• EVT_LIST_ITEM_DESELECTED: L’élément a été désélectionné.

  Traite un événement de type wxEVT_LIST_ITEM_DESELECTED.

• EVT_LIST_ITEM_ACTIVATED: L’élément a été activé (ENTRÉE ou double clic)

  Traite un événement de type wxEVT_LIST_ITEM_ACTIVATED.

• EVT_LIST_ITEM_FOCUSED: L’élément en cours de focalisation a changé.

  Traite un événement de type wxEVT_LIST_ITEM_FOCUSED.

• EVT_LIST_ITEM_MIDDLE_CLICK: le bouton du milieu de la souris a été cliqué sur un élément.

  Cet événement n’est pris en charge que par le contrôle générique.

  Traite un événement de type wxEVT_LIST_ITEM_MIDDLE_CLICK.

• EVT_LIST_ITEM_RIGHT_CLICK: Le bouton droit de la souris a été cliqué sur un élément.

  Traite un événement de type wxEVT_LIST_ITEM_RIGHT_CLICK.

• EVT_LIST_KEY_DOWN: une touche a été enfoncée.

  Traite un événement de type wxEVT_LIST_KEY_DOWN.

• EVT_LIST_INSERT_ITEM: Un élément a été inséré.

  Traite un événement de type wxEVT_LIST_INSERT_ITEM.

• EVT_LIST_COL_CLICK: une colonne (m_col) a fait l’objet d’un clic gauche.

  Traite un événement de type wxEVT_LIST_COL_CLICK.

• EVT_LIST_COL_RIGHT_CLICK: Un clic droit a été effectué sur une colonne (m_col)

  Traite un événement de type wxEVT_LIST_COL_RIGHT_CLICK.

• EVT_LIST_COL_BEGIN_DRAG: L’utilisateur a commencé à redimensionner une colonne.

  Traite un événement de type wxEVT_LIST_COL_BEGIN_DRAG.

• EVT_LIST_COL_DRAGGING: Le séparateur entre les colonnes est en train d’être déplacé.

  Traite un événement de type wxEVT_LIST_COL_DRAGGING.

• EVT_LIST_COL_END_DRAG: Une colonne a été redimensionnée par l’utilisateur.

  Traite un événement de type wxEVT_LIST_COL_END_DRAG.

• EVT_LIST_CACHE_HINT: Préparation du cache pour un contrôle de liste virtuelle.

  Traite un événement de type wxEVT_LIST_CACHE_HINT.

• EVT_LIST_ITEM_CHECKED: L’élément a été vérifié.

  Traite un événement de type wxEVT_LIST_ITEM_CHECKED (nouveau depuis wxWidgets 3.1.0).

• EVT_LIST_ITEM_UNCHECKED: L’élément a été décoché.

  Traite un type d’événement wxEVT_LIST_ITEM_UNCHECKED (nouveau depuis wxWidgets 3.1.0). ^^

Note: L’implémentation native de wxOSX pour le mode rapport qui a été ajoutée dans wxWidgets 2.8 a été supprimée dans wxWidgets 3.1, ce qui signifie que pour wxWidgets 3.1+ wxOSX utilise l’implémentation générique pour tous les modes.

Note: Toutes les autres fonctions fonctionnent toujours avec les indices des colonnes, c’est-à-dire que le positionnement visuel des colonnes à l’écran n’affecte pas le code qui définit ou obtient leurs valeurs par exemple.

Note: Sous wxMSW, ce contrôle utilise SystemThemedControl pour une apparence de style explorateur par défaut depuis wxWidgets 3.1.0.

Si vous ne le souhaitez pas, vous pouvez appeler SystemThemedControl.EnableSystemTheme avec l’argument false pour le désactiver.

Voir aussi:

• ListCtrl
• wx.ListView
• wx.ListBox
• wx.TreeCtrl
• wx.ImageList
• wx.ListEvent
• wx.ListItem
• wx.adv.EditableListBox

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr)

Constructeur permettant de créer et d’afficher un contrôle de liste.

Paramètres

-
parent (wx.Window) - Fenêtre parent.

Ne doit pas être None.

id (wx.WindowID) - Identifiant de la fenêtre.

La valeur wx.ID_ANY indique une valeur par défaut.

pos (wx.Point) - Position de la fenêtre.

Si wx.DefaultPosition est spécifié, une position par défaut est choisie.

size (wx.Size) - Taille de la fenêtre.

Si wx.DefaultSize est spécifié, la fenêtre est dimensionnée de manière appropriée.

style (long) - Style de la fenêtre.

Voir wx.ListCtrl.

validator (wx.Validator) - Valideur de fenêtre.

name (string) - Nom de la fenêtre.

Voir aussi : Create , wx.Validator

Append(self, entry)

Ajoute un élément au contrôle de liste.

Le paramètre entry doit être une séquence avec un élément pour chaque colonne

AppendColumn(self, heading, format=LIST_FORMAT_LEFT, width=-1)

Ajoute une nouvelle colonne au contrôle de liste en mode rapport.

Il s’agit simplement d’une enveloppe pratique pour InsertColumn qui ajoute la nouvelle colonne après toutes les colonnes existantes sans avoir à spécifier sa position explicitement.

Paramètres

-
titre (chaîne) -

-
format (ListColumnFormat) -

-
width (int) -

Type de retour: long

Nouveau dans la version 2.9.4.

Arrange(self, flag=LIST_ALIGN_DEFAULT)

Arrange les éléments en vue icône ou petite icône.

Ceci n’a d’effet que sur Win32.

flag est l’un de :

wx.LIST_ALIGN_DEFAULT : Alignement par défaut.

wx.LIST_ALIGN_LEFT : Alignement sur le côté gauche du contrôle.

wx.LIST_ALIGN_TOP : Alignement sur la partie supérieure du contrôle.

wx.LIST_ALIGN_SNAP_TO_GRID : s’aligne sur la grille.

Paramètres

flag (int) -

Type de retour: bool

AssignImageList(self, imageList, which)

Définit la liste d’images associée au contrôle et en prend possession.

Il n’est pas recommandé d’utiliser SetNormalImages ou SetSmallImages à la place de cette fonction dans le nouveau code.

Après avoir appelé cette fonction, le contrôle, contrairement à SetImageList, supprimera la liste lorsqu’il sera détruit.

which doit être l’un de IMAGE_LIST_NORMAL , IMAGE_LIST_SMALL , IMAGE_LIST_STATE (le support de ce dernier n’est pas implémenté).

Paramètres

-
imageList (wx.ImageList) -

-
which (int) -

Voir aussi : SetImageList

CheckItem(self, item, check=True)

Vérifie ou décoche un élément de la liste wx.ListItem dans un contrôle utilisant des cases à cocher.

Cette méthode ne fonctionne que si le support des cases à cocher a été activé avec succès à l’aide de EnableCheckBoxes .

Paramètres

-
item (long) - Index de l’élément (basé sur zéro).

-
check (bool) - Si True, cocher l’élément, sinon décocher.

Nouveau dans la version 4.1/wxWidgets-3.1.0.

ClearAll(self)

Supprime tous les éléments et toutes les colonnes.

Note : Ceci envoie un événement de type wxEVT_LIST_DELETE_ALL_ITEMS sous toutes les plateformes.

ClearColumnImage(self, col)

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=LC_ICON, validator=DefaultValidator, name=ListCtrlNameStr)

Crée le contrôle de liste.

Voir wx.ListCtrl pour plus de détails.

Paramètres de la commande

parent (wx.Window) -

id (wx.WindowID) -

pos (wx.Point) -

size (wx.Size) -

style (long) -

validator (wx.Validator) -

name (chaîne de caractères) -

Type de retour: bool

DeleteAllColumns(self)

Supprime toutes les colonnes du contrôle de liste.

Type de retour: bool

Retourne
True si toutes les colonnes ont été supprimées avec succès, False sinon.

DeleteAllItems(self)

Supprime tous les éléments du contrôle de liste.

Cette fonction n’envoie pas l’événement wxEVT_LIST_DELETE_ITEM car la suppression de nombreux éléments du contrôle serait alors trop lente (contrairement à wx.ListCtrl.DeleteItem ) mais elle envoie l’événement spécial wxEVT_LIST_DELETE_ALL_ITEMS si le contrôle n’est pas vide.

S’il était déjà vide, rien n’est fait et aucun événement n’est envoyé.

Type de retour: bool

Retourne
True si les éléments ont été supprimés avec succès ou si le contrôle était déjà vide, False si une erreur s’est produite lors de la suppression des éléments.

DeleteColumn(self, col)

Supprime une colonne.

Paramètres

col (int) -

Type de retour: bool

DeleteItem(self, item)

Supprime l’élément spécifié.

Cette fonction envoie l’événement wxEVT_LIST_DELETE_ITEM pour l’élément supprimé.

Paramètres

item (long) -

Type de retour: bool

Voir aussi : DeleteAllItems

EditLabel(self, item)

Commence à éditer l’étiquette de l’élément donné.

Cette fonction génère un événement EVT_LIST_BEGIN_LABEL_EDIT qui peut être bloqué afin qu’aucun contrôle de texte n’apparaisse pour l’édition sur place.

Si l’utilisateur a modifié l’étiquette (c’est-à-dire s’il n’a pas appuyé sur ESC ou s’il n’a pas quitté le contrôle de texte sans modification), un événement EVT_LIST_END_LABEL_EDIT sera envoyé et pourra également faire l’objet d’un veto.

Paramètres

item (long) -

Type de retour: wx.TextCtrl

EnableAlternateRowColours(self, enable=True)

Active l’alternance des couleurs d’arrière-plan des lignes (également appelée “zebra striping”).

Cette méthode ne peut être appelée que pour le contrôle en mode rapport virtuel, c’est-à-dire ayant les styles LC_REPORT et LC_VIRTUAL.

Lors de l’activation de l’alternance des couleurs, la couleur appropriée pour les lignes paires est choisie automatiquement en fonction des couleurs d’avant-plan et d’arrière-plan par défaut qui sont utilisées pour les lignes impaires.

Paramètres

enable (bool) - Si True, activer l’alternance des couleurs d’arrière-plan, c’est-à-dire des couleurs différentes pour les lignes paires et impaires.

Si False, cette fonction est désactivée et la même couleur d’arrière-plan est utilisée pour toutes les lignes.

Nouveau dans la version 2.9.5.

Voir aussi : SetAlternateRowColour

EnableBellOnNoMatch(self, on=True)

Active ou désactive un signal sonore si aucune correspondance n’est trouvée pour le texte saisi lors de la recherche d’un élément au clavier.

Par défaut, il n’y a pas de bip dans ce cas, sauf dans wxMSW où le bip est toujours généré par le contrôle natif et ne peut pas être désactivé, c’est-à-dire que les appels à cette fonction n’ont aucun effet dans ce cas.

Paramètres

on (bool) -

Nouveau dans la version 2.9.5.

EnableCheckBoxes(self, enable=True)

Active ou désactive les cases à cocher pour les éléments de la liste.

Paramètres

enable (bool) - Si True, active les cases à cocher, sinon les désactive.

Type de retour: bool

Dans un contrôle de liste avec le style wx.LC_VIRTUAL, vous devez garder une trace de l’état des cases à cocher.

Lorsqu’une case à cocher est cliquée (EVT_LIST_ITEM_CHECKED ou EVT_LIST_ITEM_UNCHECKED), vous devez mettre à jour l’état et rafraîchir l’élément vous-même.

Retourne
True si les cases à cocher sont prises en charge, False sinon.

Nouveau dans la version 4.1/wxWidgets-3.1.0.

Voir aussi : OnGetItemIsChecked RefreshItem

EnableSystemTheme(self, enable=True)

Peut être utilisé pour désactiver le thème système des contrôles qui l’utilisent par défaut.

Sous Windows, un thème alternatif est disponible pour les contrôles de type liste et liste depuis Windows Vista.

Ce thème est utilisé par la liste et l’arborescence de l’explorateur Windows et est donc sans doute plus familier aux utilisateurs que l’apparence standard de ces contrôles.

Cette classe utilise automatiquement le nouveau thème, mais si cela n’est pas souhaité, cette méthode peut être utilisée pour le désactiver.

Veuillez noter que cette méthode doit être appelée avant que le widget ne soit réellement créé, en utilisant le modèle de création en deux phases.

Quelque chose comme ceci :

Ceci crée l’objet, mais pas la fenêtre

widget = wx.ListCtrl()

Désactiver le thème du système

widget.EnableSystemTheme(False)

Créez maintenant la fenêtre

widget.Create(parent, wx.“wx.ID_ANY“)
Cette méthode n’a aucun effet sur les autres plates-formes

Paramètres

enable (bool) -

EnsureVisible(self, item)

S’assure que cet élément est visible.

Paramètres

item (long) -

Type de retour: bool

ExtendRulesAndAlternateColour(self, extend=True)

Étend les règles et l’arrière-plan des rangées alternatives à l’ensemble de l’espace client.

Par défaut, les règles (lorsqu’elles sont activées avec wx.LC_HRULES et wx.LC_VRULES) et l’arrière-plan des lignes alternatives (lorsque EnableAlternateRowColours a été appelé) ne sont affichés que dans la partie du contrôle occupée par les éléments, qui peut être plus petite que la fenêtre entière s’il y a peu d’éléments dans le contrôle.

L’appel de cette fonction étend l’affichage des règles et des lignes d’arrière-plan alternatives à l’ensemble de l’espace client.

Comme pour EnableAlternateRowColours , cette méthode ne peut être utilisée qu’avec les contrôles ayant les styles LC_REPORT et LC_VIRTUAL.

Notez que cette méthode n’est actuellement pas implémentée dans la version native de MSW et qu’elle n’y fait rien.

Paramètres

extend (bool) - si True, dessine les règles horizontales et verticales sur les lignes vides et utilise le paramètre de couleur pour peindre l’arrière-plan des lignes alternatives lorsque ces lignes sont vides, sans données.

Nouveau dans la version 4.1/wxWidgets-3.1.5.

FindItem(self, *args, **kw)

Surcharge Implémentations surchargées :

FindItem (self, start, str, partial=False)

Recherche un élément dont le libellé correspond à cette chaîne, en commençant par le début ou si start est -1 .

La comparaison des chaînes est insensible à la casse.

Si partial est True, cette méthode recherchera les éléments qui commencent par str.

Paramètres

-
start (long) -

-
str (chaîne de caractères) -

-
partial (bool) -

Type de retour: long

Retourne
Le prochain élément correspondant s’il existe ou -1 (wxwx.NOT\_FOUND) sinon.

FindItem (self, start, data)
Trouve un élément dont les données correspondent à ces données, en commençant par le début ou le début si ‘start’ est -1 .

FindItem (self, start, pt, direction)
Recherche l’élément le plus proche de cette position dans la direction spécifiée, à partir du début ou du début si le début est égal à -1.

Focus(self, idx)

Met au point et affiche l’élément donné.

GetAlternateRowColour(self)

Obtient la couleur d’arrière-plan de la ligne alternative.

Type de retour: wx.Colour

Nouveau dans la version 4.1/wxWidgets-3.1.0.

Voir aussi : SetAlternateRowColour

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Paramètres

variant (WindowVariant) -

Type de retour: wx.VisualAttributes

GetColumn(self, col)

Obtient des informations sur cette colonne.

Voir SetItem() pour plus d’informations.

Type de retour: wx.ListItem

GetColumnCount(self)

Renvoie le nombre de colonnes.

Le contrôle peut avoir plusieurs colonnes uniquement en mode wx.LC_REPORT.

En mode wx.LC_LIST, cette fonction renvoie 1, car une liste est toujours considérée comme ayant une (seule) colonne.

Dans les modes wx.LC_SMALL_ICON et wx.LC_ICON, elle renvoie 0 car il n’y a pas de colonnes du tout.

Type de retour: int

GetColumnIndexFromOrder(self, pos)

Récupère l’index de la colonne à partir de sa position dans l’ordre visuel.

Après avoir appelé SetColumnsOrder , l’indice renvoyé par cette fonction correspond à la valeur de l’élément numéro pos dans le tableau renvoyé par GetColumnsOrder .

Paramètres

pos (int) -

Type de retour: int

Remarque : cette fonction n’a de sens que pour l’affichage des rapports et n’est actuellement implémentée que dans le portage wxMSW.

Utilisez HAS_LISTCTRL_COLUMN_ORDER pour protéger l’utilisation de cette fonction de manière à ce qu’elle fonctionne sous les autres plates-formes lorsque la prise en charge de la réorganisation des colonnes y sera ajoutée.

Voir aussi : GetColumnOrder

GetColumnOrder(self, col)

Obtient la position de l’ordre visuel de la colonne.

Cette fonction renvoie l’index de la colonne qui apparaît à la position visuelle donnée, par exemple, l’appeler avec col égal à 0 renvoie l’index de la première colonne affichée.

Paramètres

col (int) -

Type de retour: int

Note : Cette fonction n’a de sens que pour l’affichage des rapports et n’est actuellement implémentée que dans le portage wxMSW.

Utilisez HAS_LISTCTRL_COLUMN_ORDER pour protéger l’utilisation de cette fonction afin qu’elle fonctionne sur les autres plates-formes lorsque la prise en charge de la réorganisation des colonnes y sera ajoutée.

Voir aussi : GetColumnsOrder , GetColumnIndexFromOrder

GetColumnWidth(self, col)

Obtient la largeur de la colonne (vue rapport uniquement).

Paramètres

col (int) -

Type de retour: int

GetColumnsOrder(self)

Renvoie le tableau contenant les ordres de toutes les colonnes.

En cas d’erreur, un tableau vide est retourné.

Type de retour: liste d’entiers

Note : Cette fonction n’a de sens que pour l’affichage des rapports et n’est actuellement implémentée que dans le portage wxMSW.

Utilisez HAS_LISTCTRL_COLUMN_ORDER pour protéger l’utilisation de cette fonction afin qu’elle fonctionne sur les autres plates-formes lorsque la prise en charge de la réorganisation des colonnes y sera ajoutée.

Voir aussi : GetColumnOrder , GetColumnIndexFromOrder

GetCountPerPage(self)

Obtient le nombre d’éléments qui peuvent tenir verticalement dans la zone visible du contrôle de liste (vue liste ou rapport) ou le nombre total d’éléments dans le contrôle de liste (vue icône ou petite icône).

Type de retour: int

GetEditControl(self)

Renvoie le contrôle d’édition actuellement utilisé pour éditer une étiquette.

Retourne None si aucune étiquette n’est en cours d’édition.

Type de retour: wx.TextCtrl

Note : Ce n’est actuellement implémenté que pour wxMSW et la version générique, pas pour la version native de macOS.

GetFirstSelected(self, *args)

Renvoie le premier élément sélectionné, ou -1 si aucun élément n’est sélectionné.

GetFocusedItem(self)

Récupère l’élément sélectionné ou -1 si aucun élément n’est sélectionné.

GetImageList(self, which)

Renvoie la liste d’images spécifiée.

qui peut être l’un des éléments suivants

wx.IMAGE_LIST_NORMAL : La liste d’images normale (grande icône).

wx.IMAGE_LIST_SMALL : La liste des petites icônes.

wx.IMAGE_LIST_STATE : La liste d’images d’état définie par l’utilisateur (non implémentée).

Paramètres

which (int) -

Type de retour: wx.ImageList

GetItem(self, itemIdx, col=0)

Obtient des informations sur l’élément.

Voir SetItem() pour plus d’informations.

Type de retour: wx.ListItem

GetItemBackgroundColour(self, item)

Renvoie la couleur de cet élément.

Si l’élément n’a pas de couleur spécifique, renvoie une couleur invalide (et non la couleur d’arrière-plan par défaut du contrôle lui-même).

Paramètres

item (long) -

Type de retour: wx.Colour

Voir aussi : GetItemTextColour

GetItemCount(self)

Renvoie le nombre d’éléments dans le contrôle de liste.

Type de retour: int

GetItemData(self, item)

Obtient les données définies par l’application associées à cet élément.

Paramètres

item (long) -

Type de retour: long

GetItemFont(self, item)

Renvoie la police de l’élément.

Paramètres

item (long) -

Type de retour: wx.Font

GetItemPosition(self, item)

Renvoie la position de l’élément, en vue icône ou petite icône.

Type de retour: wx.Point

GetItemRect(self, item, code=LIST_RECT_BOUNDS)

Retourne le rectangle représentant la taille et la position de l’élément, en coordonnées physiques.

code est l’un de wx.wx.LIST\_RECT\_BOUNDS, wx.wx.LIST\_RECT\_ICON, wx.wx.LIST\_RECT\_LABEL.

Type de retour: wx.Rect

GetItemSpacing(self)

Récupère l’espacement entre les icônes en pixels : l’espacement horizontal est retourné comme la composante x de l’objet wx.Size et l’espacement vertical comme sa composante y.

Type de retour: wx.Size

GetItemState(self, item, stateMask)

Obtient l’état de l’élément.

Pour une liste des drapeaux d’état, voir SetItem .

Le masque d’état indique les drapeaux d’état qui présentent un intérêt.

Paramètres

-
item (long) -

-
stateMask (long) -

Type de retour: int

GetItemText(self, item, col=0)

Obtient le texte de l’élément pour cet élément.

Paramètres

-
item (long) - Index de l’élément (basé sur zéro).

-
col (int) - Index de la colonne de l’élément (base zéro).

La colonne 0 est la valeur par défaut.

Ce paramètre est nouveau dans wxWidgets 2.9.1.

Type de retour: chaîne

GetItemTextColour(self, item)

Renvoie la couleur de cet élément.

Si l’élément n’a pas de couleur spécifique, renvoie une couleur invalide (et non la couleur d’avant-plan par défaut du contrôle lui-même car cela ne permettrait pas de distinguer les éléments ayant la même couleur que l’avant-plan du contrôle actuel et les éléments ayant une couleur par défaut qui, par conséquent, ont toujours la même couleur que le contrôle).

Paramètres

item (long) -

Type de retour: wx.Colour

GetMainWindow(self)

Retourne le type
wx.Window

GetNextItem(self, item, geometry=LIST_NEXT_ALL, state=LIST_STATE_DONTCARE)

Recherche un élément avec la géométrie ou l’état donné, en commençant par l’élément mais en excluant l’élément lui-même.

Si item est -1, le premier élément correspondant aux drapeaux spécifiés sera renvoyé.

Renvoie le premier élément avec l’état donné après l’élément ou -1 si aucun élément n’a été trouvé.

Cette fonction peut être utilisée pour trouver tous les éléments sélectionnés dans le contrôle comme ceci :
item = -1

while 1 :
item = listctrl.GetNextItem(item,
wx.LIST_NEXT_ALL,
wx.LIST_STATE_SELECTED)
if item == -1 :
break

# Cet élément est sélectionné - faites ce qui est nécessaire avec lui
wx.LogMessage("L'élément %ld est sélectionné"%item)

La géométrie peut être l’un des éléments suivants

wx.LIST_NEXT_ABOVE : recherche un élément au-dessus de l’élément spécifié.

wx.LIST_NEXT_ALL : recherche l’élément suivant par index.

wx.LIST_NEXT_BELOW : Recherche un élément en dessous de l’élément spécifié.

wx.LIST_NEXT_LEFT : Recherche un élément à gauche de l’élément spécifié.

wx.LIST_NEXT_RIGHT : Recherche un élément à droite de l’élément spécifié.

state peut être une liste bitmap des éléments suivants :

wx.LIST_STATE_DONTCARE : Ne se préoccupe pas de l’état.

wx.LIST_STATE_DROPHILITED : L’élément indique qu’il est une cible de chute.

wx.LIST_STATE_FOCUSED : L’élément a le focus.

wx.LIST_STATE_SELECTED : L’élément est sélectionné.

wx.LIST_STATE_CUT : L’élément est sélectionné dans le cadre d’une opération de copier-coller.

Paramètres

-
item (long) -

-
geometry (int) -

-
state (int) -

Type de retour: long

Note : ce paramètre n’est actuellement supporté que par wxMSW et est ignoré sur les autres plateformes.

GetNextSelected(self, item)

Renvoie les éléments sélectionnés suivants, ou -1 s’il n’y a plus d’éléments sélectionnés.

GetSelectedItemCount(self)

Renvoie le nombre d’éléments sélectionnés dans le contrôle de liste.

Type de retour: int

GetSortIndicator(self)

Renvoie la colonne qui affiche l’indicateur de tri.

Peut renvoyer -1 si aucun indicateur de tri n’est affiché.

Type de retour: int

Nouveau dans la version 4.1/wxWidgets-3.1.6.

GetSubItemRect(self, item, subItem, rect, code=LIST_RECT_BOUNDS)

Renvoie le rectangle représentant la taille et la position, en coordonnées physiques, du sous-élément donné, c’est-à-dire
la partie de l’élément de la ligne dans la colonne sous-élément.

Cette méthode n’a de sens que lorsque wx.ListCtrl est en mode rapport.

Si le paramètre subItem est égal à la valeur spéciale LIST_GETSUBITEMRECT_WHOLEITEM, la valeur de retour est la même que pour GetItemRect .

Le code peut être l’un des codes suivants : LIST_RECT_BOUNDS , LIST_RECT_ICON ou LIST_RECT_LABEL .

Notez que l’utilisation de LIST_RECT_ICON avec n’importe quel sous-élément sauf le premier n’est pas très utile car seul le premier sous-élément peut avoir une icône dans wx.ListCtrl.

Dans ce cas, c’est-à-dire pour un sous-élément > 0, cette fonction renvoie simplement un rectangle vide dans rect.

Paramètres

-
item (long) -

-
sous-élément (long) -

-
rect (wx.Rect) -

-
code (int) -

Type de retour: bool

Nouveau dans la version 2.7.0.

GetTextColour(self)

Obtient la couleur du texte du contrôle de liste.

Type de retour: wx.Colour

GetTopItem(self)

Obtient l’index de l’élément visible le plus haut en vue liste ou rapport.

Type de retour: long

GetUpdatedAscendingSortIndicator(self, col)

Renvoie la nouvelle valeur à utiliser pour l’indicateur de tri après avoir cliqué sur une colonne.

Cette fonction d’aide peut être utile dans le gestionnaire EVT_LIST_COL_CLICK lorsqu’il met à jour l’indicateur de tri après que l’utilisateur a cliqué sur une colonne.

Voici un exemple :
def OnColClick(self, event) :
col = event.GetColumn()
si col == -1 :
return # cliqué en dehors de toute colonne.

ascendant = self.GetUpdatedAscendingSortIndicator(col)
self.SortItems(self.MyCompareFunction, ascending)
self.ShowSortIndicator(col, ascending)

Paramètres

col (int) -

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.6.

GetViewRect(self)

Renvoie le rectangle pris par tous les éléments du contrôle.

En d’autres termes, si la taille du client du contrôle était égale à la taille de ce rectangle, aucune barre de défilement ne serait nécessaire et aucun espace libre ne serait laissé.

Notez que cette fonction ne fonctionne que dans les vues icônes et petites icônes, et non dans les vues listes ou rapports (il s’agit d’une limitation du contrôle Win32 natif).

Type de retour: wx.Rect

HasCheckBoxes(self)

Renvoie True si les cases à cocher sont activées pour les éléments de la liste.

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.0.

Voir aussi : EnableCheckBoxes

HasColumnOrderSupport(self)

Type de retour: bool

HitTest(self, point)

Détermine quel élément (s’il y en a un) se trouve au point spécifié, en donnant des détails dans les drapeaux.

Retourne l’index de l’élément ou NOT_FOUND si aucun élément ne se trouve au point spécifié.

Les drapeaux seront une combinaison des drapeaux suivants :

wx.LIST_HITTEST_ABOVE : Au-dessus de la zone client du contrôle.

wx.LIST_HITTEST_BELOW : En dessous de la zone client du contrôle.

wx.LIST_HITTEST_TOLEFT : A gauche de la zone client du contrôle.

wx.LIST_HITTEST_TORIGHT : A droite de la zone client du contrôle.

wx.LIST_HITTEST_NOWHERE : A l’intérieur de la zone client du contrôle mais pas au-dessus d’un élément.

wx.LIST_HITTEST_ONITEMICON : au-dessus de l’icône d’un élément.

wx.LIST_HITTEST_ONITEMLABEL : Sur le texte d’un élément.

wx.LIST_HITTEST_ONITEMSTATEICON : au-dessus de la case à cocher d’un élément.

wx.LIST_HITTEST_ONITEM : Combinaison de LIST_HITTEST_ONITEMICON , LIST_HITTEST_ONITEMLABEL , LIST_HITTEST_ONITEMSTATEICON .

Si ptrSubItem n’est pas None et que le wx.ListCtrl est en mode rapport, le numéro du sous-élément (ou de la colonne) sera également fourni.

Cette fonctionnalité n’est disponible qu’à partir de la version 2.7.0 et n’est actuellement implémentée que sous wxMSW et nécessite au moins comctl32.dll de la version 4.70 sur le système hôte, sinon la valeur stockée dans ptrSubItem sera toujours -1.

Pour compiler cette fonctionnalité dans la bibliothèque wxWidgets, vous devez avoir accès à commctrl.h de la version 4.70 fournie par Microsoft.

HitTestSubItem(self, point)

Détermine quel élément (s’il y en a un) se trouve au point spécifié, en donnant les détails dans les drapeaux.

Type de retour: tuple

Retourne
( item, flags, subitem )

InReportView(self)

Renvoie True si le contrôle utilise actuellement le style LC_REPORT.

Type de retour: bool

InsertColumn(self, *args, **kw)

surcharge Implémentations surchargées :

InsertColumn (self, col, info)
Pour le mode d’affichage des rapports (uniquement), insère une colonne.

Pour plus de détails, voir SetItem .

Voir également InsertColumn overload pour une alternative généralement plus pratique à cette méthode et la description de la manière dont la largeur de l’élément est interprétée par cette méthode.

Paramètres

-
col (long) -

-
info (wx.ListItem) -

Type de retour: long

InsertColumn (self, col, heading, format=LIST_FORMAT_LEFT, width=LIST_AUTOSIZE)
Pour le mode d’affichage des rapports (uniquement), insère une colonne.

Insère une nouvelle colonne dans le contrôle de liste en mode d’affichage des rapports à la position donnée, en spécifiant ses attributs les plus courants.

Notez que pour définir l’image de la colonne, vous devez utiliser la surcharge InsertColumn et spécifier LIST_MASK_IMAGE dans le masque de l’élément.

Paramètres

-
col (long) - L’indice auquel la colonne doit être insérée.

Les indices valides sont compris entre 0 et GetColumnCount inclus et ce dernier peut être utilisé pour ajouter la nouvelle colonne à la suite de la dernière colonne existante.

heading (string) - La chaîne spécifiant l’en-tête de la colonne.

format (int) - Les drapeaux spécifiant l’alignement du texte de l’en-tête de contrôle.

width (int) - Si elle est positive, la largeur de la colonne en pixels.

Sinon, il peut s’agir de LIST_AUTOSIZE pour choisir la taille par défaut de la colonne ou de LIST_AUTOSIZE_USEHEADER pour adapter la largeur de la colonne à l’en-tête ou pour l’étendre afin de remplir tout l’espace restant pour la dernière colonne.

Notez que dans le cas de LIST_AUTOSIZE, la largeur fixe est utilisée car il n’y a pas encore d’éléments dans cette colonne à utiliser pour déterminer sa taille optimale.

Si vous souhaitez adapter la colonne à son contenu, utilisez SetColumnWidth après avoir ajouté les éléments contenant des valeurs dans cette colonne.

Type de retour: long

Retourne
L’index de la colonne insérée ou -1 si l’ajout a échoué.

InsertItem(self, *args, **kw)

surcharge Implémentations surchargées :

InsertItem (self, info)
Insère un élément, en renvoyant l’index du nouvel élément en cas de succès, -1 sinon.

Paramètres

info (wx.ListItem) - objet wx.ListItem

Type de retour: long

InsertItem (self, index, label)
Insère un élément de type chaîne de caractères.

Paramètres

-
index (long) - Index du nouvel élément, fourni par l’application

-
label (string) - Libellé de la chaîne

Type de retour: long

InsertItem (self, index, imageIndex)
Insère un élément d’image.

Paramètres

-
index (long) - Index du nouvel élément, fourni par l’application

-
imageIndex (int) - Index dans la liste d’images associée à ce contrôle et à ce style de vue

Type de retour: long

InsertItem (self, index, label, imageIndex)
Insère un élément image/chaîne.

Paramètres

-
index (long) - Index du nouvel élément, fourni par l’application

-
label (string) - Libellé de la chaîne

-
imageIndex (int) - Index dans la liste d’images associée à ce contrôle et à ce style de vue

Type de retour: long

IsAscendingSortIndicator(self)

Renvoie True si la direction de l’indicateur de tri est ascendante, False si la direction est descendante.

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.6.

IsEmpty(self)

Renvoie True si le contrôle ne contient actuellement aucun élément.

Notez qu’un contrôle avec quelques colonnes est toujours considéré comme vide s’il n’a pas de lignes.

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.3.

IsItemChecked(self, item)

Renvoie True si la case à cocher de l’élément wx.ListItem donné est cochée.

Retourne toujours False si le support des cases à cocher n’a pas été activé.

Paramètres

item (long) - Index de l’élément (basé sur zéro).

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.0.

IsSelected(self, idx)

Renvoie True si l’élément est sélectionné.

IsVirtual(self)

Retourne True si le contrôle est actuellement en vue de rapport virtuel.

Type de retour: bool

IsVisible(self, item)

Vérifie si l’élément est visible.

Un élément est considéré comme visible si au moins un pixel de celui-ci est présent à l’écran.

Paramètres

item (long) -

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.3.

OnGetItemAttr(self, item)

Cette fonction peut être surchargée dans la classe dérivée pour un contrôle avec le style LC_VIRTUAL.

Elle doit retourner l’attribut de l’élément spécifié ou None pour utiliser les paramètres d’apparence par défaut.

wx.ListCtrl ne supprimera pas le pointeur et n’en conservera pas la référence.

Vous pouvez renvoyer le même pointeur wx.ItemAttr pour chaque appel OnGetItemAttr.

La version de la classe de base renvoie toujours None.

Paramètres

item (long) -

Type de retour: wx.ItemAttr

Voir aussi : OnGetItemImage , OnGetItemColumnImage , OnGetItemText , OnGetItemColumnAttr , OnGetItemIsChecked

OnGetItemColumnImage(self, item, column)

Surcharge cette fonction dans la classe dérivée pour un contrôle avec les styles LC_VIRTUAL et LC_REPORT afin de spécifier l’index de l’image pour la ligne et la colonne données.

La version de la classe de base appelle toujours OnGetItemImage pour la première colonne, sinon elle renvoie -1.

Les paramètres

item (long) -

colonne (long) -

Type de retour: int

Voir aussi : OnGetItemText , OnGetItemImage , OnGetItemAttr , OnGetItemColumnAttr

OnGetItemImage(self, item)

Cette fonction doit être surchargée dans la classe dérivée pour un contrôle de style LC_VIRTUAL utilisant des images.

Si le contrôle n’utilise pas d’images, c’est-à-dire si SetNormalImages ou SetSmallImages n’a pas été appelé, il n’est pas nécessaire de la surcharger.

Elle doit retourner l’index de l’image de l’élément dans la liste des images du contrôle ou -1 si aucune image n’est présente.

Dans un contrôle de style LC_REPORT, OnGetItemImage n’est appelé que pour la première colonne de chaque ligne.

La version de la classe de base renvoie toujours -1.

Paramètres

item (long) -

Type de retour: int

Voir aussi : OnGetItemText , OnGetItemColumnImage , OnGetItemAttr

OnGetItemIsChecked(self, item)

Cette fonction doit être surchargée dans la classe dérivée pour un contrôle de style LC_VIRTUAL qui utilise des cases à cocher.

Elle doit retourner si la case à cocher de l’élément spécifié est cochée.

Paramètres

item (long) -

Type de retour: bool

Nouveau dans la version 4.1/wxWidgets-3.1.2.

Voir aussi : EnableCheckBoxes , OnGetItemText

OnGetItemText(self, item, column)

Cette fonction doit être surchargée dans la classe dérivée pour un contrôle avec le style LC_VIRTUAL.

Elle doit renvoyer la chaîne de caractères contenant le texte de la colonne donnée pour l’élément spécifié.

Paramètres

-
item (long) -

-
colonne (long) -

Type de retour: chaîne

Voir aussi : SetItemCount , OnGetItemImage , OnGetItemColumnImage , OnGetItemAttr

RefreshItem(self, item)

Redessine l’élément donné.

Cette fonction n’est utile que pour les contrôles de liste virtuels, car si elle n’est pas appelée, la valeur affichée de l’élément ne change pas, même si les données sous-jacentes changent.

Paramètres

item (long) -

Voir aussi RefreshItems

RefreshItems(self, itemFrom, itemTo)

Redessine les éléments entre itemFrom et itemTo.

L’élément de départ doit être inférieur ou égal à l’élément d’arrivée.

Tout comme RefreshItem, cette fonction n’est utile que pour les contrôles de liste virtuels.

Paramètres

-
itemFrom (long) -

-
itemTo (long) -

RemoveSortIndicator(self)

Supprime l’indicateur de tri de la colonne utilisée comme clé de tri.

Nouveau dans la version 4.1/wxWidgets-3.1.6.

ScrollList(self, dx, dy)

Fait défiler le contrôle de liste.

En mode icône, petite icône ou rapport, dx spécifie le nombre de pixels à faire défiler.

En mode liste, dx indique le nombre de colonnes à faire défiler.

dy indique toujours le nombre de pixels à faire défiler verticalement.

Paramètres

-
dx (int) -

-
dy (int) -

Type de retour: bool

Note : Cette méthode n’est actuellement implémentée que dans la version Windows.

Select(self, idx, on=1)

Sélectionne/désélectionne un élément.

SetAlternateRowColour(self, colour)

Fixe la couleur d’arrière-plan de la ligne alternative à une couleur spécifique.

Il est recommandé d’appeler EnableAlternateRowColours au lieu d’utiliser ces méthodes, car les implémentations natives de ce contrôle peuvent prendre en charge l’alternance des couleurs des lignes, mais sans définir la couleur exacte à utiliser pour celles-ci.

Comme EnableAlternateRowColours , cette méthode ne peut être utilisée qu’avec les contrôles ayant les styles LC_REPORT et LC_VIRTUAL.

Paramètres

colour (wx.Colour) - Une couleur d’arrière-plan de ligne alternative valide pour activer les lignes alternées ou une couleur invalide pour les désactiver et utiliser la même couleur pour toutes les lignes.

Nouveau dans la version 2.9.5.

SetBackgroundColour(self, col)

Définit la couleur d’arrière-plan.

Notez que la fonction wx.Window.GetBackgroundColour de la classe de base wx.Window peut être utilisée pour récupérer la couleur d’arrière-plan courante.

Paramètres

col (wx.Colour) -

Type de retour: bool

Remarque : si la coloration des lignes alternatives est activée, il convient d’appeler à nouveau la fonction EnableAlternateRowColours après avoir modifié la couleur d’arrière-plan.

Cela mettra à jour la couleur des lignes alternatives pour qu’elle corresponde à la nouvelle couleur d’arrière-plan.

SetColumn(self, col, item)

Définit les informations relatives à cette colonne.

Voir SetItem pour plus d’informations.

Paramètres

-
col (int) -

-
item (wx.ListItem) -

Type de retour: bool

SetColumnImage(self, col, image)

SetColumnWidth(self, col, width)

Définit la largeur de la colonne.

width peut être une largeur en pixels ou LIST_AUTOSIZE (-1) ou LIST_AUTOSIZE_USEHEADER (-2).

LIST_AUTOSIZE redimensionne la colonne à la longueur de son élément le plus long.

LIST_AUTOSIZE_USEHEADER redimensionne la colonne à la longueur de l’en-tête (Win32) ou à 80 pixels (autres plates-formes).

En vue petite ou normale, col doit être -1, et la largeur de la colonne est définie pour toutes les colonnes.

Paramètres

-
col (int) -

-
width (int) -

Type de retour: bool

SetColumnsOrder(self, orders)

Modifie l’ordre dans lequel les colonnes sont affichées.

Le tableau orders doit avoir le même nombre d’éléments que le nombre de colonnes et contenir chaque position exactement une fois.

Son n-ième élément contient l’index de la colonne à afficher en n-ième position, donc pour un contrôle avec trois colonnes, passer un tableau avec les éléments 2, 0 et 1 résulte en l’affichage de la troisième colonne en premier, de la première ensuite et de la deuxième en dernier.

Paramètres

orders (liste d’entiers) -

Type de retour: bool

Note : Cette fonction n’a de sens que pour l’affichage des rapports et n’est actuellement implémentée que dans le portage wxMSW.

Utilisez HAS_LISTCTRL_COLUMN_ORDER pour protéger l’utilisation de cette fonction afin qu’elle fonctionne sur les autres plates-formes lorsque la prise en charge de la réorganisation des colonnes y sera ajoutée.

Voir aussi : GetColumnsOrder

SetHeaderAttr(self, attr)

Modifie la police et les couleurs utilisées pour l’en-tête du contrôle de liste.

Cette méthode peut être utilisée pour modifier l’apparence de l’en-tête affiché par le contrôle en mode rapport (sauf si le style LC_NO_HEADER est utilisé).

Actuellement, elle n’est implémentée que pour wxMSW et ne fait rien dans les autres ports.

Paramètres

attr (wx.ItemAttr) - L’objet contenant la police et les couleurs de texte et d’arrière-plan à utiliser.

Il peut être par défaut, c’est-à-dire ne pas spécifier de police ou de couleurs personnalisées, pour réinitialiser tout attribut personnalisé précédemment défini.

Type de retour: bool

Retourne
True si les attributs ont été mis à jour ou False si cela n’est pas supporté par la plateforme actuelle.

Nouveau dans la version 4.1/wxWidgets-3.1.1.

SetImageList(self, imageList, which)

Définit la liste d’images associée au contrôle.

Il est recommandé d’utiliser SetNormalImages ou SetSmallImages à la place de cette fonction dans le nouveau code.

qui doit être l’une des valeurs suivantes : IMAGE_LIST_NORMAL , IMAGE_LIST_SMALL , IMAGE_LIST_STATE (la prise en charge de la dernière valeur n’est pas implémentée).

Cette méthode ne prend pas possession de la liste d’images, vous devez la supprimer vous-même.

Notez que, contrairement à la plupart des autres méthodes de cette classe, il est possible d’appeler cette fonction avant que la fenêtre correspondante ne soit créée, c’est-à-dire dans un constructeur d’une classe dérivée de wx.ListCtrl avant d’appeler Create .

Les paramètres

imageList (wx.ImageList) -

which (int) -

Voir aussi : AssignImageList

SetItem(self, *args, **kw)

surcharge Implémentations surchargées :

SetItem (self, info)
Définit les données d’un élément.

En utilisant le masque et le masque d’état de wx.ListItem, vous pouvez modifier uniquement les attributs sélectionnés d’un élément wx.ListCtrl.

Paramètres

info (wx.ListItem) -

Type de retour: bool

Retourne
True si l’élément a été mis à jour avec succès ou False si la mise à jour a échoué pour une raison quelconque (par exemple, un index d’élément invalide).

SetItem (self, index, column, label, imageId=-1)
Définit le champ d’une chaîne de caractères d’un élément dans une colonne particulière.

Paramètres

-
index (long) -

-
colonne (int) -

-
label (string) -

-
imageId (int) -

Type de retour: bool

Retourne
True si l’élément a été mis à jour avec succès ou False si la mise à jour a échoué pour une raison quelconque (par exemple, un index d’élément invalide).

SetItemBackgroundColour(self, item, col)

Définit la couleur d’arrière-plan de cet élément.

Cette fonction ne fonctionne qu’en mode rapport.

La couleur peut être récupérée à l’aide de GetItemBackgroundColour .

Paramètres

-
élément (long) -

-
col (wx.Colour) -

SetItemColumnImage(self, item, column, image)

Définit l’image associée à l’élément.

Dans la vue rapport, vous pouvez spécifier la colonne.

L’image est un index dans la liste d’images associée au contrôle de liste.

Paramètres

-
élément (long) -

-
colonne (long) -

-
image (int) -

Type de retour: bool

SetItemCount(self, count)

Cette méthode ne peut être utilisée qu’avec les contrôles de listes virtuelles.

Elle permet d’indiquer au contrôle le nombre d’éléments qu’il contient.

Après l’avoir appelée, le programme principal doit être prêt à gérer les appels à divers rappels d’éléments (tels que wx.ListCtrl.OnGetItemText ) pour tous les éléments dans l’intervalle de 0 à count.

Notez que le contrôle n’est pas nécessairement redessiné après cet appel, car il peut être indésirable qu’un élément qui n’est pas visible à l’écran soit ajouté ou supprimé d’un contrôle affichant de nombreux éléments.

Si vous avez besoin de rafraîchir l’affichage, vous pouvez simplement appeler Refresh manuellement.

Paramètres

count (long) -

SetItemData(self, item, data)

Associe des données définies par l’application à cet élément.

Notez que cette fonction ne peut pas être utilisée pour associer des pointeurs aux éléments de contrôle, utilisez SetItemPtrData à la place.

Paramètres

-
item (long) -

-
data (long) -

Type de retour: bool

SetItemFont(self, item, font)

Définit la police de l’élément.

Paramètres

-
item (long) -

-
font (wx.Font) -

SetItemImage(self, item, image, selImage=-1)

Définit les images non sélectionnées et sélectionnées associées à l’élément.

Les images sont indexées dans la liste d’images associée au contrôle de liste.

Paramètres

-
item (long) -

-
image (int) -

-
selImage (int) -

Type de retour: bool

SetItemPosition(self, item, pos)

Définit la position de l’élément, en vue icône ou petite icône.

Windows uniquement.

Paramètres

-
item (long) -

-
pos (wx.Point) -

Type de retour: bool

SetItemState(self, item, state, stateMask)

Définit l’état de l’élément.

Le masque d’état est une combinaison des constantes LIST_STATE_XXX décrites dans la documentation de wx.ListItem.

Pour chacun des bits spécifiés dans stateMask, l’état correspondant est activé ou désactivé selon que l’argument state contient ou non le même bit.

Ainsi, pour sélectionner un élément, vous pouvez utiliser
listCtrl.SetItemState(item, wx.LIST_STATE_SELECTED, wx.LIST_STATE_SELECTED)
tandis que pour le désélectionner, vous devez utiliser
listCtrl.SetItemState(item, 0, wx.LIST_STATE_SELECTED)
Pensez à utiliser wx.ListView si possible pour éviter d’avoir à gérer cette méthode source d’erreurs et de confusion.

Notez également que, contrairement à la règle habituelle selon laquelle seules les actions de l’utilisateur génèrent des événements, cette méthode génère l’événement wxEVT_LIST_ITEM_SELECTED lorsqu’elle est utilisée pour sélectionner un élément.

Les paramètres

item (long) -

état (long) -

stateMask (long) -

Type de retour: bool

SetItemText(self, item, text)

Définit le texte de l’élément pour cet élément.

Paramètres

-
item (long) -

-
texte (chaîne) -

SetItemTextColour(self, item, col)

Définit la couleur de cet élément.

Cette fonction ne fonctionne qu’en mode rapport.

La couleur peut être récupérée à l’aide de GetItemTextColour .

Paramètres

-
item (long) -

-
col (wx.Colour) -

SetNormalImages(self, images)

Définit les images à utiliser pour afficher les grandes icônes normales dans ce contrôle.

Ces images sont utilisées par les éléments lorsque le contrôle de liste est en mode wx.LC_ICON, dans tous les autres modes, les images définies par SetSmallImages sont utilisées.

Cette fonction devrait être préférée à l’appel de SetImageList ou AssignImageList avec l’argument IMAGE_LIST_NORMAL dans le nouveau code, car l’utilisation de wx.BitmapBundle permet de spécifier plusieurs versions des icônes, ce qui permet au contrôle de choisir la bonne pour la mise à l’échelle DPI actuelle.

Paramètres

images (Vecteur) -

Nouveau dans la version 4.1/wxWidgets-3.1.6.

SetSingleStyle(self, style, add=True)

Ajoute ou supprime un style de fenêtre unique.

Paramètres

-
style (long) -

-
add (bool) -

SetSmallImages(self, images)

Définit les images à utiliser pour afficher les petites icônes dans ce contrôle.

Ces images sont utilisées par les éléments lorsque le contrôle de liste est en mode wx.LC_SMALL_ICON ou wx.LC_REPORT, utilisez SetNormalImages pour les icônes utilisées en mode wx.LC_ICON.

Cette fonction devrait être préférée à l’appel de SetImageList ou AssignImageList avec l’argument IMAGE_LIST_SMALL dans le nouveau code, car l’utilisation de wx.BitmapBundle permet de spécifier plusieurs versions des icônes, ce qui permet au contrôle de choisir la bonne pour la mise à l’échelle DPI actuelle.

Paramètres

images (Vecteur) -

Nouveau dans la version 4.1/wxWidgets-3.1.6.

SetTextColour(self, col)

Définit la couleur du texte du contrôle de liste.

Paramètres

col (wx.Colour) -

SetWindowStyleFlag(self, style)

Définit le style de la fenêtre entière, en supprimant tous les éléments.

Paramètres

style (long) -## ### yannickShowStyleFlag(self)

ShowSortIndicator(self, col, ascending=True)

Affiche l’indicateur de tri d’une colonne spécifique dans une direction spécifique.

Les indicateurs de tri ne sont affichés que dans l’affichage des rapports et, dans la version native de wxMSW, ils remplacent toute icône de colonne, c’est-à-dire que si l’indicateur de tri est affiché pour une colonne, aucune (autre) icône n’est affichée.

Cette fonction doit généralement être appelée à partir du gestionnaire EVT_LIST_COL_CLICK.

Paramètres

-
col (int) - La colonne pour laquelle l’indicateur de tri doit être défini.

Si -1 est donné, l’indicateur de tri actuellement affiché sera supprimé.

ascending (bool) - Si True ou False, l’indicateur de tri correspondant à l’ordre de tri ascendant ou descendant est affiché.

Nouveau dans la version 4.1/wxWidgets-3.1.6.

Note : Ceci ne trie pas réellement la liste, utilisez SortItems pour cela.

SortItems(self, fnSortCallBack)

Appeler cette fonction pour trier les éléments du contrôle de liste.

Le tri est effectué à l’aide de la fonction fnSortCallBack spécifiée.

Cette fonction doit avoir le prototype suivant :
def ListCompareFunction(self, item1, item2) :

pass

Elle est appelée à chaque fois que les deux éléments doivent être comparés et doit renvoyer 0 si les éléments sont égaux, une valeur négative si le premier élément est inférieur au second et une valeur positive si le premier élément est supérieur au second (la même convention que celle utilisée par qsort(3) ).

Le paramètre item1 est la donnée client associée au premier élément (PAS l’index).

Le paramètre item2 est la donnée client associée au deuxième élément (PAS l’index).

Le paramètre data est la valeur transmise à SortItems lui-même.

Notez que le contrôle ne peut être trié que sur les données client associées aux éléments, vous devez donc utiliser SetItemData si vous voulez pouvoir trier les éléments dans le contrôle.

Veuillez consulter l’exemple de contrôle de liste pour un exemple d’utilisation de cette fonction.

Propriétés
Couleur de la ligne alternative
Voir GetAlternateRowColour et SetAlternateRowColour

Column

Voir GetColumn et SetColumn

ColumnCount

Voir GetColumnCount

ColumnsOrder

Voir GetColumnsOrder et SetColumnsOrder

CountPerPage

Voir ObtenirCompterPage

EditControl

Voir GetEditControl

FocusedItem

Voir GetFocusedItem

Item

Voir GetItem et SetItem

ItemCount

Voir GetItemCount et SetItemCount

ItemPosition

Voir ObtenirItemPosition et DéfinirItemPosition

ItemRect

Voir GetItemRect

ItemSpacing

Voir Obtenir l’espacement de l’élément

MainWindow

Voir Obtenir la fenêtre principale

SelectedItemCount

Voir ObtenirSelectedItemCount

SortIndicator

Voir GetSortIndicator

TextColour

Voir GetTextColour et SetTextColour

TopItem

Voir GetTopItem

ViewRect

Voir GetViewRect

​