Crazy Eddie's GUI System
0.8.7
|
27 #ifndef _CEGUIFalFrameComponent_h_
28 #define _CEGUIFalFrameComponent_h_
30 #include "CEGUI/falagard/ComponentBase.h"
31 #include "CEGUI/XMLSerializer.h"
32 #include "CEGUI/falagard/FormattingSetting.h"
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
368 return d_specified == rhs.d_specified &&
369 d_image == rhs.d_image &&
370 d_propertyName == rhs.d_propertyName;
379 const Image* d_image;
386 const Rectf* clipper,
bool clipToDisplay)
const;
392 const Rectf* clipper,
bool clipToDisplay)
const;
407 #if defined(_MSC_VER)
408 # pragma warning(pop)
VerticalFormatting getBackgroundVerticalFormatting(const Window &wnd) const
Return the vertical formatting to be used for the background image.
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
HorizontalFormatting getBackgroundHorizontalFormatting(const Window &wnd) const
Return the horizontal formatting to be used for the background image.
bool isImageSpecified(FrameImageComponent part) const
Return whether the given component image has been specified.
Class that encapsulates information for a frame with background (9 images in total)
Definition: FrameComponent.h:52
const String & getImagePropertySource(FrameImageComponent part) const
Return the name of the property that will be used to determine the image to use for the given compone...
void setBottomEdgeFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the formatting to use for the bottom edge imag...
void setLeftEdgeFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the formatting to use for the left edge image.
void setTopEdgeFormatting(HorizontalFormatting fmt)
Set the formatting to be used for the top edge image.
bool CEGUIEXPORT operator!=(const String &str1, const String &str2)
Return true if String str1 is not equal to String str2.
VerticalFormatting getRightEdgeFormatting(const Window &wnd) const
Return the formatting to be used for the right edge image.
bool isImageFetchedFromProperty(FrameImageComponent part) const
Return whether the given component image is specified via a property.
Class used to create XML Document.
Definition: XMLSerializer.h:87
void setTopEdgeFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the formatting to use for the top edge image.
void setImage(FrameImageComponent part, const Image *image)
Set an Image that will be drawn by this FrameComponent.
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Class that holds details of colours for the four corners of a rectangle.
Definition: ColourRect.h:45
const Image * getImage(FrameImageComponent imageComponent) const
Return a pointer to the Image object that was set for this FrameComponent for a specified frame part.
void setImage(FrameImageComponent part, const String &name)
Set an Image that will be drawn by this FrameComponent.
void setBackgroundVerticalFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the vertical formatting to use for the backdro...
void setBottomEdgeFormatting(HorizontalFormatting fmt)
Set the formatting to be used for the bottom edge image.
void setRightEdgeFormatting(VerticalFormatting fmt)
Set the formatting to be used for the right edge image.
static const HorizontalFormatting HorizontalFormattingDefault
Default value for the HorzFormat elements of the FrameComponent.
Definition: FrameComponent.h:354
void setImagePropertySource(FrameImageComponent part, const String &name)
Set the name of the Property that will be accesssed on the target Window to determine the Image that ...
HorizontalFormatting
Enumeration of possible values to indicate the horizontal formatting to be used for an image componen...
Definition: Enums.h:72
HorizontalFormatting getTopEdgeFormatting(const Window &wnd) const
Return the formatting to be used for the top edge image.
void setLeftEdgeFormatting(VerticalFormatting fmt)
Set the formatting to be used for the left edge image.
FrameImageComponent
Enumeration of values referencing available images forming a frame component.
Definition: Enums.h:136
VerticalFormatting
Enumeration of possible values to indicate the vertical formatting to be used for an image component.
Definition: Enums.h:59
void writeXMLToStream(XMLSerializer &xml_stream) const
Writes an xml representation of this FrameComponent to out_stream.
static const VerticalFormatting VerticalFormattingDefault
Default value for the VertFormat elements of the FrameComponent.
Definition: FrameComponent.h:356
bool CEGUIEXPORT operator==(const String &str1, const String &str2)
Return true if String str1 is equal to String str2.
Common base class used for renderable components within an ImagerySection.
Definition: ComponentBase.h:39
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition: Window.h:151
VerticalFormatting getLeftEdgeFormatting(const Window &wnd) const
Return the formatting to be used for the left edge image.
void setBackgroundHorizontalFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the horizontal formatting to use for the backd...
void render_impl(Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const
Function to do main render caching work.
HorizontalFormatting getBottomEdgeFormatting(const Window &wnd) const
Return the formatting to be used for the bottom edge image.
String class used within the GUI system.
Definition: String.h:64
Definition: FrameComponent.h:360
const Image * getImage(FrameImageComponent imageComponent, const Window &wnd) const
Return the Image object that will be drawn by this FrameComponent for a specified frame part.
@ FIC_FRAME_IMAGE_COUNT
Max number of images for a frame.
Definition: Enums.h:146
void setRightEdgeFormattingPropertySource(const String &property_name)
Set the name of a property that will be used to obtain the formatting to use for the right edge image...
void setBackgroundHorizontalFormatting(HorizontalFormatting fmt)
Set the horizontal formatting to be used for the background image.
Interface for Image.
Definition: Image.h:161
void setBackgroundVerticalFormatting(VerticalFormatting fmt)
Set the vertical formatting to be used for the background image.