Difference between revisions of "Text Style Tips"

From FM Plugin Wikipedia
Jump to: navigation, search
(→‎Example CharacterStyle Functions)
 
(7 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
This page is about editing and working with Text Styles passed from FileMaker to your plugin.
 
This page is about editing and working with Text Styles passed from FileMaker to your plugin.
  
−
 
+
=CharacterStyle::Color Public Functions=
−
=Text Style Public Functions=
 
 
*[[void SetRed ( ColorChannel r )]]
 
*[[void SetRed ( ColorChannel r )]]
 
*[[void SetGreen ( ColorChannel g )]]
 
*[[void SetGreen ( ColorChannel g )]]
 
*[[void SetBlue ( ColorChannel b )]]
 
*[[void SetBlue ( ColorChannel b )]]
 
*[[void SetAlpha ( ColorChannel a )]]
 
*[[void SetAlpha ( ColorChannel a )]]
−
 
  
 
*[[ColorChannel GetRed () const]]
 
*[[ColorChannel GetRed () const]]
Line 17: Line 15:
 
*[[ColorChannel GetBlue () const]]
 
*[[ColorChannel GetBlue () const]]
 
*[[ColorChannel GetAlpha () const]]
 
*[[ColorChannel GetAlpha () const]]
−
 
  
 
*[[ColorChannel16 GetRedUpsample () const]]
 
*[[ColorChannel16 GetRedUpsample () const]]
Line 23: Line 20:
 
*[[ColorChannel16 GetBlueUpsample () const]]
 
*[[ColorChannel16 GetBlueUpsample () const]]
 
*[[ColorChannel16 GetAlphaUpsample () const]]
 
*[[ColorChannel16 GetAlphaUpsample () const]]
−
 
  
 
*[[Color &operator = ( const Color &rhs )]]
 
*[[Color &operator = ( const Color &rhs )]]
 
*[[bool operator == ( const Color &rhs ) const]]
 
*[[bool operator == ( const Color &rhs ) const]]
 
*[[bool operator != ( const Color &rhs ) const]]
 
*[[bool operator != ( const Color &rhs ) const]]
−
 
  
 
*[[static const Color &White () throw ()]]
 
*[[static const Color &White () throw ()]]
 
*[[static const Color &Black () throw ()]]
 
*[[static const Color &Black () throw ()]]
  
 +
*[[void operator delete ( void *obj )]]
 +
 +
= CharacterStyle Public Functions=
 +
*void EnableFont ();
 +
*void EnableFace ( Face face );
 +
*void EnableSize ();
 +
*void EnableColor ();
 +
*void DisableFont ();
 +
*void DisableFace ( Face face );
 +
*void DisableAllFaces ();
 +
*void DisableSize ();
 +
*void DisableColor ();
 +
*void DisableAll ();
 +
*bool IsAllDisabled () const;
 +
*bool IsFontEnabled () const;
 +
*bool IsFaceEnabled ( Face face ) const;
 +
*bool IsAnyFaceEnabled () const;
 +
*bool IsSizeEnabled () const;
 +
*bool IsColorEnabled () const;
 +
*void SetFontInformation ( FontID font, Face face, FontSize size );
 +
*void GetFontInformation ( FontID &font, Face &face, FontSize &size );
 +
*void SetFont ( FontID font );
 +
*void SetFace ( Face face );
 +
*void SetSize ( FontSize size );
 +
*FontID GetFont () const;
 +
*Face GetFace () const;
 +
*FontSize GetSize () const;
 +
*void SetColor ( const Color &color );
 +
*const Color &GetColor () const;
 +
*CharacterStyle &operator = ( const CharacterStyle &rhs );
 +
*bool operator == ( const CharacterStyle &rhs ) const;
 +
*bool operator != ( const CharacterStyle &rhs ) const;
 +
*void operator delete ( void *obj );
 +
 +
=Example CharacterStyle Functions=
 +
 +
 +
This example shows how to change the style for a block of text.  In this case, we are changing the word 'text' to Bold, 12pt
  
−
*[[void operator delete ( void *obj )]]
+
fmx::TextAutoPrt myText;
 +
fmx::CharacterStyleAutoPtr myStyle;
 +
 +
 
 +
myStyle->SetFace( fmx::CharacterStyle::kFace_Bold );
 +
 +
myStyle->SetSize( 12 );
 +
 +
 +
myText->Assign("This is the text to change");
 +
 +
myText->SetStyle( *myStyle , 12, 4 );
 +
 
 +
 
 +
 
 +
output will be  "This is the <b>text</b> to change"

Latest revision as of 00:21, 6 June 2008

This page is about editing and working with Text Styles passed from FileMaker to your plugin.

CharacterStyle::Color Public Functions

CharacterStyle Public Functions

  • void EnableFont ();
  • void EnableFace ( Face face );
  • void EnableSize ();
  • void EnableColor ();
  • void DisableFont ();
  • void DisableFace ( Face face );
  • void DisableAllFaces ();
  • void DisableSize ();
  • void DisableColor ();
  • void DisableAll ();
  • bool IsAllDisabled () const;
  • bool IsFontEnabled () const;
  • bool IsFaceEnabled ( Face face ) const;
  • bool IsAnyFaceEnabled () const;
  • bool IsSizeEnabled () const;
  • bool IsColorEnabled () const;
  • void SetFontInformation ( FontID font, Face face, FontSize size );
  • void GetFontInformation ( FontID &font, Face &face, FontSize &size );
  • void SetFont ( FontID font );
  • void SetFace ( Face face );
  • void SetSize ( FontSize size );
  • FontID GetFont () const;
  • Face GetFace () const;
  • FontSize GetSize () const;
  • void SetColor ( const Color &color );
  • const Color &GetColor () const;
  • CharacterStyle &operator = ( const CharacterStyle &rhs );
  • bool operator == ( const CharacterStyle &rhs ) const;
  • bool operator != ( const CharacterStyle &rhs ) const;
  • void operator delete ( void *obj );

Example CharacterStyle Functions

This example shows how to change the style for a block of text. In this case, we are changing the word 'text' to Bold, 12pt 

fmx::TextAutoPrt myText;
fmx::CharacterStyleAutoPtr myStyle;

 
myStyle->SetFace( fmx::CharacterStyle::kFace_Bold );

myStyle->SetSize( 12 );


myText->Assign("This is the text to change");

myText->SetStyle( *myStyle , 12, 4 );


output will be "This is the text to change"

Retrieved from "https://fmplugins.idma.nz/index.php?title=Text_Style_Tips&oldid=238"