HyperLinkCustomGui Class Reference

#include <customgui_hyperlink.h>

Inheritance diagram for HyperLinkCustomGui:

Detailed Description

Hyper link custom GUI (CUSTOMGUI_HYPER_LINK_STATIC) for use with HyperLinkData.
Here are the settings: HYPERLINK_CUSTOMGUISETTINGS

Public Member Functions

Bool SetLinkString (const maxon::String *pStrLink, const maxon::String *pStrText)
 
Bool GetLinkString (maxon::String *pStrLink, maxon::String *pStrText)
 
Bool SetLinkStringThreaded (const maxon::String *pStrLink, const maxon::String *pStrText)
 
- Public Member Functions inherited from BaseCustomGui< 1009180 >
Int32 GetWidth ()
 
Int32 GetHeight ()
 
void Redraw ()
 
Bool LayoutChanged ()
 
Bool Activate ()
 
Bool SetDefaultForResEdit ()
 
Bool SetData (const TriState< GeData > &tristate)
 
TriState< GeDataGetData ()
 
void SetLayoutMode (Int32 mode)
 
Int32 GetLayoutMode ()
 
Bool SupportLayoutSwitch ()
 
- Public Member Functions inherited from _BaseCustomGui
Int32 GetWidth (Int32 plugid)
 
Int32 GetHeight (Int32 plugid)
 
void Redraw (Int32 plugid)
 
Bool LayoutChanged (Int32 plugid)
 
Bool Activate (Int32 plugid)
 
Bool SetDefaultForResEdit (Int32 plugid)
 
Bool SetData (Int32 plugid, const TriState< GeData > &tristate)
 
TriState< GeDataGetData (Int32 plugid)
 
void SetLayoutMode (Int32 plugid, Int32 mode)
 
Int32 GetLayoutMode (Int32 plugid)
 
Bool SupportLayoutSwitch (Int32 plugid)
 

Private Member Functions

 HyperLinkCustomGui ()
 
 ~HyperLinkCustomGui ()
 

Additional Inherited Members

- Static Public Attributes inherited from BaseCustomGui< 1009180 >
static constexpr Int32 VALUE
 

Constructor & Destructor Documentation

◆ HyperLinkCustomGui()

HyperLinkCustomGui ( )
private

◆ ~HyperLinkCustomGui()

~HyperLinkCustomGui ( )
private

Member Function Documentation

◆ SetLinkString()

Bool SetLinkString ( const maxon::String pStrLink,
const maxon::String pStrText 
)

Sets the strings.

Parameters
[in]pStrLinkThe new link string or nullptr.
[in]pStrTextThe new text string or nullptr.
Returns
true if successful, otherwise false.

◆ GetLinkString()

Bool GetLinkString ( maxon::String pStrLink,
maxon::String pStrText 
)

Gets the strings.

Parameters
[out]pStrLinkAssigned the text string if not nullptr.
[out]pStrTextAssigned the link string if not nullptr.
Returns
true if successful, otherwise false.

◆ SetLinkStringThreaded()

Bool SetLinkStringThreaded ( const maxon::String pStrLink,
const maxon::String pStrText 
)

@markPrivate Sets the strings but only redraw, no layout change.

Parameters
[out]pStrLinkAssigned the text string if not nullptr.
[out]pStrTextAssigned the link string if not nullptr.
Returns
true if successful, otherwise false.