OldSchoolHack GUI
Öffentliche Methoden | Öffentliche, statische Methoden | Geschützte Methoden | Geschützte Attribute | Aufstellung aller Elemente
OSHGui::Control Klassenreferenzabstract
Klassendiagramm für OSHGui::Control:
Inheritance graph
[Legende]
Zusammengehörigkeiten von OSHGui::Control:
Collaboration graph
[Legende]

Öffentliche Methoden

virtual CONTROL_TYPE GetType () const
 
virtual bool GetIsFocused () const
 
virtual void SetEnabled (bool isEnabled)
 
virtual bool GetEnabled () const
 
virtual void SetVisible (bool isVisible)
 
virtual bool GetVisible () const
 
virtual void SetAutoSize (bool autoSize)
 
virtual bool GetAutoSize () const
 
virtual void SetBounds (const Drawing::Rectangle &bounds)
 
virtual void SetBounds (const Drawing::Point &location, const Drawing::Size &size)
 
virtual void SetBounds (int x, int y, int w, int h)
 
virtual const Drawing::Rectangle GetBounds () const
 
virtual void SetLocation (int x, int y)
 
virtual void SetLocation (const Drawing::Point &location)
 
virtual const Drawing::PointGetLocation () const
 
virtual void SetSize (int width, int height)
 
virtual void SetSize (const Drawing::Size &size)
 
virtual const Drawing::SizeGetSize () const
 
virtual int GetLeft () const
 
virtual int GetTop () const
 
virtual int GetRight () const
 
virtual int GetBottom () const
 
virtual int GetWidth () const
 
virtual int GetHeight () const
 
virtual void SetAnchor (AnchorStyle anchor)
 
virtual AnchorStyle GetAnchor () const
 
virtual void SetTag (Misc::Any &tag)
 
virtual const Misc::AnyGetTag () const
 
virtual void SetName (const Misc::AnsiString &name)
 
virtual const Misc::AnsiString & GetName () const
 
virtual void SetFont (const std::shared_ptr< Drawing::IFont > &font)
 
const std::shared_ptr
< Drawing::IFont > & 
GetFont () const
 
void SetCursor (const std::shared_ptr< Cursor > &cursor)
 
virtual const std::shared_ptr
< Cursor > & 
GetCursor () const
 
virtual void SetForeColor (Drawing::Color color)
 
virtual Drawing::Color GetForeColor () const
 
virtual void SetBackColor (Drawing::Color color)
 
virtual Drawing::Color GetBackColor () const
 
virtual void SetMouseOverFocusColor (Drawing::Color color)
 
virtual Drawing::Color GetMouseOverFocusColor () const
 
LocationChangedEventGetLocationChangedEvent ()
 
SizeChangedEventGetSizeChangedEvent ()
 
ClickEventGetClickEvent ()
 
MouseClickEventGetMouseClickEvent ()
 
MouseDownEventGetMouseDownEvent ()
 
MouseUpEventGetMouseUpEvent ()
 
MouseMoveEventGetMouseMoveEvent ()
 
MouseScrollEventGetMouseScrollEvent ()
 
MouseEnterEventGetMouseEnterEvent ()
 
MouseLeaveEventGetMouseLeaveEvent ()
 
MouseCaptureChangedEventGetMouseCaptureChangedEvent ()
 
KeyDownEventGetKeyDownEvent ()
 
KeyPressEventGetKeyPressEvent ()
 
KeyUpEventGetKeyUpEvent ()
 
FocusGotEventGetFocusGotEvent ()
 
FocusLostEventGetFocusLostEvent ()
 
virtual void SetParent (Control *parent)
 
virtual ControlGetParent () const
 
virtual void Focus ()
 
virtual bool Intersect (const Drawing::Point &point) const =0
 
virtual void CalculateAbsoluteLocation ()
 
virtual const Drawing::Point PointToClient (const Drawing::Point &point) const
 
virtual const Drawing::Point PointToScreen (const Drawing::Point &point) const
 
bool ProcessMouseMessage (const MouseMessage &mouse)
 
bool ProcessKeyboardMessage (KeyboardMessage &keyboard)
 
virtual void Render (Drawing::IRenderer *renderer)
 
virtual void ApplyTheme (const Drawing::Theme &theme)
 

Öffentliche, statische Methoden

static Misc::AnsiString ControlTypeToString (CONTROL_TYPE controlType)
 

Geschützte Methoden

 Control ()
 
virtual void OnLocationChanged ()
 
virtual void OnSizeChanged ()
 
virtual void OnMouseDown (const MouseMessage &mouse)
 
virtual void OnMouseClick (const MouseMessage &mouse)
 
virtual void OnMouseUp (const MouseMessage &mouse)
 
virtual void OnMouseMove (const MouseMessage &mouse)
 
virtual void OnMouseScroll (const MouseMessage &mouse)
 
virtual void OnMouseEnter (const MouseMessage &mouse)
 
virtual void OnMouseLeave (const MouseMessage &mouse)
 
virtual void OnGotMouseCapture ()
 
virtual void OnLostMouseCapture ()
 
virtual void OnGotFocus (Control *newFocusedControl)
 
virtual void OnLostFocus (Control *newFocusedControl)
 
virtual bool OnKeyDown (const KeyboardMessage &keyboard)
 
virtual bool OnKeyPress (const KeyboardMessage &keyboard)
 
virtual bool OnKeyUp (const KeyboardMessage &keyboard)
 

Geschützte Attribute

Misc::AnsiString name
 
CONTROL_TYPE type
 
bool canRaiseEvents
 
bool isEnabled
 
bool isVisible
 
bool isInside
 
bool isClicked
 
bool isFocusable
 
bool isFocused
 
bool hasCaptured
 
bool autoSize
 
Misc::Any tag
 
Drawing::Point location
 
Drawing::Point absoluteLocation
 
Drawing::Size size
 
LocationChangedEvent locationChangedEvent
 
SizeChangedEvent sizeChangedEvent
 
ClickEvent clickEvent
 
MouseClickEvent mouseClickEvent
 
MouseDownEvent mouseDownEvent
 
MouseUpEvent mouseUpEvent
 
MouseMoveEvent mouseMoveEvent
 
MouseScrollEvent mouseScrollEvent
 
MouseEnterEvent mouseEnterEvent
 
MouseLeaveEvent mouseLeaveEvent
 
MouseCaptureChangedEvent mouseCaptureChangedEvent
 
KeyDownEvent keyDownEvent
 
KeyPressEvent keyPressEvent
 
KeyUpEvent keyUpEvent
 
FocusGotEvent focusGotEvent
 
FocusLostEvent focusLostEvent
 
Drawing::Color foreColor
 
Drawing::Color backColor
 
Drawing::Color mouseOverFocusColor
 
std::shared_ptr< Drawing::IFontfont
 
std::shared_ptr< Cursorcursor
 
Controlparent
 

Ausführliche Beschreibung

Definiert die Basisklasse für Steuerelemente, die Komponenten mit visueller Darstellung sind.

Beschreibung der Konstruktoren und Destruktoren

OSHGui::Control::Control ( )
protected

Konstruktor der Klasse.

Dokumentation der Elementfunktionen

void OSHGui::Control::ApplyTheme ( const Drawing::Theme theme)
virtual

Veranlasst das Steuerelement, sein Aussehen dem Theme anzupassen.

Parameter
theme

Erneute Implementation in OSHGui::ContainerControl.

void OSHGui::Control::CalculateAbsoluteLocation ( )
virtual

Berechnet die absolute Position des Steuerelements.

Erneute Implementation in OSHGui::TabControl, OSHGui::TrackBar, OSHGui::TextBox, OSHGui::ContainerControl, OSHGui::CheckBox, OSHGui::ScrollBar und OSHGui::Button.

Misc::AnsiString OSHGui::Control::ControlTypeToString ( CONTROL_TYPE  controlType)
static

Ruft die Stringrepresentation des Controltypes ab.

Parameter
controlTypecontroltype
Rückgabe
Stringrepresentation
void OSHGui::Control::Focus ( )
virtual

Setzt den Eingabefokus auf das Steuerelement.

Erneute Implementation in OSHGui::ComboBox.

AnchorStyle OSHGui::Control::GetAnchor ( ) const
virtual

Ruft die Ränder des Containers ab, an die ein Steuerelement gebunden ist, und bestimmt, wie die Größe des Steuerelements mit dessen übergeordnetem Element geändert wird.

Rückgabe
anchor
bool OSHGui::Control::GetAutoSize ( ) const
virtual

Ruft ab, ob die Größe des Steuerelements automatisch an dessen Inhalt anpasst.

Rückgabe
autoSize
Drawing::Color OSHGui::Control::GetBackColor ( ) const
virtual

Ruft die Hintergrundfarbe des Steuerelements ab.

Rückgabe
color
int OSHGui::Control::GetBottom ( ) const
virtual

Ruft den Abstand zwischen dem unteren Rand des Steuerelements und dem oberen Rand des Clientbereichs des zugehörigen Containers ab.

Rückgabe
bottom
const Drawing::Rectangle OSHGui::Control::GetBounds ( ) const
virtual

Ruft die Größe und Position des Steuerelements relativ zum übergeordneten Steuerelement ab.

Rückgabe
bounds
ClickEvent & OSHGui::Control::GetClickEvent ( )

Ruft das ClickEvent für das Steuerelement ab.

Rückgabe
clickEvent
const std::shared_ptr< Cursor > & OSHGui::Control::GetCursor ( ) const
virtual

Ruft den angezeigten Cursor ab, wenn sich die Maus über dem Steuerelement befindet.

Rückgabe
cursor
bool OSHGui::Control::GetEnabled ( ) const
virtual

Ruft ab, ob das Steuerlement auf Benutzerinteraktionen reagieren kann.

Rückgabe
isEnabled
FocusGotEvent & OSHGui::Control::GetFocusGotEvent ( )

Ruft das FocusGotEvent für das Steuerelement ab.

Rückgabe
forcusInEvent
FocusLostEvent & OSHGui::Control::GetFocusLostEvent ( )

Ruft das FocusLostEvent für das Steuerelement ab.

Rückgabe
forcusOutEvent
const std::shared_ptr< Drawing::IFont > & OSHGui::Control::GetFont ( ) const

Ruft die Schriftart des Texts im Steuerelement ab.

Rückgabe
font
Drawing::Color OSHGui::Control::GetForeColor ( ) const
virtual

Ruft die Fordergrundfarbe des Steuerelements ab.

Rückgabe
color
int OSHGui::Control::GetHeight ( ) const
virtual

Ruft die Höhe des Steuerelements ab.

Rückgabe
height
bool OSHGui::Control::GetIsFocused ( ) const
virtual

Ruft ab, ob das Steuerelement den Fokus besitzt.

Rückgabe
isFocused

Erneute Implementation in OSHGui::ComboBox.

KeyDownEvent & OSHGui::Control::GetKeyDownEvent ( )

Ruft das KeyDownEvent für das Steuerelement ab.

Rückgabe
keyPressEvent
KeyPressEvent & OSHGui::Control::GetKeyPressEvent ( )

Ruft das KeyPressEvent für das Steuerelement ab.

Rückgabe
keyPressEvent
KeyUpEvent & OSHGui::Control::GetKeyUpEvent ( )

Ruft das KeyUpEvent für das Steuerelement ab.

Rückgabe
keyPressEvent
int OSHGui::Control::GetLeft ( ) const
virtual

Ruft den Abstand zwischen dem linken Rand des Steuerelements und dem linken Rand des Clientbereichs des zugehörigen Containers ab.

Rückgabe
left
const Drawing::Point & OSHGui::Control::GetLocation ( ) const
virtual

Ruft die Koordinaten der linken oberen Ecke des Steuerelements relativ zur linken oberen Ecke des Containers ab.

Rückgabe
location
LocationChangedEvent & OSHGui::Control::GetLocationChangedEvent ( )

Ruft das LocationChangedEvent für das Steuerelement ab.

Rückgabe
locationChangedEvent
MouseCaptureChangedEvent& OSHGui::Control::GetMouseCaptureChangedEvent ( )

Ruft das MouseCaptureChangedEvent für das Steuerelement ab.

Rückgabe
mouseCaptureChangedEvent
MouseClickEvent & OSHGui::Control::GetMouseClickEvent ( )

Ruft das MouseClickEvent für das Steuerelement ab.

Rückgabe
mouseClickEvent
MouseDownEvent & OSHGui::Control::GetMouseDownEvent ( )

Ruft das MouseDownEvent für das Steuerelement ab.

Rückgabe
mouseDownEvent
MouseEnterEvent & OSHGui::Control::GetMouseEnterEvent ( )

Ruft das MouseEnterEvent für das Steuerelement ab.

Rückgabe
mouseEnterEvent
MouseLeaveEvent & OSHGui::Control::GetMouseLeaveEvent ( )

Ruft das MouseLeaveEvent für das Steuerelement ab.

Rückgabe
mouseLeaveEvent
MouseMoveEvent & OSHGui::Control::GetMouseMoveEvent ( )

Ruft das MouseMoveEvent für das Steuerelement ab.

Rückgabe
mouseMoveEvent
Drawing::Color OSHGui::Control::GetMouseOverFocusColor ( ) const
virtual

Ruft die Farbe für das fokusierte Steuerelement ab.

Rückgabe
color
MouseScrollEvent & OSHGui::Control::GetMouseScrollEvent ( )

Ruft das MouseScrollEvent für das Steuerelement ab.

Rückgabe
mouseScrollEvent
MouseUpEvent & OSHGui::Control::GetMouseUpEvent ( )

Ruft das MouseUpEvent für das Steuerelement ab.

Rückgabe
mouseUpEvent
const Misc::AnsiString & OSHGui::Control::GetName ( ) const
virtual

Ruft den zum Identifizieren des Steuerelements verwendeten Namen ab.

Rückgabe
name
Control * OSHGui::Control::GetParent ( ) const
virtual

Ruft das übergeordnete Steuerelement ab.

Rückgabe
parent
int OSHGui::Control::GetRight ( ) const
virtual

Ruft den Abstand zwischen dem rechten Rand des Steuerelements und dem linken Rand des Clientbereichs des zugehörigen Containers ab.

Rückgabe
right
const Drawing::Size & OSHGui::Control::GetSize ( ) const
virtual

Ruft die Höhe und Breite des Steuerelements ab.

Rückgabe
size
SizeChangedEvent & OSHGui::Control::GetSizeChangedEvent ( )

Ruft das SizeChangedEvent für das Steuerelement ab.

Rückgabe
sizeChangedEvent
const Misc::Any & OSHGui::Control::GetTag ( ) const
virtual

Ruft die mit dem Steuerelement verknüpften benutzerdefinierten Daten ab.

Rückgabe
tag
int OSHGui::Control::GetTop ( ) const
virtual

Ruft den Abstand zwischen dem oberen Rand des Steuerelements und dem oberen Rand des Clientbereichs des zugehörigen Containers ab.

Rückgabe
top
CONTROL_TYPE OSHGui::Control::GetType ( ) const
virtual

Ruft den CONTROL_TYPE des Steuerelemts ab.

Rückgabe
der Typ
bool OSHGui::Control::GetVisible ( ) const
virtual

Ruft ab, ob das Steuerelement und alle untergeordneten Steuerelemente angezeigt werden.

Rückgabe
isVisible
int OSHGui::Control::GetWidth ( ) const
virtual

Ruft die Breite des Steuerelements ab.

Rückgabe
width
virtual bool OSHGui::Control::Intersect ( const Drawing::Point point) const
pure virtual
const Drawing::Point OSHGui::Control::PointToClient ( const Drawing::Point point) const
virtual

Rechnet die Position des angegeben Bildschirmpunkts in Clientkoordinaten um.

Parameter
point
Rückgabe
Clientkoordinaten
const Drawing::Point OSHGui::Control::PointToScreen ( const Drawing::Point point) const
virtual

Rechnet die Position des angegeben Clientpunkts in Bildschirmkoordinaten um.

Parameter
point
Rückgabe
Bildschirmkoordinaten
bool OSHGui::Control::ProcessKeyboardMessage ( KeyboardMessage keyboard)

Verarbeitet eine Tastatur-Nachricht. Sollte nicht vom Benutzer aufgerufen werden.

Parameter
keyboard
Rückgabe
true, falls die Nachricht verarbeitet wurde
bool OSHGui::Control::ProcessMouseMessage ( const MouseMessage mouse)

Verarbeitet eine Maus-Nachricht. Sollte nicht vom Benutzer aufgerufen werden.

Parameter
mouse
Rückgabe
true, falls die Nachricht verarbeitet wurde
void OSHGui::Control::Render ( Drawing::IRenderer renderer)
virtual
void OSHGui::Control::SetAnchor ( AnchorStyle  anchor)
virtual

Legt die Ränder des Containers ab, an die ein Steuerelement gebunden ist, und bestimmt, wie die Größe des Steuerelements mit dessen übergeordnetem Element geändert wird.

Parameter
anchor
void OSHGui::Control::SetAutoSize ( bool  autoSize)
virtual

Legt fest, ob sich die Größe des Steuerelements automatisch an dessen Inhalt anpasst.

Parameter
autoSize

Erneute Implementation in OSHGui::Button.

void OSHGui::Control::SetBackColor ( Drawing::Color  color)
virtual

Legt die Hintergrundfarbe des Steuerelements fest.

Parameter
color

Erneute Implementation in OSHGui::ComboBox und OSHGui::TabControl.

void OSHGui::Control::SetBounds ( const Drawing::Rectangle bounds)
virtual

Legt die Größe und Position des Steuerelements relativ zum übergeordneten Steuerelement fest.

Parameter
bounds
void OSHGui::Control::SetBounds ( const Drawing::Point location,
const Drawing::Size size 
)
virtual

Legt die Größe und Position des Steuerelements relativ zum übergeordneten Steuerelement fest.

Parameter
location
size
void OSHGui::Control::SetBounds ( int  x,
int  y,
int  w,
int  h 
)
virtual

Legt die Größe und Position des Steuerelements relativ zum übergeordneten Steuerelement fest.

Parameter
x
y
w
h
void OSHGui::Control::SetCursor ( const std::shared_ptr< Cursor > &  cursor)

Legt den angezeigten Cursor fest, wenn sich die Maus über dem Steuerelement befindet.

Parameter
cursor
void OSHGui::Control::SetEnabled ( bool  isEnabled)
virtual

Legt fest, ob das Steuerlement auf Benutzerinteraktionen reagieren kann.

Parameter
isEnabled

Erneute Implementation in OSHGui::Timer.

void OSHGui::Control::SetFont ( const std::shared_ptr< Drawing::IFont > &  font)
virtual

Legt die Schriftart des Texts im Steuerelement fest.

Parameter
font

Erneute Implementation in OSHGui::Button, OSHGui::CheckBox, OSHGui::GroupBox, OSHGui::ComboBox, OSHGui::Label, OSHGui::TextBox und OSHGui::ListBox.

void OSHGui::Control::SetForeColor ( Drawing::Color  color)
virtual

Legt die Fordergrundfarbe des Steuerelements fest.

Parameter
color

Erneute Implementation in OSHGui::Form, OSHGui::Button, OSHGui::CheckBox, OSHGui::GroupBox, OSHGui::ComboBox, OSHGui::TabControl und OSHGui::ScrollBar.

void OSHGui::Control::SetLocation ( int  x,
int  y 
)
virtual

Legt die Koordinaten der linken oberen Ecke des Steuerelements relativ zur linken oberen Ecke des Containers fest.

Parameter
x
y
void OSHGui::Control::SetLocation ( const Drawing::Point location)
virtual

Legt die Koordinaten der linken oberen Ecke des Steuerelements relativ zur linken oberen Ecke des Containers fest.

Parameter
location
void OSHGui::Control::SetMouseOverFocusColor ( Drawing::Color  color)
virtual

Legt die Farbe für das fokusierte Steuerelement fest.

Parameter
color
void OSHGui::Control::SetName ( const Misc::AnsiString &  name)
virtual

Legt den zum Identifizieren des Steuerelements verwendeten Namen fest.

Parameter
name
void OSHGui::Control::SetParent ( Control parent)
virtual

Legt das übergeordnete Steuerelement fest.

Parameter
parent

Erneute Implementation in OSHGui::TabPage.

void OSHGui::Control::SetSize ( int  width,
int  height 
)
virtual

Legt die Höhe und Breite des Steuerelements fest.

Parameter
width
height
void OSHGui::Control::SetSize ( const Drawing::Size size)
virtual
void OSHGui::Control::SetTag ( Misc::Any tag)
virtual

Legt die mit dem Steuerelement verknüpften benutzerdefinierten Daten fest.

Parameter
tag
void OSHGui::Control::SetVisible ( bool  isVisible)
virtual

Legt fest, ob das Steuerelement und alle untergeordneten Steuerelemente angezeigt werden.

Parameter
isVisible