Documentation du code de SPIP et de ses plugins

Porte plume

BarreOutils

Table of Contents

Classes

BarreOutils
Objet contenant les différents paramètres definissant une barre d'outils Markitup et permettant d'agir dessus

Functions

barre_outils_edition()  : BarreOutils
Définition de la barre 'edition' pour markitup
barre_outils_edition_icones()  : array<string|int, mixed>
Définitions des liens entre css et icones
barre_outils_forum()  : BarreOutils
Définition de la barre 'forum' pour markitup
barre_outils_vide()  : BarreOutils
Définition de la barre 'vide' pour markitup
barre_outils_css_icones()  : string
Crée le code CSS pour les images des icones des barres d'outils
barre_outils_initialiser()  : BarreOutils|bool
Retourne une instance de Barre_outils crée à partir du type de barre demandé
barre_outils_liste()  : array<string|int, mixed>|bool
Retourne la liste des barres d'outils connues
traitements_previsu_php_modeles_eval()  : false|string
Evaluer le PHP des modèles dans la previsu
porte_plume_creer_json_markitup()  : string
Retourne la définition de la barre markitup désignée.

Functions

barre_outils_edition()

Définition de la barre 'edition' pour markitup

barre_outils_edition() : BarreOutils
Return values
BarreOutils

La barre d'outil

barre_outils_edition_icones()

Définitions des liens entre css et icones

barre_outils_edition_icones() : array<string|int, mixed>
Return values
array<string|int, mixed>

Couples identifiant de bouton => nom de l'image (ou tableau nom, position haut, position bas)

barre_outils_forum()

Définition de la barre 'forum' pour markitup

barre_outils_forum() : BarreOutils
Return values
BarreOutils

La barre d'outil

barre_outils_vide()

Définition de la barre 'vide' pour markitup

barre_outils_vide() : BarreOutils
Return values
BarreOutils

La barre d'outil

barre_outils_css_icones()

Crée le code CSS pour les images des icones des barres d'outils

barre_outils_css_icones() : string

S'appuie sur la description des jeux de barres disponibles et cherche une fonction barre_outils_($barre)_icones pour chaque barre et l'exécute si existe, attendant alors en retour un tableau de couples : nom de l'outil => nom de l'image

Tags
pipeline_appel

porte_plume_lien_classe_vers_icone

Return values
string

Déclaration CSS des icones

barre_outils_initialiser()

Retourne une instance de Barre_outils crée à partir du type de barre demandé

barre_outils_initialiser(string $set) : BarreOutils|bool

Une fonction barre_outils_{type}_dist() retournant la barre doit donc exister.

Parameters
$set : string

Type de barre (ex: 'edition')

Return values
BarreOutils|bool

La barre d'outil si la fonction a été trouvée, false sinon

barre_outils_liste()

Retourne la liste des barres d'outils connues

barre_outils_liste() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

Tableau des noms de barres d'outils trouvées False si on ne trouve aucune barre.

traitements_previsu_php_modeles_eval()

Evaluer le PHP des modèles dans la previsu

traitements_previsu_php_modeles_eval(mixed $php) : false|string
Parameters
$php : mixed
Return values
false|string

porte_plume_creer_json_markitup()

Retourne la définition de la barre markitup désignée.

porte_plume_creer_json_markitup() : string

(cette déclaration est au format json)

Deux pipelines 'porte_plume_pre_charger' et 'porte_plume_charger' permettent de récuperer l'objet de classe Barre_outil avant son export en json pour modifier des elements.

Tags
pipeline_appel

porte_plume_barre_pre_charger Charge des nouveaux boutons au besoin

pipeline_appel

porte_plume_barre_charger Affiche ou cache certains boutons

Return values
string

Déclaration json


        
On this page

Search results