Changeset 23

Show
Ignore:
Timestamp:
12/06/06 01:44:22 (2 years ago)
Author:
lindquist
Message:

Updated documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/minwin/docs/minwin.css

    r16 r23  
    1212    padding: 0; 
    1313    margin: 0; 
    14     text-align: left; 
    15     vertical-align: top; 
    1614} 
    1715 
    …… 
    2624} 
    2725 
    28 .title 
     26h1.title 
    2927{ 
    3028    padding: 0.25em; 
     29    margin-bottom: 0.2em; 
     30} 
     31h2.title 
     32{ 
     33    padding: 0.2em; 
     34    text-align: center; 
    3135} 
    3236 
    …… 
    5660} 
    5761 
    58 dl.class 
     62dl.members 
    5963{ 
    6064    background-color: WhiteSmoke; 
    …… 
    6973    border-width: 2px; 
    7074    border-color: black; 
     75    padding: 0.1em; 
    7176} 
    7277 

  • trunk/minwin/docs/minwin.ddoc

    r16 r23  
    1010MOTIF = $(GREEN Motif) 
    1111GTK = $(BLUE GTK) 
     12PLATFORMS = $(WIN) $1 $(BR) 
     13            $(MOTIF) $2 $(BR) 
     14            $(GTK) $3 
    1215 
    13 PAGE_TITLE = <h1 class="title">$(TITLE)</h1> 
     16MAIN_TITLE = <h1 class="title">$0</h1> 
     17PAGE_TITLE = <h2 class="title">$(TITLE)</h2> 
    1418 
    1519DDOC = <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
    …… 
    2226</head> 
    2327<body> 
    24 $(PAGE_TITLE) 
     28$(MAIN_TITLE MinWin API Reference) 
    2529<table> 
    2630<tr> 
    2731<td id="toc"> 
    28 <br /><br /> 
    2932$(INDEX) 
    3033</td> 
    3134<td id="content"> 
     35$(PAGE_TITLE) 
    3236$(BODY) 
    3337</td> 
    …… 
    6064        $(INDEX_LINK window) $(BR) 
    6165 
    62 CLASS_DL = <dl class="class">$0</dl> 
     66MEMBERS_DL = <dl class="members">$0</dl> 
    6367 
    64 DDOC_CLASS_MEMBERS = $(CLASS_DL $0) 
     68DDOC_CLASS_MEMBERS = $(MEMBERS_DL $0) 
     69DDOC_STRUCT_MEMBERS = $(MEMBERS_DL $0) 
     70DDOC_ENUM_MEMBERS = $(MEMBERS_DL $0) 
     71DDOC_TEMPLATE_MEMBERS = $(MEMBERS_DL $0) 
    6572 
    6673BORDERLAYOUT_TABLE = <table> 

  • trunk/minwin/docs/minwin/app.d

    r14 r23  
     1/** 
     2An Application encapsulates the global state provided by 
     3the OS when starting the application and it manages the event queue. 
     4*/ 
     5 
    16module minwin.app; 
    27 

  • trunk/minwin/docs/minwin/button.d

    r22 r23  
     1/** 
     2Various button classes like PushButtons. 
     3*/ 
     4 
    15module minwin.button; 
    26 

  • trunk/minwin/docs/minwin/component.d

    r22 r23  
     1/** 
     2A Component is the root of the widget inheritance tree. 
     3*/ 
     4 
    15module minwin.component; 
    26 

  • trunk/minwin/docs/minwin/dialog.d

    r16 r23  
     1/** 
     2A general dialog class and utility helper dialogs. 
     3*/ 
     4 
    15module minwin.dialog; 
    26 

  • trunk/minwin/docs/minwin/event.d

    r16 r23  
     1/** 
     2Various event classes for key, mouse, focus events, etc. 
     3*/ 
     4 
    15module minwin.event; 
    26 
    37import minwin.geometry; 
     8 
     9typedef void* EventNative_; 
     10typedef void* KeyEventNative_; 
     11typedef void* MouseEventNative_; 
     12typedef void* WindowEventNative_; 
     13 
     14typedef uint KeyPressedEvent_; 
     15typedef uint KeyDownEvent_; 
     16typedef uint KeyUpEvent_; 
     17typedef uint MouseMovedEvent_; 
     18typedef uint MouseDownEvent_; 
     19typedef uint MouseUpEvent_; 
     20typedef uint MouseAlt1DownEvent_; 
     21typedef uint MouseAlt1UpEvent_; 
     22typedef uint MouseAlt2DownEvent_; 
     23typedef uint MouseAlt2UpEvent_; 
     24 
     25typedef uint WindowSizeEvent_; 
     26typedef uint WindowSizingEvent_; 
     27typedef uint WindowMoveEvent_; 
     28typedef uint WindowMovingEvent_; 
    429 
    530/// Enumeration of modifier keys. Can be or'd together. 
    …… 
    1843} 
    1944 
    20 /// Platform-specific generic event type (eg, MSG, XEvent, GdkEvent). 
    21 alias void* EventNative; 
     45/// Platform-specific generic event type. 
     46/// $(PLATFORMS MSG, XEvent, GdkEvent) 
     47alias EventNative_ EventNative; 
    2248 
    2349/// Struct wrapping the native generic event type. 
    …… 
    3258} 
    3359 
    34 /// Platform-specific generic key event type (eg, MSG, XKeyEvent, GdkKeyEvent). 
    35 alias void* KeyEventNative; 
     60/// Platform-specific generic key event type. 
     61/// $(PLATFORMS MSG, XKeyEvent, GdkKeyEvent) 
     62alias KeyEventNative_ KeyEventNative; 
    3663 
    3764/// Struct wrapping the native key event type. 
    …… 
    4875} 
    4976/// Platform-specific id for key character press events. 
    50 alias uint KeyPressedEvent; 
     77alias KeyPressedEvent_ KeyPressedEvent; 
    5178/// Platform-specific id for key down events. 
    52 alias uint KeyDownEvent; 
     79alias KeyDownEvent_ KeyDownEvent; 
    5380/// Platform-specific id for key up events. 
    54 alias uint KeyUpEvent; 
     81alias KeyUpEvent_ KeyUpEvent; 
    5582 
    56 /// Platform-specific generic mouse event type (eg, MSG, XMouseEvent, GdkMouseEvent). 
     83/// Platform-specific generic mouse event type. 
     84/// $(PLATFORMS MSG, XMouseEvent, GdkMouseEvent) 
    5785alias void* MouseEventNative; 
    5886 
    …… 
    7098} 
    7199/// Platform-specific id for mouse moved events. 
    72 alias uint MouseMovedEvent; 
     100alias MouseMovedEvent_ MouseMovedEvent; 
    73101/// Platform-specific id for 1st mouse button down events. 
    74 alias uint MouseDownEvent; 
     102alias MouseDownEvent_ MouseDownEvent; 
    75103/// Platform-specific id for 1st mouse button up events. 
    76 alias uint MouseUpEvent; 
     104alias MouseUpEvent_ MouseUpEvent; 
    77105/// Platform-specific id for 2nd mouse button down events. 
    78 alias uint MouseAlt1DownEvent; 
     106alias MouseAlt1DownEvent_ MouseAlt1DownEvent; 
    79107/// Platform-specific id for 2nd mouse button up events. 
    80 alias uint MouseAlt1UpEvent; 
     108alias MouseAlt1UpEvent_ MouseAlt1UpEvent; 
    81109/// Platform-specific id for 3rd mouse button down events. 
    82 alias uint MouseAlt2DownEvent; 
     110alias MouseAlt2DownEvent_ MouseAlt2DownEvent; 
    83111/// Platform-specific id for 3rd mouse button up events. 
    84 alias uint MouseAlt2UpEvent; 
     112alias MouseAlt2UpEvent_ MouseAlt2UpEvent; 
    85113 
    86 /// Platform-specific generic window event type (eg, MSG, XConfigureEvent, GdkEventConfigure). 
    87 alias void* WindowEventNative; 
     114/// Platform-specific generic window event type. 
     115/// $(PLATFORMS MSG, XConfigureEvent, GdkEventConfigure) 
     116alias WindowEventNative_ WindowEventNative; 
    88117 
    89118/// Struct wrapping the native window event type. 
    …… 
    100129} 
    101130/// Platform-specific id for window size events. 
    102 alias uint WindowSizeEvent; 
     131alias WindowSizeEvent_ WindowSizeEvent; 
    103132/// Platform-specific id for window sizing events. 
    104 alias uint WindowSizingEvent; 
     133alias WindowSizingEvent_ WindowSizingEvent; 
    105134/// Platform-specific id for window move events. 
    106 alias uint WindowMoveEvent; 
     135alias WindowMoveEvent_ WindowMoveEvent; 
    107136/// Platform-specific id for window moving events. 
    108 alias uint WindowMovingEvent; 
     137alias WindowMovingEvent_ WindowMovingEvent; 
    109138 
    110139/** 

  • trunk/minwin/docs/minwin/geometry.d

    r14 r23  
     1/** 
     2Defines Point, Rect, Region and Color and associated functions. 
     3These are structs with a single field called "native" that stores 
     4the native type or, in the case of color on Unix system, an 
     5int with the RGB triple. A Region is a class wrapping a system 
     6region resource. 
     7*/ 
     8 
    19module minwin.geometry; 
    210 
    311import minwin.peer; 
    412 
    5 /// Platform-specific rectangle type (RECT, XRect, GdkRect). 
    6 alias void* RectNative; 
    7 /// Platform-specific point type (POINT, XPoint, GdkPoint). 
    8 alias void* PointNative; 
    9 /// Platform-specific color type for RGB tuples (COLORREF, uint). 
     13typedef void* RectNative_; 
     14typedef void* PointNative_; 
     15typedef void* ColorNative_; 
     16typedef void* RegionPeer_; 
     17 
     18/// Platform-specific rectangle type 
     19/// $(PLATFORMS RECT, XRect, GdkRectangle) 
     20alias RectNative_ RectNative; 
     21 
     22/// Platform-specific point type 
     23/// $(PLATFORMS POINT, XPoint, GdkPoint) 
     24alias PointNative_ PointNative; 
     25 
     26/// Platform-specific color type for RGB tuples. 
    1027/// On X-based systems a uint is used to pack the red, green and blue components. 
    11 alias void* ColorNative; 
     28/// $(PLATFORMS COLORREF, uint, uint) 
     29alias ColorNative_ ColorNative; 
     30 
    1231/// Alias for native region type. 
    13 alias void* RegionPeer; 
     32/// $(PLATFORMS HRGN, XRegion, GdkRegion*) 
     33alias RegionPeer_ RegionPeer; 
    1434 
    1535/// Struct wrapping the native integer rectangle type. 

  • trunk/minwin/docs/minwin/group.d

    r22 r23  
     1/** 
     2A Group is a lightweight component (meaning it has 
     3no peer) that contains and lays out other components. 
     4 
     5A GroupBox is a potentially heavyweight component that 
     6puts a box and label around other components. 
     7*/ 
     8 
    19module minwin.group; 
    210 
    …… 
    1523 
    1624/// A group of components layed out in a rectanguluar area with a border and title around the edge. 
    17 /// A GroupBox is a potentially heavyweight component that puts a box and label around other components. 
    1825class GroupBox : WindowChild 
    1926{ 

  • trunk/minwin/docs/minwin/icon.d

    r14 r23  
     1/** 
     2Icon class 
     3*/ 
     4 
    15module minwin.icon; 
    26 
    37import minwin.native; 
    48 
     9typedef void* IconPeer_; 
     10 
    511/// $(WIN) Alias for the native type for icons. 
    6 alias HICON IconPeer; 
     12/// $(WIN) HICON 
     13alias IconPeer_ IconPeer; 
    714 
    815/// Encapsulates an icon resource. 

  • trunk/minwin/docs/minwin/image.d

    r14 r23  
     1/** 
     2Image class encapsulating image operations. 
     3*/ 
     4 
    15module minwin.image; 
    26 
     7import minwin.paint; 
     8 
     9typedef void* ImagePeer_; 
     10 
     11/** 
     12Platform-specific rectangle type. 
     13 
     14$(PLATFORMS HBITMAP, Pixmap, GdkPixmap*) 
     15*/ 
     16alias ImagePeer_ ImagePeer; 
     17 
     18/// Represents image 
    319class Image 
    420{ 
     21    /// 
     22    this(ImagePeer bm); 
     23    /// 
     24    GContext getGContext(); 
     25    /// Read-only width in pixels. 
     26    int width; 
     27    /// Read-only height in pixels. 
     28    int height; 
     29    /// 
     30    ImagePeer peer; 
    531} 

  • trunk/minwin/docs/minwin/index.d

    r16 r23  
    1 module minwin.index; 
     1Ddoc 
     2 
     3This is the MinWin API reference. 
     4 
     5Macros: 
     6TITLE = Overview 

  • trunk/minwin/docs/minwin/layout.d

    r16 r23  
     1/** 
     2Defines a LayoutManager interface and some layout managers. 
     3*/ 
     4 
    15module minwin.layout; 
    26 
    …… 
    9094{ 
    9195    /// Read/write property of the locations of children to position. 
    92     Component[Loc.max+1] location; 
     96    Component[Loc] location; 
    9397    /// Position children according to their locations. If a child is not in the location array it is not positioned. 
    9498    void layout(Component c); 

  • trunk/minwin/docs/minwin/menu.d

    r14 r23  
     1/** 
     2Defines menu classes 
     3*/ 
     4 
    15module minwin.menu; 
    26 
    37import minwin.window; 
    48 
    5 /// Platform-specific menu type (HMENU, Widget, GtkWidget*). 
    6 alias void* MenuPeer; 
    7 /// Platform-specific menu bar type (HMENU, Widget, GtkWidget*). 
    8 alias void* MenuBarPeer; 
     9typedef void* MenuPeer_; 
     10typedef void* MenuBarPeer_; 
     11 
     12/// Platform-specific menu type 
     13/// $(PLATFORMS HMENU, Widget, GtkWidget*) 
     14alias MenuPeer_ MenuPeer; 
     15 
     16/// Platform-specific menu bar type 
     17/// $(PLATFORMS HMENU, Widget, GtkWidget*) 
     18alias MenuBarPeer_ MenuBarPeer; 
    919 
    1020/// Menu bar class 

  • trunk/minwin/docs/minwin/multidg.d

    r16 r23  
     1/** 
     2A multi-delegate is similar to a C# multicast delegate. 
     3It has array copy semantics so assignment will copy the 
     4length and data pointer but modification could allocate 
     5a distinct copy. Delegates in a multi-delegate are fired 
     6in the order they were added. 
     7 
     8A MultiBoolDelegate is a multi-delegates where each 
     9delegate returns a bool and the result of executing 
     10the MultiBoolDelegate is the or'ed value of all the bools. 
     11 
     12To append to a multi-delegate use ~= 
     13 
     14To remove a delegate from a multi-delegate use remove() 
     15 
     16To fire all the delegates in order use opCall: multidg() 
     17 
     18To test if the multi-delegate is empty use isEmpty() 
     19*/ 
    120module minwin.multidg; 
    221 
    3 /** 
    4 Store multiple delegates with any number of arguments. 
    5 */ 
     22/// Store multiple delegates with any number of arguments. 
    623struct MultiDelegate(T...) 
    724{ 
    …… 
    2542} 
    2643 
    27 /** 
    28 Multi-delegate where the delegates return a bool result. 
    29 */ 
     44/// Multi-delegate where the delegates return a bool result. 
    3045struct MultiBoolDelegate(T...) 
    3146{ 

  • trunk/minwin/docs/minwin/paint.d

    r14 r23  
     1/** 
     2Defines graphics related stuff. 
     3*/ 
     4 
    15module minwin.paint; 
    26 
     7/// 
     8GContext newGContext(); 
     9 
     10/// Enumeration of supported pen drawing styles. 
     11enum PenStyle 
     12{ 
     13    /// Solid line. 
     14    Solid, 
     15    /// Dashes. 
     16    Dash, 
     17    /// Dots. 
     18    Dot, 
     19    /// Alternating dashes and dots. 
     20    DashDot 
     21} 
     22 
     23/// Enumeration of supported line joining styles. 
     24enum LineJoin 
     25{ 
     26    /// 
     27    Round, 
     28    /// 
     29    Bevel, 
     30    /// 
     31    Miter 
     32} 
     33 
     34/// Enumeration of supported raster painting modes. 
     35enum PaintMode { 
     36    /// 
     37    Copy, 
     38    /// 
     39    Invert, 
     40    /// 
     41    And, 
     42    /// 
     43    Or, 
     44    /// 
     45    Xor 
     46} 
     47 
     48typedef void* GContextPeer_; 
     49/// Platform-specific graphics context type. 
     50/// $(PLATFORMS HDC, GC, GdkGC*) 
     51alias GContextPeer_ GContextPeer; 
     52 
    353/// A GContext is a simple 2D drawing API similar to a Windows DC and an X11 Graphics Context. 
     54/// TODO 
    455class GContext 
    556{ 
    …… 
    758 
    859/// A GXContext is a more advanced painting API that is similar to GDI+ or Quartz. 
     60/// TODO 
    961class GXContext 
    1062{ 

  • trunk/minwin/docs/minwin/peer.d

    r14 r23  
     1/** 
     2Mixin templates to simplify peer management. 
     3*/ 
     4 
    15module minwin.peer; 
    26 
    3 /// Alias for the native type for parenting controls (eg, HWND, Widget, GdkWidget*). 
    4 alias void* PeerForAdd; 
     7typedef void* PeerForAdd_; 
     8typedef PeerForAdd_ WindowChildPeer_; 
    59 
    6 /// Alias for the native type for a control or window child (eg, HWND, Widget, GdkWidget*). 
    7 alias PeerForAdd WindowChildPeer; 
     10/// Alias for the native type for parenting controls 
     11/// $(PLATFORMS HWND, Widget, GdkWidget*) 
     12alias PeerForAdd_ PeerForAdd; 
     13 
     14/// Alias for the native type for a control or window child 
     15/// $(PLATFORMS HWND, Widget, GdkWidget*) 
     16alias WindowChildPeer_ WindowChildPeer; 
    817 
    918/// Enumeration of possible peer ownership states for hasPeer. 

  • trunk/minwin/docs/minwin/peerimpl.d

    r16 r23  
     1/** 
     2Mixin template to implement heavyweight peer for window children. 
     3Plus PeerWrapper to insert peer children into the MinWin tree. 
     4*/ 
     5 
    16module minwin.peerimpl; 
    27 

  • trunk/minwin/docs/minwin/window.d

    r14 r23  
     1/** 
     2An AbstractWindow is a top-level window. Concrete subclasses 
     3are Window and Dialog. 
     4*/ 
     5 
    16module minwin.window; 
    27 
    …… 
    914import minwin.image; 
    1015 
     16typedef void* WindowPeer_; 
     17 
    1118/// Alias for the native type for a top-level window or dialog (eg, HWND, Widget, GdkWidget). 
    12 alias void* WindowPeer; 
     19alias WindowPeer_ WindowPeer; 
    1320 
    1421/// Get the AbstractWindow associated with the given peer. Return null if none.