Fonctions membres publiques

# Référence de la classe USpeedGameEngine::Folder

Classe permettant de parcourir les répertoires. Plus de détails...

Liste de tous les membres

## Fonctions membres publiques

| Folder ()
| Le constructeur par défaut.
| ~Folder ()
| Le destructeur par défaut.
bool | nextElement ()
| Sélectionne l'élément du répertoire courant et retourne "true" si on a réussi à le sélectionner.
bool | open (const char *myFolder)
| Ouverture (pointeur vers) le répertoire spécifié.
bool | createFolder (const char *myFolder)
| Crée un répertoire.
void | reset ()
| Libération de la mémoire.
bool | getType ()
| Retourne le type de l'élément courant.
const char * | getName ()
| Retourne le nom de l'élément courant.
const char * | getFullname ()
| Retourne le nom complet de l'élément courant.
unsigned long int | getSize ()
| Retourne la taille de l'élément courant.
const char * | getExtension ()
| Retourne l'extension de l'élément courant.

## Description détaillée

Classe permettant de parcourir les répertoires.

Auteur:
  U.Speed

## Documentation des constructeurs et destructeur

Folder::Folder | ( |  | ) |

Le constructeur par défaut.

Auteur:
  U.Speed

Folder::~Folder | ( |  | ) |

Le destructeur par défaut.

Auteur:
  U.Speed

## Documentation des fonctions membres

bool Folder::createFolder | ( | const char * | myFolder | ) |

Crée un répertoire.

Auteur:
  U.Speed

Paramètres:

  | myFolder | const char* : le nom du répertoire à créer

Renvoie:
  bool : l'état de la création
  - true : répertoire créé
  - false : échec de la création

const char * Folder::getExtension | ( |  | ) |

Retourne l'extension de l'élément courant.

Auteur:
  U.Speed

Renvoie:
  const char* : l'extension de l'élément courant

const char * Folder::getFullname | ( |  | ) |

Retourne le nom complet de l'élément courant.

Auteur:
  U.Speed

Renvoie:
  const char* : nom complet du répertoire ou du fichier ou ""

const char * Folder::getName | ( |  | ) |

Retourne le nom de l'élément courant.

Auteur:
  U.Speed

Renvoie:
  const char* : nom du répertoire ou du fichier ou ""

unsigned long int Folder::getSize | ( |  | ) |

Retourne la taille de l'élément courant.

Auteur:
  U.Speed

Renvoie:
  unsigned long int : la taille du fichier courant ou 0 si c'est un répertoire

bool Folder::getType | ( |  | ) |

Retourne le type de l'élément courant.

     Les différents types (sous gcc avec "dirent")
         S_ISBLK(m)   Test for a block special file.
         S_ISCHR(m)   Test for a character special file.
         S_ISDIR(m)   Test for a directory.
         S_ISFIFO(m)  Test for a pipe or FIFO special file.
         S_ISREG(m)   Test for a regular file.
         S_ISLNK(m)   Test for a symbolic link.
         S_ISSOCK(m)  Test for a socket.

Auteur:
  U.Speed

Renvoie:
  bool : répertoire ou fichier ?
  - true : un fichier
  - false : un répertoire

bool Folder::nextElement | ( |  | ) |

Sélectionne l'élément du répertoire courant et retourne "true" si on a réussi à le sélectionner.

Auteur:
  U.Speed

Renvoie:
  bool : il y a un élément ?
  - true : il y a un élément
  - false : il n'y a pas d'élément

bool Folder::open | ( | const char * | myFolder | ) |

Ouverture (pointeur vers) le répertoire spécifié.

Auteur:
  U.Speed

Paramètres:

  | myFolder | const char* : le répertoire à ouvrir pour le parcourir (vide si répertoire ".")

Renvoie:
  bool : état de l'ouverture
  - true : répertoire ouvert
  - false : échec d'ouverture

void Folder::reset | ( |  | ) |

Libération de la mémoire.

Auteur:
  U.Speed

La documentation de cette classe a été générée à partir des fichiers suivants :

- src/Folder/Folder.hpp
- src/Folder/Folder.cpp
- src/Folder/Folder_createFolder.cpp
- src/Folder/Folder_getExtension.cpp
- src/Folder/Folder_getFullname.cpp
- src/Folder/Folder_getName.cpp
- src/Folder/Folder_getSize.cpp
- src/Folder/Folder_getType.cpp
- src/Folder/Folder_nextElement.cpp
- src/Folder/Folder_open.cpp
- src/Folder/Folder_reset.cpp