AOO410/main/svtools/inc/svtools/ctrltool.hxx - openoffice - Git at Google

 /**************************************************************
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  *
  *************************************************************/


 #ifndef _CTRLTOOL_HXX
 #define _CTRLTOOL_HXX

 #include "svtools/svtdllapi.h"

 #ifndef _SAL_TYPES_H
 #include <sal/types.h>
 #endif
 #include <tools/list.hxx>
 #ifndef _METRIC_HXX
 #include <vcl/metric.hxx>
 #endif

 class ImplFontListNameInfo;
 class OutputDevice;

 /*************************************************************************

 Beschreibung
 ============

 class FontList

 Diese Klasse verwaltet alle Fonts, die auf einem oder zwei Ausgabegeraeten
 dargestellt werden koennen. Zusaetzlich bietet die Klasse Methoden an, um
 aus Fett und Kursiv den StyleName zu generieren oder aus einem Stylename
 die fehlenden Attribute. Zusaetzlich kann diese Klasse syntetisch nachgebildete
 Fonts verarbeiten. Diese Klasse kann mit verschiedenen Standard-Controls und
 Standard-Menus zusammenarbeiten.

 Querverweise

 class FontNameBox, class FontStyleBox, class FontSizeBox,
 class FontNameMenu, class FontStyleMenu, class FontSizeMenu

 --------------------------------------------------------------------------

 FontList::FontList( OutputDevice* pDevice, OutputDevice* pDevice2 = NULL,
 					sal_Bool bAll = sal_True );

 Konstruktor der Klasse FontList. Vom uebergebenen OutputDevice werden die
 entsprechenden Fonts abgefragt. Das OutputDevice muss solange existieren,
 wie auch die Klasse FontList existiert. Optional kann noch ein 2tes
 Ausgabedevice uebergeben werden, damit man zum Beispiel die Fonts von
 einem Drucker und dem Bildschirm zusammen in einer FontListe verwalten kann
 und somit auch den FontListen und FontMenus die Fonts von beiden OutputDevices
 zu uebergeben. Auch das pDevice2 muss solange existieren, wie die Klasse
 FontList existiert.

 Das OutputDevice, welches als erstes uebergeben wird, sollte das bevorzugte
 sein. Dies sollte im normalfall der Drucker sein. Denn wenn 2 verschiede
 Device-Schriften (eine fuer Drucker und eine fuer den Bildschirm) vorhanden
 sind, wird die vom uebergebenen Device "pDevice" bevorzugt.

 Mit dem dritten Parameter kann man angeben, ob nur skalierbare Schriften
 abgefragt werden sollen oder alle. Wenn sal_True uebergeben wird, werden auch
 Bitmap-Schriften mit abgefragt. Bei sal_False werden Vector-Schriften und
 scalierbare Schriften abgefragt.

 --------------------------------------------------------------------------

 String FontList::GetStyleName( const FontInfo& rInfo ) const;

 Diese Methode gibt den StyleName von einer FontInfo zurueck. Falls kein
 StyleName gesetzt ist, wird aus den gesetzten Attributen ein entsprechender
 Name generiert, der dem Anwender praesentiert werden kann.

 --------------------------------------------------------------------------

 XubString FontList::GetFontMapText( const FontInfo& rInfo ) const;

 Diese Methode gibt einen Matchstring zurueck, der dem Anwender
 anzeigen soll, welche Probleme es mit diesem Font geben kann.

 --------------------------------------------------------------------------

 FontInfo FontList::Get( const String& rName, const String& rStyleName ) const;

 Diese Methode sucht aus dem uebergebenen Namen und dem uebergebenen StyleName
 die entsprechende FontInfo-Struktur raus. Der Stylename kann in dieser
 Methode auch ein syntetischer sein. In diesem Fall werden die entsprechenden
 Werte in der FontInfo-Struktur entsprechend gesetzt. Wenn ein StyleName
 uebergeben wird, kann jedoch eine FontInfo-Struktur ohne Stylename
 zurueckgegeben werden. Um den StyleName dem Anwender zu repraesentieren,
 muss GetStyleName() mit dieser FontInfo-Struktur aufgerufen werden.

 Querverweise

 FontList::GetStyleName()

 --------------------------------------------------------------------------

 FontInfo FontList::Get( const String& rName, FontWeight eWeight,
 						FontItalic eItalic ) const;

 Diese Methode sucht aus dem uebergebenen Namen und den uebergebenen Styles
 die entsprechende FontInfo-Struktur raus. Diese Methode kann auch eine
 FontInfo-Struktur ohne Stylename zurueckgegeben. Um den StyleName dem
 Anwender zu repraesentieren, muss GetStyleName() mit dieser FontInfo-Struktur
 aufgerufen werden.

 Querverweise

 FontList::GetStyleName()

 --------------------------------------------------------------------------

 const long* FontList::GetSizeAry( const FontInfo& rInfo ) const;

 Diese Methode liefert zum uebergebenen Font die vorhandenen Groessen.
 Falls es sich dabei um einen skalierbaren Font handelt, werden Standard-
 Groessen zurueckgegeben. Das Array enthaelt die Hoehen des Fonts in 10tel
 Point. Der letzte Wert des Array ist 0. Das Array, was zurueckgegeben wird,
 wird von der FontList wieder zerstoert. Nach dem Aufruf der naechsten Methode
 von der FontList, sollte deshalb das Array nicht mehr referenziert werden.

 *************************************************************************/

 // ------------
 // - FontList -
 // ------------

 #define FONTLIST_FONTINFO_NOTFOUND	((sal_uInt16)0xFFFF)

 #define FONTLIST_FONTNAMETYPE_PRINTER			((sal_uInt16)0x0001)
 #define FONTLIST_FONTNAMETYPE_SCREEN			((sal_uInt16)0x0002)
 #define FONTLIST_FONTNAMETYPE_SCALABLE			((sal_uInt16)0x0004)

 class SVT_DLLPUBLIC FontList : private List
 {
 private:
 	XubString				maMapBoth;
 	XubString				maMapPrinterOnly;
 	XubString				maMapScreenOnly;
 	XubString				maMapSizeNotAvailable;
 	XubString				maMapStyleNotAvailable;
 	XubString				maMapNotAvailable;
 	XubString				maLight;
 	XubString				maLightItalic;
 	XubString				maNormal;
 	XubString				maNormalItalic;
 	XubString				maBold;
 	XubString				maBoldItalic;
 	XubString				maBlack;
 	XubString				maBlackItalic;
 	long*					mpSizeAry;
 	OutputDevice*			mpDev;
 	OutputDevice*			mpDev2;

 #ifdef CTRLTOOL_CXX
 	SVT_DLLPRIVATE ImplFontListNameInfo*	ImplFind( const XubString& rSearchName, sal_uLong* pIndex ) const;
 	SVT_DLLPRIVATE ImplFontListNameInfo*	ImplFindByName( const XubString& rStr ) const;
 	SVT_DLLPRIVATE void					ImplInsertFonts( OutputDevice* pDev, sal_Bool bAll,
 											 sal_Bool bInsertData );
 #endif

 public:
 							FontList( OutputDevice* pDevice,
 									  OutputDevice* pDevice2 = NULL,
 									  sal_Bool bAll = sal_True );
 							~FontList();

     FontList*               Clone() const;

     OutputDevice*           GetDevice() const { return mpDev; }
 	OutputDevice*			GetDevice2() const { return mpDev2; }
 	XubString				GetFontMapText( const FontInfo& rInfo ) const;
 	sal_uInt16					GetFontNameType( const XubString& rFontName ) const;

 	const XubString&		GetNormalStr() const { return maNormal; }
 	const XubString&		GetItalicStr() const { return maNormalItalic; }
 	const XubString&		GetBoldStr() const { return maBold; }
 	const XubString&		GetBoldItalicStr() const { return maBoldItalic; }
 	const XubString&		GetStyleName( FontWeight eWeight, FontItalic eItalic ) const;
 	XubString				GetStyleName( const FontInfo& rInfo ) const;

 	FontInfo				Get( const XubString& rName,
 								 const XubString& rStyleName ) const;
 	FontInfo				Get( const XubString& rName,
 								 FontWeight eWeight,
 								 FontItalic eItalic ) const;

 	sal_Bool					IsAvailable( const XubString& rName ) const;
 	sal_uInt16					GetFontNameCount() const
 								{ return (sal_uInt16)List::Count(); }
 	const FontInfo& 		GetFontName( sal_uInt16 nFont ) const;
 	sal_uInt16					GetFontNameType( sal_uInt16 nFont ) const;
 	sal_Handle				GetFirstFontInfo( const XubString& rName ) const;
 	sal_Handle				GetNextFontInfo( sal_Handle hFontInfo ) const;
 	const FontInfo& 		GetFontInfo( sal_Handle hFontInfo ) const;

 	const long* 			GetSizeAry( const FontInfo& rInfo ) const;
 	static const long*		GetStdSizeAry();

 private:
 							FontList( const FontList& );
 	FontList&				operator =( const FontList& );
 };


 // -----------------
 // - FontSizeNames -
 // -----------------

 class SVT_DLLPUBLIC FontSizeNames
 {
 private:
 	struct ImplFSNameItem*	mpArray;
 	sal_uLong					mnElem;

 public:
 							FontSizeNames( LanguageType eLanguage /* = LANGUAGE_DONTKNOW */ );

 	sal_uLong					Count() const { return mnElem; }
 	sal_Bool					IsEmpty() const { return !mnElem; }

 	long					Name2Size( const String& ) const;
 	String					Size2Name( long ) const;

 	String					GetIndexName( sal_uLong nIndex ) const;
 	long					GetIndexSize( sal_uLong nIndex ) const;
 };

 #endif	// _CTRLTOOL_HXX
	/**************************************************************
	*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*
	*************************************************************/



	#ifndef _CTRLTOOL_HXX
	#define _CTRLTOOL_HXX

	#include "svtools/svtdllapi.h"

	#ifndef _SAL_TYPES_H
	#include <sal/types.h>
	#endif
	#include <tools/list.hxx>
	#ifndef _METRIC_HXX
	#include <vcl/metric.hxx>
	#endif

	class ImplFontListNameInfo;
	class OutputDevice;

	/*************************************************************************

	Beschreibung
	============

	class FontList

	Diese Klasse verwaltet alle Fonts, die auf einem oder zwei Ausgabegeraeten
	dargestellt werden koennen. Zusaetzlich bietet die Klasse Methoden an, um
	aus Fett und Kursiv den StyleName zu generieren oder aus einem Stylename
	die fehlenden Attribute. Zusaetzlich kann diese Klasse syntetisch nachgebildete
	Fonts verarbeiten. Diese Klasse kann mit verschiedenen Standard-Controls und
	Standard-Menus zusammenarbeiten.

	Querverweise

	class FontNameBox, class FontStyleBox, class FontSizeBox,
	class FontNameMenu, class FontStyleMenu, class FontSizeMenu

	--------------------------------------------------------------------------

	FontList::FontList( OutputDevice* pDevice, OutputDevice* pDevice2 = NULL,
	sal_Bool bAll = sal_True );

	Konstruktor der Klasse FontList. Vom uebergebenen OutputDevice werden die
	entsprechenden Fonts abgefragt. Das OutputDevice muss solange existieren,
	wie auch die Klasse FontList existiert. Optional kann noch ein 2tes
	Ausgabedevice uebergeben werden, damit man zum Beispiel die Fonts von
	einem Drucker und dem Bildschirm zusammen in einer FontListe verwalten kann
	und somit auch den FontListen und FontMenus die Fonts von beiden OutputDevices
	zu uebergeben. Auch das pDevice2 muss solange existieren, wie die Klasse
	FontList existiert.

	Das OutputDevice, welches als erstes uebergeben wird, sollte das bevorzugte
	sein. Dies sollte im normalfall der Drucker sein. Denn wenn 2 verschiede
	Device-Schriften (eine fuer Drucker und eine fuer den Bildschirm) vorhanden
	sind, wird die vom uebergebenen Device "pDevice" bevorzugt.

	Mit dem dritten Parameter kann man angeben, ob nur skalierbare Schriften
	abgefragt werden sollen oder alle. Wenn sal_True uebergeben wird, werden auch
	Bitmap-Schriften mit abgefragt. Bei sal_False werden Vector-Schriften und
	scalierbare Schriften abgefragt.

	--------------------------------------------------------------------------

	String FontList::GetStyleName( const FontInfo& rInfo ) const;

	Diese Methode gibt den StyleName von einer FontInfo zurueck. Falls kein
	StyleName gesetzt ist, wird aus den gesetzten Attributen ein entsprechender
	Name generiert, der dem Anwender praesentiert werden kann.

	--------------------------------------------------------------------------

	XubString FontList::GetFontMapText( const FontInfo& rInfo ) const;

	Diese Methode gibt einen Matchstring zurueck, der dem Anwender
	anzeigen soll, welche Probleme es mit diesem Font geben kann.

	--------------------------------------------------------------------------

	FontInfo FontList::Get( const String& rName, const String& rStyleName ) const;

	Diese Methode sucht aus dem uebergebenen Namen und dem uebergebenen StyleName
	die entsprechende FontInfo-Struktur raus. Der Stylename kann in dieser
	Methode auch ein syntetischer sein. In diesem Fall werden die entsprechenden
	Werte in der FontInfo-Struktur entsprechend gesetzt. Wenn ein StyleName
	uebergeben wird, kann jedoch eine FontInfo-Struktur ohne Stylename
	zurueckgegeben werden. Um den StyleName dem Anwender zu repraesentieren,
	muss GetStyleName() mit dieser FontInfo-Struktur aufgerufen werden.

	Querverweise

	FontList::GetStyleName()

	--------------------------------------------------------------------------

	FontInfo FontList::Get( const String& rName, FontWeight eWeight,
	FontItalic eItalic ) const;

	Diese Methode sucht aus dem uebergebenen Namen und den uebergebenen Styles
	die entsprechende FontInfo-Struktur raus. Diese Methode kann auch eine
	FontInfo-Struktur ohne Stylename zurueckgegeben. Um den StyleName dem
	Anwender zu repraesentieren, muss GetStyleName() mit dieser FontInfo-Struktur
	aufgerufen werden.

	Querverweise

	FontList::GetStyleName()

	--------------------------------------------------------------------------

	const long* FontList::GetSizeAry( const FontInfo& rInfo ) const;

	Diese Methode liefert zum uebergebenen Font die vorhandenen Groessen.
	Falls es sich dabei um einen skalierbaren Font handelt, werden Standard-
	Groessen zurueckgegeben. Das Array enthaelt die Hoehen des Fonts in 10tel
	Point. Der letzte Wert des Array ist 0. Das Array, was zurueckgegeben wird,
	wird von der FontList wieder zerstoert. Nach dem Aufruf der naechsten Methode
	von der FontList, sollte deshalb das Array nicht mehr referenziert werden.

	*************************************************************************/

	// ------------
	// - FontList -
	// ------------

	#define FONTLIST_FONTINFO_NOTFOUND ((sal_uInt16)0xFFFF)

	#define FONTLIST_FONTNAMETYPE_PRINTER ((sal_uInt16)0x0001)
	#define FONTLIST_FONTNAMETYPE_SCREEN ((sal_uInt16)0x0002)
	#define FONTLIST_FONTNAMETYPE_SCALABLE ((sal_uInt16)0x0004)

	class SVT_DLLPUBLIC FontList : private List
	{
	private:
	XubString maMapBoth;
	XubString maMapPrinterOnly;
	XubString maMapScreenOnly;
	XubString maMapSizeNotAvailable;
	XubString maMapStyleNotAvailable;
	XubString maMapNotAvailable;
	XubString maLight;
	XubString maLightItalic;
	XubString maNormal;
	XubString maNormalItalic;
	XubString maBold;
	XubString maBoldItalic;
	XubString maBlack;
	XubString maBlackItalic;
	long* mpSizeAry;
	OutputDevice* mpDev;
	OutputDevice* mpDev2;

	#ifdef CTRLTOOL_CXX
	SVT_DLLPRIVATE ImplFontListNameInfo* ImplFind( const XubString& rSearchName, sal_uLong* pIndex ) const;
	SVT_DLLPRIVATE ImplFontListNameInfo* ImplFindByName( const XubString& rStr ) const;
	SVT_DLLPRIVATE void ImplInsertFonts( OutputDevice* pDev, sal_Bool bAll,
	sal_Bool bInsertData );
	#endif

	public:
	FontList( OutputDevice* pDevice,
	OutputDevice* pDevice2 = NULL,
	sal_Bool bAll = sal_True );
	~FontList();

	FontList* Clone() const;

	OutputDevice* GetDevice() const { return mpDev; }
	OutputDevice* GetDevice2() const { return mpDev2; }
	XubString GetFontMapText( const FontInfo& rInfo ) const;
	sal_uInt16 GetFontNameType( const XubString& rFontName ) const;

	const XubString& GetNormalStr() const { return maNormal; }
	const XubString& GetItalicStr() const { return maNormalItalic; }
	const XubString& GetBoldStr() const { return maBold; }
	const XubString& GetBoldItalicStr() const { return maBoldItalic; }
	const XubString& GetStyleName( FontWeight eWeight, FontItalic eItalic ) const;
	XubString GetStyleName( const FontInfo& rInfo ) const;

	FontInfo Get( const XubString& rName,
	const XubString& rStyleName ) const;
	FontInfo Get( const XubString& rName,
	FontWeight eWeight,
	FontItalic eItalic ) const;

	sal_Bool IsAvailable( const XubString& rName ) const;
	sal_uInt16 GetFontNameCount() const
	{ return (sal_uInt16)List::Count(); }
	const FontInfo& GetFontName( sal_uInt16 nFont ) const;
	sal_uInt16 GetFontNameType( sal_uInt16 nFont ) const;
	sal_Handle GetFirstFontInfo( const XubString& rName ) const;
	sal_Handle GetNextFontInfo( sal_Handle hFontInfo ) const;
	const FontInfo& GetFontInfo( sal_Handle hFontInfo ) const;

	const long* GetSizeAry( const FontInfo& rInfo ) const;
	static const long* GetStdSizeAry();

	private:
	FontList( const FontList& );
	FontList& operator =( const FontList& );
	};


	// -----------------
	// - FontSizeNames -
	// -----------------

	class SVT_DLLPUBLIC FontSizeNames
	{
	private:
	struct ImplFSNameItem* mpArray;
	sal_uLong mnElem;

	public:
	FontSizeNames( LanguageType eLanguage /* = LANGUAGE_DONTKNOW */ );

	sal_uLong Count() const { return mnElem; }
	sal_Bool IsEmpty() const { return !mnElem; }

	long Name2Size( const String& ) const;
	String Size2Name( long ) const;

	String GetIndexName( sal_uLong nIndex ) const;
	long GetIndexSize( sal_uLong nIndex ) const;
	};

	#endif // _CTRLTOOL_HXX