SFML logo
  • Main Page
  • Data Structures
  • Files
  • File List
  • Globals

String.h

Go to the documentation of this file.
00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages arising from the use of this software.
00008 //
00009 // Permission is granted to anyone to use this software for any purpose,
00010 // including commercial applications, and to alter it and redistribute it freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_STRING_H
00026 #define SFML_STRING_H
00027 
00029 // Headers
00031 #include <SFML/Config.h>
00032 #include <SFML/Graphics/BlendMode.h>
00033 #include <SFML/Graphics/Color.h>
00034 #include <SFML/Graphics/Rect.h>
00035 #include <SFML/Graphics/Types.h>
00036 
00037 
00041 typedef enum
00042 {
00043     sfStringRegular    = 0,      
00044     sfStringBold       = 1 << 0, 
00045     sfStringItalic     = 1 << 1, 
00046     sfStringUnderlined = 1 << 2  
00047 } sfStringStyle;
00048 
00049 
00056 CSFML_API sfString* sfString_Create();
00057 
00064 CSFML_API void sfString_Destroy(sfString* String);
00065 
00073 CSFML_API void sfString_SetX(sfString* String, float X);
00074 
00082 CSFML_API void sfString_SetY(sfString* String, float Y);
00083 
00092 CSFML_API void sfString_SetPosition(sfString* String, float Left, float Top);
00093 
00101 CSFML_API void sfString_SetScaleX(sfString* String, float Scale);
00102 
00110 CSFML_API void sfString_SetScaleY(sfString* String, float Scale);
00111 
00120 CSFML_API void sfString_SetScale(sfString* String, float ScaleX, float ScaleY);
00121 
00129 CSFML_API void sfString_SetRotation(sfString* String, float Rotation);
00130 
00140 CSFML_API void sfString_SetCenter(sfString* String, float X, float Y);
00141 
00149 CSFML_API void sfString_SetColor(sfString* String, sfColor Color);
00150 
00158 CSFML_API void sfString_SetBlendMode(sfString* String, sfBlendMode Mode);
00159 
00168 CSFML_API float sfString_GetX(sfString* String);
00169 
00178 CSFML_API float sfString_GetY(sfString* String);
00179 
00188 CSFML_API float sfString_GetScaleX(sfString* String);
00189 
00198 CSFML_API float sfString_GetScaleY(sfString* String);
00199 
00208 CSFML_API float sfString_GetRotation(sfString* String);
00209 
00218 CSFML_API float sfString_GetCenterX(sfString* String);
00219 
00228 CSFML_API float sfString_GetCenterY(sfString* String);
00229 
00238 CSFML_API sfColor sfString_GetColor(sfString* String);
00239 
00248 CSFML_API sfBlendMode sfString_GetBlendMode(sfString* String);
00249 
00258 CSFML_API void sfString_Move(sfString* String, float OffsetX, float OffsetY);
00259 
00268 CSFML_API void sfString_Scale(sfString* String, float FactorX, float FactorY);
00269 
00277 CSFML_API void sfString_Rotate(sfString* String, float Angle);
00278 
00290 CSFML_API void sfString_TransformToLocal(sfString* String, float PointX, float PointY, float* X, float* Y);
00291 
00303 CSFML_API void sfString_TransformToGlobal(sfString* String, float PointX, float PointY, float* X, float* Y);
00304 
00312 CSFML_API void sfString_SetText(sfString* String, const char* Text);
00313 
00321 CSFML_API void sfString_SetUnicodeText(sfString* String, const sfUint32* Text);
00322 
00330 CSFML_API void sfString_SetFont(sfString* String, sfFont* Font);
00331 
00339 CSFML_API void sfString_SetSize(sfString* String, float Size);
00340 
00348 CSFML_API void sfString_SetStyle(sfString* String, unsigned long Style);
00349 
00358 CSFML_API const sfUint32* sfString_GetUnicodeText(sfString* String);
00359 
00368 CSFML_API const char* sfString_GetText(sfString* String);
00369 
00378 CSFML_API sfFont* sfString_GetFont(sfString* String);
00379 
00388 CSFML_API float sfString_GetSize(sfString* String);
00389 
00398 CSFML_API unsigned long sfString_GetStyle(sfString* String);
00399 
00411 CSFML_API void sfString_GetCharacterPos(sfString* String, size_t Index, float* X, float* Y);
00412 
00421 CSFML_API sfFloatRect sfString_GetRect(sfString* String);
00422 
00423 
00424 #endif // SFML_STRING_H

 ::  Copyright © 2007 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::