5 [FR] Documentation (2.3)

KikooDX edited this page 2019-11-06 10:07:18 +01:00

class Screen:
    """NB: L'origine des coordonnées est en haut à gauche et vaut X=1;Y=1."""


    __init__(self, width=21, height=6, patern=" ", copy=None):
        Initialise l'objet, avec largeur de 21 par défaut, hauteur de 6 par défaut, remplit de vide par défaut.
        Si `copy` est spécifié, cet objet devient une copie de l'objet mis en paramètre.

    locate(self, x, y, string):
        Situe `string` aux coordonnées spécifiées de l'objet, place les caractères
        horizontalement de gauche à droite.

    locate_v(self, x, y, string):
        Situe `string` aux coordonnées spécifiées de l'objet, place les caractères
        verticalement de haut en bas.

    fill(self, patern=" "):
        Remplit l'objet avec le caractère `patern`.

    refresh(self, ask_for_input=True, endl="\n"):
        Affiche l'objet.
        Si `ask_for_input` est vrai, met en pause et demande une entrée utilisateur après exécution.
        `endl` est affiché si `ask_for_input` est faux.

    get_cell(self, x, y):
        Renvoie le contenu de la case aux coordonnées spécifiées de l'objet.

    get_dim(self):
        Renvoie les dimensions de l'objet (largeur puis hauteur).

    export(self):
        Renvoie une chaine de caractères représentant l'objet.

    load(self, string):
        Charge une chaine de caractères telle que celles créées par `self.export()` et remplit
        l'objet de son contenu.



class Pad(Screen): Hérité de Screen
    """Fonctionne de façon identique à Screen, mais permet de n'afficher qu'une partie de l'objet"""

    refresh(self, x=1, y=1, width=21, height=6, ask_for_input=True, endl="\n"):
        Même fonctionnement que `Screen.refresh()` pour les paramètres en commun.
        Affiche l'objet à partir de (X=x;Y=y) jusqu'à (X=x+width-1;Y=y+height-1).