LgiDefs.h File Reference

Defines and types Copyright (C) 1999-2004, Matthew Allen. More...

#include "LgiInc.h"
#include "GAutoPtr.h"

Go to the source code of this file.

Classes

union  GPointer

Defines

#define LGI_OS_UNKNOWN   0
 Unknown OS.
#define LGI_OS_WIN9X   1
 Windows 95, 98[se] or ME. (95 isnt't really supported but mostly works anyway).
#define LGI_OS_WINNT   2
 Windows NT, 2k, XP or later. (Supported).
#define LGI_OS_BEOS   3
 BeOS r5. (Used to be supported).
#define LGI_OS_LINUX   4
 Linux. (Kernels v2.4 and up supported).
#define LGI_OS_ATHEOS   5
 Atheos. (Not supported).
#define LGI_OS_MAC_OS_9   6
 Mac OS-9. (Not supported).
#define LGI_OS_MAC_OS_X   7
 Mac OS-X. (Don't do it! Think of Be, Inc!).
#define LGI_OS_MAX   8
 One higher than the maximum OS define.
#define LC_BLACK   LgiColour(0)
 Black.
#define LC_DKGREY   LgiColour(1)
 Dark grey.
#define LC_MIDGREY   LgiColour(2)
 Medium grey.
#define LC_LTGREY   LgiColour(3)
 Light grey.
#define LC_WHITE   LgiColour(4)
 White.
#define LC_SHADOW   LgiColour(5)
 3d dark shadow
#define LC_LOW   LgiColour(6)
 3d light shadow
#define LC_MED   LgiColour(7)
 Flat colour for dialogs, windows and buttons.
#define LC_HIGH   LgiColour(8)
 3d dark hilight
#define LC_LIGHT   LgiColour(9)
 3d light hilight
#define LC_DIALOG   LgiColour(10)
 Dialog colour.
#define LC_WORKSPACE   LgiColour(11)
 Workspace area.
#define LC_TEXT   LgiColour(12)
 Default text colour.
#define LC_SELECTION   LgiColour(13)
 Selection colour.
#define LC_SEL_TEXT   LgiColour(14)
 Selected text colour.
#define LCUR_Normal   0
 Normal arrow.
#define LCUR_UpArrow   1
 Upwards arrow.
#define LCUR_Cross   2
 Crosshair.
#define LCUR_Wait   3
 Hourglass/watch.
#define LCUR_Ibeam   4
 Ibeam/text entry.
#define LCUR_SizeVer   5
 Vertical resize (|).
#define LCUR_SizeHor   6
 Horizontal resize (-).
#define LCUR_SizeBDiag   7
 Diagonal resize (/).
#define LCUR_SizeFDiag   8
 Diagonal resize (\).
#define LCUR_SizeAll   9
 All directions resize.
#define LCUR_Blank   10
 Blank/invisible cursor (don't use!).
#define LCUR_SplitV   11
 Vertical splitting.
#define LCUR_SplitH   12
 Horziontal splitting.
#define LCUR_PointingHand   13
 A pointing hand.
#define LCUR_Forbidden   14
 A slashed circle.
#define LCUR_DropCopy   15
 Copy Drop.
#define LCUR_DropMove   16
 Copy Move.
#define LGI_MET_DECOR_X   1
#define LGI_MET_DECOR_Y   2
#define LGI_MET_DECOR_CAPTION   3
#define LGI_MET_MENU   4

Typedefs

typedef char int8
 8-bit signed int type (size safe, garenteed to be 8 bits)
typedef unsigned char uint8
 8-bit unsigned int type (size safe, garenteed to be 8 bits)
typedef short int16
 16-bit signed int type (size safe, garenteed to be 16 bits)
typedef unsigned short uint16
 16-bit unsigned int type (size safe, garenteed to be 16 bits)
typedef int int32
 32-bit signed int type (size safe, garenteed to be 32 bits)
typedef unsigned int uint32
 32-bit unsigned int type (size safe, garenteed to be 32 bits)
typedef signed long long int64
 64-bit signed int type (size safe, garenteed to be 64 bits)
typedef unsigned long long uint64
 64-bit unsigned int type (size safe, garenteed to be 64 bits)
typedef unsigned short char16
 Wide unicode char.

Enumerations

enum  LgiSystemPath {
  LSP_OS, LSP_OS_LIB, LSP_TEMP, LSP_COMMON_APP_DATA,
  LSP_USER_APP_DATA, LSP_LOCAL_APP_DATA, LSP_DESKTOP, LSP_HOME,
  LSP_EXE, LSP_TRASH, LSP_APP_INSTALL, LSP_APP_ROOT,
  LSP_USER_DOCUMENTS, LSP_USER_MUSIC, LSP_USER_VIDEO
}
 Types of system paths available for querying. More...


Detailed Description

Defines and types Copyright (C) 1999-2004, Matthew Allen.

Author:
Matthew Allen
Date:
24/9/1999

Define Documentation

#define LGI_MET_DECOR_CAPTION   3

Get the standard window vertical border size including caption bar.

See also:
GApp::GetMetric()

Referenced by GApp::GetMetric().

#define LGI_MET_DECOR_X   1

Get the standard window horizontal border size

See also:
GApp::GetMetric()

Referenced by GAlert::GAlert(), GApp::GetMetric(), GFontSelect::GFontSelect(), and GInput::GInput().

#define LGI_MET_DECOR_Y   2

Get the standard window vertical border size including caption bar.

See also:
GApp::GetMetric()

Referenced by GAlert::GAlert(), GApp::GetMetric(), GFontSelect::GFontSelect(), GInput::GInput(), and LgiMsg().

#define LGI_MET_MENU   4

Get the height of a single line menu bar

See also:
GApp::GetMetric()

#define LGI_OS_ATHEOS   5

Atheos. (Not supported).

See also:
LgiGetOs

#define LGI_OS_BEOS   3

BeOS r5. (Used to be supported).

See also:
LgiGetOs

Referenced by LgiGetOs().

#define LGI_OS_LINUX   4

Linux. (Kernels v2.4 and up supported).

See also:
LgiGetOs

Referenced by GFontSystem::GetGlyph(), and LgiGetOs().

#define LGI_OS_MAC_OS_9   6

Mac OS-9. (Not supported).

See also:
LgiGetOs

#define LGI_OS_MAC_OS_X   7

Mac OS-X. (Don't do it! Think of Be, Inc!).

See also:
LgiGetOs

Referenced by LgiGetOs().

#define LGI_OS_UNKNOWN   0

Unknown OS.

See also:
LgiGetOs

Referenced by LgiGetOs().

#define LGI_OS_WIN9X   1

Windows 95, 98[se] or ME. (95 isnt't really supported but mostly works anyway).

See also:
LgiGetOs

Referenced by GFont::Create(), GFontSystem::GetGlyph(), GFontType::GetSystemFont(), LgiGetExeFile(), LgiGetOs(), LgiGetSystemPath(), LgiMsg(), and GProcess::Run().

#define LGI_OS_WINNT   2

Windows NT, 2k, XP or later. (Supported).

See also:
LgiGetOs

Referenced by GFontSystem::GetGlyph(), and LgiGetOs().


Typedef Documentation

typedef unsigned short char16

Wide unicode char.

This is 16 bits on Win32 and Mac, but 32 bits on unix platforms. There are a number of wide character string function available for manipulating wide char strings.

Firstly to convert to and from utf-8 there is:

Wide versions of standard library functions are available:


Enumeration Type Documentation

Types of system paths available for querying.

See also:
LgiGetSystemPath
Enumerator:
LSP_OS  The location of the operating system folder [Win32] = e.g. C: [Mac] = /System [Linux] /boot
LSP_OS_LIB  The system library folder [Win32] = e.g. C: [Mac] = /Library [Linux] = /usr/lib
LSP_TEMP  A folder for storing temporary files. These files are usually deleted automatically later by the system. [Win32] = ~ Settings [Mac] = ~/Library/Caches/TemporaryItems [Linux] = /tmp
LSP_COMMON_APP_DATA  System wide application data [Win32] = ~\.. Users Data [Mac] = /System/Library [Linux] = /usr
LSP_USER_APP_DATA  User specific application data [Win32] = ~ Data [Mac] = ~/Library [Linux] = /usr
LSP_LOCAL_APP_DATA  Machine + user specific application data (probably should not use) [Win32] = ~ Settings Data [Mac] = ~/Library [Linux] = /usr/local
LSP_DESKTOP  Desktop dir i.e. ~/Desktop
LSP_HOME  Home dir i.e. ~
LSP_EXE  The running application's path. [Mac] This doesn't include the "Contents/MacOS" part of the path inside the bundle.
LSP_TRASH  The system trash folder.
LSP_APP_INSTALL  The app's install folder. [Win32] = $ExePath (sans '' or '') [Mac/Linux] = $ExePath Where $ExePath is the folder the application is running from
LSP_APP_ROOT  The app's root folder (Where config and data should be stored) GOptionsFile uses LSP_APP_ROOT as the default location. [Win32] = ~ Data$AppName [Mac] = ~/Library/$AppName [Linux] = ~/.$AppName Where $AppName = GApp::GetName. If the given folder doesn't exist it will be created.
LSP_USER_DOCUMENTS  This is the user's documents folder [Win32] ~ Documents [Mac] ~
LSP_USER_MUSIC  This is the user's music folder [Win32] ~ Music [Mac] ~
LSP_USER_VIDEO  This is the user's video folder [Win32] ~ Videos [Mac] ~


Generated on Wed Dec 1 15:41:01 2010 for Lgi by  doxygen 1.5.7.1